bahaaalhagar/youtube-uploader

:simple Youtube uploader

0.5.3 2018-08-26 17:06 UTC

Requires

• php: ~5.6|~7.0
• google/apiclient: ^2.2
• illuminate/support: ~5.4
• nesbot/carbon: ^1.22

Requires (Dev)

• phpunit/phpunit: >=5.4.3
• squizlabs/php_codesniffer: ^2.3

MIT

• BahaaAlhagar

• php
• youtube
• laravel
• google api
• BahaaAlhagar
• Youtube Uploader

README

Please note, that this package will only work with a single YouTube account and does not support multiple accounts.

Installation

To install, use the following to pull the package in via Composer.

composer require bahaaalhagar/youtube-uploader

Now register the Service provider in config/app.php

'providers' => [
    ...
    BahaaAlhagar\YoutubeUploader\YoutubeUploaderServiceProvider::class,
],

And also add the alias to the same file.

'aliases' => [
    ...
    'YoutubeUploader' => BahaaAlhagar\YoutubeUploader\Facades\YoutubeUploader::class,
],

Configuration

You now need to publish the youtubeUploader.php config and migrations.

php artisan vendor:publish --provider="BahaaAlhagar\YoutubeUploader\YoutubeUploaderServiceProvider"

Now you'll want to run php artisan migrate to create the youtube_access_tokens table which as you would imagine, will contain your access tokens once you're authenticated correctly.

Obtaining your Credentials

If you haven't already, you'll need to create an application on Google's Developer Console. You then need to head into Credentials within the Console to create Server key.

You will be asked to enter your Authorised redirect URIs. When installing this package, the default redirect URI is http://laravel.dev/youtube/callback. Of course, replacing the domain (laravel.dev) with your applications domain name.

You can add multiple redirect URIs, for example you may want to add the URIs for your local, staging and production servers.

Once you are happy with everything, create the credentials and you will be provided with a Client ID and Client Secret. These now need to be added to your .env file.

GOOGLE_CLIENT_ID=YOUR_CLIENT_ID
GOOGLE_CLIENT_SECRET=YOUR_SECRET

Authentication

For security reasons, the routes to authorize your channel with your Laravel application for disabled by default. You will need to enable them in your config/youtube.php before doing the following.

Now your application is configured, we'll go through the inital authentication with Google. By default, the authorization route is /youtube/auth. Simply visit this URI in your application and you will be redirect to Google to authenticate your YouTube account.

Assuming you were not presented with any errors during authentication, you will be redirected back to your application root. (/).

Reviewing your Token

Previously, users of this package have reported issues with their access token(s). To ensure you have the correct token, you simply need to review the youtube_access_tokens table you migrated earlier and review the value in the access_token column.

You need to check that a refresh_token exists within this value. If this is correct, you're all set to begin uploading.

You will also want to disable the routes used for authorization as they will no longer be required since you are now autheticated. The token you just reviewed, assuming as a refresh_token will automatically be handled.

Upload a Video

To upload a video, you simply need to pass the full path to your video you wish to upload and specify your video information.

Here's an example:

$video = YoutubeUploader::upload($fullPathToVideo, [
    'title'       => 'My Awesome Video',
    'description' => 'You can also specify your video description here.',
    'tags'	      => ['foo', 'bar', 'baz'],
    'category_id' => 10
]);

return $video->getVideoId();

The above will return the ID of the uploaded video to YouTube. (i.e dQw4w9WgXcQ)

By default, video uploads are public. If you would like to change the privacy of the upload, you can do so by passing a third parameter to the upload method.

For example, the below will upload the video as unlisted.

$video = YoutubeUploader::upload($fullPathToVideo, $params, 'unlisted');

Custom Thumbnail

If you would like to set a custom thumbnail for for upload, you can use the withThumbnail() method via chaining.

$fullpathToImage = storage_path('app/public/thumbnail.jpg');

$video = YoutubeUploader::upload($fullPathToVideo, $params)->withThumbnail($fullpathToImage);

return $youtube->getThumbnailUrl();

Please note, the maxiumum filesize for the thumbnail is 2MB. Setting a thumbnail will not work if you attempt to use a thumbnail that exceeds this size.

Updating a Video

To update a video, you simply need to pass the videoId of the video you wish to update and specify your video information.

Here's an example:

$video = YoutubeUploader::update($videoId, [
    'title'       => 'My Awesome Video',
    'description' => 'You can also specify your video description here.',
    'tags'	      => ['foo', 'bar', 'baz'],
    'category_id' => 10
], $privacy);

return $video->getVideoId();

Note: This request is explicit. Any params left out of the request will be removed.

Deleting a Video

If you would like to delete a video, which of course is uploaded to your authorized channel, you will also have the ability to delete it:

YoutubeUploader::delete($videoId);

When deleting a video, it will check if exists before attempting to delete.

Create a Playlist

To create a playlist you must provide Playlist title and description.

Here's an example:

$playlist = YoutubeUploader::createPlaylist($title, $description);

return $playlist->getPlaylistId();

The above will return the ID of the created playlist on YouTube. (i.e PLFgquLnL59akxkuW7czf5TvyjzcUMgaci)

By default, playlists are public. If you would like to change the privacy of the playlist, you can do so by passing a third parameter to the createPlaylist method.

For example, the below will create the playlist as unlisted.

$playlist = YoutubeUploader::createPlaylist($title, $description, 'unlisted');

Add video to a Playlist

If you want to add a video to a playlist you have to provide the uploaded video id and the playlist id.

Here's an example:

YoutubeUploader::addVideoToPlaylist([
	'id' => 'jq498asd' // a youtube video id
], $playlistId);

this will return playlist Item Response.

You may also provide another title for video in playlist:

YoutubeUploader::addVideoToPlaylist([
	'id' => 'jq498asd', // a youtube video id
	'title' => 'a new title for video in playlist'
], $playlistId);

You may also create the playlist and add video to it.

$playlist = YoutubeUploader::createPlaylist($title, $description)->addVideoToPlaylist([
	'id' => 'jq498asd', // a youtube video id
]);

Questions

Should you have any questions, please feel free to submit an issue.