Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kawax/laravel-google-photos
https://github.com/kawax/laravel-google-photos
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kawax/laravel-google-photos
- Owner: kawax
- License: mit
- Created: 2018-05-12T14:54:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-21T10:19:37.000Z (about 1 month ago)
- Last Synced: 2024-12-17T09:07:15.587Z (11 days ago)
- Language: PHP
- Homepage: https://kawax.biz/laravel-google-photos/
- Size: 131 KB
- Stars: 33
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Photos API for Laravel
[](https://codeclimate.com/github/kawax/laravel-google-photos/maintainability)
[](https://codeclimate.com/github/kawax/laravel-google-photos/test_coverage)
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
```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
```php
'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.
```php
// 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
```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
```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
```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](./docs/picker.md)
## LICENSE
MIT