cable8mm / youtube
更新Laravel PHP Facade/Wrapper以适配Youtube数据API v3
v4.2.0
2024-03-09 14:45 UTC
Requires
- php: ^8.0
- ext-curl: *
- illuminate/support: ^8.0|^9.0|^10.0
- nesbot/carbon: ^2.0
Requires (Dev)
- laravel/pint: ^1.0
- orchestra/testbench: ^6.23|^7.0|^8.0
- phpunit/phpunit: ^9.0|^10.0|^11.0
- vlucas/phpdotenv: ^5.0
README
更新Laravel PHP Facade/Wrapper以适配Youtube数据API v3 (非OAuth)
我们已经在网站上提供了API文档。如需更多信息,请访问 https://www.palgle.com/Youtube/ ❤️
要求
- PHP 8.0或更高版本
- Laravel 8或更高版本
- 从Google Console获取API密钥
安装
在控制台中运行以下命令将包下载到您的项目中
composer require cable8mm/youtube
配置
发布配置设置
$ php artisan vendor:publish --provider="Cable8mm\Youtube\YoutubeServiceProvider"
在文件中设置您的YouTube API密钥
/config/youtube.php
或在.env文件中
YOUTUBE_API_KEY = <YOUR KEY>
包开发
如果您打算贡献代码,
composer update
并且您可以使用包中的.env
文件。
使用方法
// use Cable8mm\Youtube\Facades\Youtube; // Return an STD PHP object $video = Youtube::getVideoInfo('rie-hPVJ7Sw'); // Get multiple videos info from an array $videoList = Youtube::getVideoInfo(['rie-hPVJ7Sw','iKHTawgyKWQ']); // Get localized video info $video = Youtube::getLocalizedVideoInfo('vjF9GgrY9c0', 'pl'); // Get comment threads by videoId $commentThreads = Youtube::getCommentThreadsByVideoId('zwiUB_Lh3iA'); // Get popular videos in a country, return an array of PHP objects $videoList = Youtube::getPopularVideos('us'); // Search playlists, channels and videos. return an array of PHP objects $results = Youtube::search('Android'); // Only search videos, return an array of PHP objects $videoList = Youtube::searchVideos('Android'); // Search only videos in a given channel, return an array of PHP objects $videoList = Youtube::searchChannelVideos('keyword', 'UCk1SpWNzOs4MYmr0uICEntg', 40); // List videos in a given channel, return an array of PHP objects $videoList = Youtube::listChannelVideos('UCk1SpWNzOs4MYmr0uICEntg', 40); $results = Youtube::searchAdvanced([ /* params */ ]); // Get channel data by channel name, return an STD PHP object $channel = Youtube::getChannelByName('xdadevelopers'); // Get channel data by channel ID, return an STD PHP object $channel = Youtube::getChannelById('UCk1SpWNzOs4MYmr0uICEntg'); // Get playlist by ID, return an STD PHP object $playlist = Youtube::getPlaylistById('PL590L5WQmH8fJ54F369BLDSqIwcs-TCfs'); // Get playlists by multiple ID's, return an array of STD PHP objects $playlists = Youtube::getPlaylistById(['PL590L5WQmH8fJ54F369BLDSqIwcs-TCfs', 'PL590L5WQmH8cUsRyHkk1cPGxW0j5kmhm0']); // Get playlist by channel ID, return an array of PHP objects $playlists = Youtube::getPlaylistsByChannelId('UCk1SpWNzOs4MYmr0uICEntg'); // Get items in a playlist by playlist ID, return an array of PHP objects $playlistItems = Youtube::getPlaylistItemsByPlaylistId('PL590L5WQmH8fJ54F369BLDSqIwcs-TCfs'); // Get channel activities by channel ID, return an array of PHP objects $activities = Youtube::getActivitiesByChannelId('UCk1SpWNzOs4MYmr0uICEntg'); // Retrieve video ID from original YouTube URL $videoId = Youtube::parseVidFromURL('https://www.youtube.com/watch?v=moSFlvxnbgk'); // result: moSFlvxnbgk
验证规则
// use Cable8mm\Youtube\Rules\ValidYoutubeVideo; // Validate a YouTube Video URL [ 'youtube_video_url' => ['bail', 'required', new ValidYoutubeVideo] ];
您可以将bail规则与该规则结合使用,以防止不必要的查询。
基本搜索分页
// Set default parameters $params = [ 'q' => 'Android', 'type' => 'video', 'part' => 'id, snippet', 'maxResults' => 50 ]; // Make intial call. with second argument to reveal page info such as page tokens $search = Youtube::searchAdvanced($params, true); // Check if we have a pageToken if (isset($search['info']['nextPageToken'])) { $params['pageToken'] = $search['info']['nextPageToken']; } // Make another call and repeat $search = Youtube::searchAdvanced($params, true); // Add results key with info parameter set print_r($search['results']); /* Alternative approach with new built-in paginateResults function */ // Same params as before $params = [ 'q' => 'Android', 'type' => 'video', 'part' => 'id, snippet', 'maxResults' => 50 ]; // An array to store page tokens so we can go back and forth $pageTokens = []; // Make inital search $search = Youtube::paginateResults($params, null); // Store token $pageTokens[] = $search['info']['nextPageToken']; // Go to next page in result $search = Youtube::paginateResults($params, $pageTokens[0]); // Store token $pageTokens[] = $search['info']['nextPageToken']; // Go to next page in result $search = Youtube::paginateResults($params, $pageTokens[1]); // Store token $pageTokens[] = $search['info']['nextPageToken']; // Go back a page $search = Youtube::paginateResults($params, $pageTokens[0]); // Add results key with info parameter set print_r($search['results']);
上面的分页相当基础。根据您要实现的目标,您可能需要创建一个递归函数来遍历结果。
手动类实例化
// Directly call the YouTube constructor $youtube = new Youtube(config('YOUTUBE_API_KEY')); // By default, if the $_SERVER['HTTP_HOST'] header is set, // it will be used as the `Referer` header. To override // this setting, set 'use-http-host' to false during // object construction: $youtube = new Youtube(config('YOUTUBE_API_KEY'), ['use-http-host' => false]); // This setting can also be set after the object was created $youtube->useHttpHost(false);
测试
composer test
返回数据的格式
返回的JSON被解码为PHP对象(而不是数组)。请阅读官方API文档中的"参考"部分。
Youtube数据API v3
鸣谢
基于Alaouy的代码构建:alaouy/youtube。