Google Photos¶
The Google Photos modules enable you to create, list, retrieve, share and unshare albums and monitor, retrieve, download or upload media in your Google Photos.
Getting Started with Google Photos¶
Prerequisites
- A Google account
In order to use Google Photos with Ibexa Connect, it is necessary to have a Google account. If you do not have one, you can create a Google account at photos.google.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Google Photos to Ibexa Connect¶
To connect your Google Photos account to Ibexa Connect follow the general instructions for Connecting to services.
After you click the Continue button, Ibexa Connect will redirect you to the Google Photos website where you will be prompted to grant Ibexa Connect access to your account.
Confirm the dialog by clicking the Allow button.
Album¶
List Albums¶
Retrieves album from your Google Photos.
| Retrieve only albums created using API | If this option is enabled, only albums that were created by (any) API will be returned. |
| Limit | Set the maximum number of albums Ibexa Connect will return during one execution cycle. |
Get an Album¶
Retrieves album details.
| Album ID | Enter (map) or select the album you want to retrieve details about. |
Create an Album¶
Creates a new empty album.
| Title | Enter the name for the new album. |
Share an Album¶
Marks an album as shared and accessible to other users.
Note
This action can only be performed on albums that were created via the API (using Ibexa Connect).
| Album ID | Select or map the album you want to share. Only albums created using API are available. |
| Collaborative | Enable this option to allow users who have joined the album to add media items to it. |
| Commentable | Enable this option to allow the owner and the users who have joined the album to add comments to the album. |
Unshare an Album¶
Marks a via API shared album as private.
| Album ID | Select or map the album you want to unshare. Only albums created and shared using API are available. |
Media¶
Watch Media Items¶
Retrieves media details when new media are added to an album.
| Album | Select the album you want to watch for new media. If no album is selected, all albums will be monitored. |
| Limit | Set the maximum number of media Ibexa Connect will return during one execution cycle. |
List Media Items¶
Retrieves media from the specified album.
| Album ID | Select or map the album you want to retrieve media from. If no album is selected, all media in your account will be retrieved. |
| Limit | Set the maximum number of media Ibexa Connect will return during one execution cycle. |
Get a Media Item¶
Retrieves details of a specified media.
| Media Item ID | Select or map the ID of the media you want to retrieve details about. |
Download a Media File¶
Downloads a file from the Base URL provided by the Watch Media Items modules.
| Base URL | Map the Base URL from the previous module. |
Upload a Media Item¶
Uploads a file to an album.
Note
Files can be uploaded only to the albums that were created using Ibexa Connect (or via another API).
The maximum file sizes and other useful information can be found in the Google Photos Documentation for Uploading Media.
| Source File | Map the file you want to upload from the previous module (e.g. HTTP > Get a File or Dropbox > Get a file). |
| Description | Enter the description for the media. |
| Album | Select the album you want to upload the media to. The album must be created by Ibexa Connect (or via another API). |
Make an API Call¶
Allows you to perform a custom API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Photos Library API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Albums¶
The following API call returns the all albums in your Google Photos:
URL:
/v1/albums
Method:
GET
The results can be found in the module's Output under Bundle > Body > albums.
In our example, 10 tickets were returned:
