revolution/laravel-google-photos

Google Photos API for Laravel

6.1.7 2024-10-01 07:40 UTC

Requires

• php: ^8.2
• google/photos-library: ^1.7
• illuminate/support: ^11.0
• revolution/laravel-google-sheets: ^7.0

Requires (Dev)

• orchestra/testbench: ^9.0

MIT

• kawax

• google
• laravel
• photos

README

https://developers.google.com/photos/

Requirements

• PHP >= 8.2
• Laravel >= 11.0

Versioning

• Basic : semver
• Drop old PHP or Laravel version : +0.1. composer should handle it well.
• Support only latest major version (master branch), but you can PR to old branches.

Installation

composer require revolution/laravel-google-photos

Get API Credentials

from https://developers.google.com/console

• Enable Photos Library API and Google Photos Picker API. Be careful not to select Google Picker API as it is different from the Photos Picker API.
• Create OAuth2.0 client id.

config/google.php

    'client_id'        => env('GOOGLE_CLIENT_ID', ''),
    'client_secret'    => env('GOOGLE_CLIENT_SECRET', ''),
    'redirect_uri'     => env('GOOGLE_REDIRECT', ''),
    'scopes'           => [
        'https://www.googleapis.com/auth/photoslibrary.appendonly',
        'https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata',
        'https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata',
        'https://www.googleapis.com/auth/photospicker.mediaitems.readonly',
    ],
    'access_type'      => 'offline',
    'approval_prompt'  => 'force',
    'prompt'           => 'consent', //"none", "consent", "select_account" default:none

Currently, you can only access files uploaded via the API.

'access_type' => 'offline' is required to obtain a refresh token.

Google Photos API does not support Service Account.

config/service.php for Socialite

    'google' => [
        'client_id'     => env('GOOGLE_CLIENT_ID', ''),
        'client_secret' => env('GOOGLE_CLIENT_SECRET', ''),
        'redirect'      => env('GOOGLE_REDIRECT', ''),
    ],

.env

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_REDIRECT=

Usage example

Currently, Google Photos Library API only allows access to files uploaded via API, so it is difficult to use it freely.

Using it with someone else's account requires review.

It is still possible to upload one-way, so it is best to only use the upload function to your own account.

1. Enable the Photos Library API in the Google console and add yourself as a test user.
2. Get refresh_token by Socialite. Save it in the users table.
3. Upload the photo.

// Command or etc

use App\Models\User;
use Illuminate\Support\Facades\Storage;
use Revolution\Google\Photos\Facades\Photos;

Photos::withToken(User::find(1)->refresh_token);

with(Photos::upload(Storage::get('test.png'), 'test.png'), function (string $token) {
    Photos::batchCreate([$token]);
});

PhotosLibraryClient

This package depends on google/photos-library and automatically delegates to the methods on PhotosLibraryClient.

• https://github.com/google/php-photoslibrary/blob/main/src/Google/Photos/Library/V1/PhotosLibraryClient.php
• https://github.com/google/php-photoslibrary/blob/main/src/Google/Photos/Library/V1/Gapic/PhotosLibraryGapicClient.php

use Revolution\Google\Photos\Facades\Photos;

$album = Photos::withToken('token')->updateAlbumTitle($albumId, $newTitle);

PagedListResponse

listMediaItems() and listAlbums() return a PagedListResponse, which is basically used with foreach.

• https://github.com/googleapis/gax-php/blob/main/src/PagedListResponse.php

use Revolution\Google\Photos\Facades\Photos;
use Google\ApiCore\PagedListResponse;

$items = Photos::withToken('token')->listMediaItems();

foreach ($items as $item){
    dump($item->getBaseUrl());
}

Create new album

PhotosLibraryResourceFactory has various creation methods.

• https://github.com/google/php-photoslibrary/blob/main/src/Google/Photos/Library/V1/PhotosLibraryResourceFactory.php

use Google\Photos\Library\V1\PhotosLibraryResourceFactory;
use Revolution\Google\Photos\Facades\Photos;

$newAlbum = Photos::withToken('token')->createAlbum(PhotosLibraryResourceFactory::album('title'));

dump($newAlbum->getId());
dump($newAlbum->getTitle());

Picker

Picker API

LICENSE

MIT