Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanaikech/gphotoapp
This is a GAS library for retrieving and creating the albums and media items using Google Photo API using Google Apps Script (GAS).
https://github.com/tanaikech/gphotoapp
developer-tools gas-library google-apps-script google-photos google-photos-api library
Last synced: 3 days ago
JSON representation
This is a GAS library for retrieving and creating the albums and media items using Google Photo API using Google Apps Script (GAS).
- Host: GitHub
- URL: https://github.com/tanaikech/gphotoapp
- Owner: tanaikech
- License: mit
- Created: 2020-02-26T00:23:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-06T05:12:35.000Z (over 2 years ago)
- Last Synced: 2023-08-25T10:58:07.300Z (about 1 year ago)
- Topics: developer-tools, gas-library, google-apps-script, google-photos, google-photos-api, library
- Language: JavaScript
- Size: 17.6 KB
- Stars: 38
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GPhotoApp
[](LICENSE)
# Overview
A Google Apps Script (GAS) library exposing the Google Photos Library API.
Based on https://github.com/tanaikech/GPhotoApp
## Description
Currently, the Photos Library API is not available under [Advanced Google services](https://developers.google.com/apps-script/guides/services/advanced). This library enables access via the `UrlFetchApp` service.
## Usage
1. Copy + paste the contents of `PhotoApp.js` to a new file in your Apps Script project.
1. Link the Cloud Platform project to your Google Apps Script project: Apps Script Sidebar > Project Settings > Google Cloud Platform (GCP) Project. See also [here](https://gist.github.com/tanaikech/e945c10917fac34a9d5d58cad768832c).
1. [Enable the Photos Library API at the GCP Console](https://console.developers.google.com/apis/library/photoslibrary.googleapis.com)
1. Edit `appsscript.json` in your project to include the scopes required for Google Photos access (see included sample file):
```json
"oauthScopes": [
"https://www.googleapis.com/auth/photoslibrary",
"https://www.googleapis.com/auth/script.external_request"
]
```
## Public library
I got a contact that the library key had been removed. The script ID of the library is as follows.
```
1lGrUiaweQjQwVV_QwWuJDJVbCuY2T0BfVphw6VmT85s9LJFntav1wzs9
```
- How to install the Google Apps Script can be seen at [here](https://developers.google.com/apps-script/guides/libraries#add_a_library_to_your_script_project).
### Notes
- This library uses modern Javascript. V8 runtime must be [enabled](https://developers.google.com/apps-script/guides/v8-runtime).
- Media items can be created only within the albums created by your app (see [here](https://developers.google.com/photos/library/guides/upload-media#creating-media-item)). Attempting to upload to an album not created by your app will result in the error: `No permission to add media items to this album`.
- Paginated results are returned as iterators. Use [`for...of`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of) to iterate over them. If you need all of them, you can use [`Array.from()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from).
# Documentation
| Methods | Description |
| :------------------------------------------------------ | :-------------------------- |
| [createAlbum(object)](#createalbum) | Create new album. |
| [getAlbumList(excludeNonAppCreatedData)](#getalbumList) | Get album list. |
| [getMediaItemList()](#getmediaitemList) | Get media item list. |
| [getMediaItems(object)](#getmediaitems) | Get media items. |
| [getMediaItem(object)](#getmediaitem) | Gets a media item. |
| [getMediaItemBlob(object)](#getmediaitemblob) | Gets data for a media item. |
| [uploadMediaItems(object)](#uploadmediaitems) | Upload images to album. |
## Sample scripts
### `createAlbum` ([albums.create](https://developers.google.com/photos/library/reference/rest/v1/albums/create))
```javascript
function createAlbum() {
const resource = { album: { title: "sample title" } };
const res = PhotoApp.createAlbum(resource);
console.log(res);
}
```
### `getAlbumList` ([albums.list](https://developers.google.com/photos/library/reference/rest/v1/albums/list))
```javascript
function getAlbumList() {
const res = Array.from(
PhotoApp.getAlbumList({ excludeNonAppCreatedData: true })
);
console.log(res);
}
```
### `getMediaItemList` ([mediaItems.list](https://developers.google.com/photos/library/reference/rest/v1/mediaItems/list))
```javascript
function getMediaItemList() {
const res = Array.from(PhotoApp.getMediaItemList());
console.log(res);
}
```
### `searchMediaItems` ([mediaItems.search](https://developers.google.com/photos/library/reference/rest/v1/mediaItems/search))
```javascript
function searchMediaItems() {
const albumId = "###"; // Album ID
const res = Array.from(PhotoApp.searchMediaItems({ albumId }));
console.log(res);
}
```
### `getMediaItems` ([mediaItems.batchGet](https://developers.google.com/photos/library/reference/rest/v1/mediaItems/batchGet))
```javascript
function getMediaItems() {
const resource = { mediaItemIds: ["###", "###"] };
// Note that since the list is limited to requested items, this does not return an iterator.
const res = PhotoApp.getMediaItems(resource);
console.log(res);
}
```
### `getMediaItem` ([mediaItems.get](https://developers.google.com/photos/library/reference/rest/v1/mediaItems/get))
```javascript
function getMediaItem() {
const id = "###";
const res = PhotoApp.getMediaItem({ mediaItemId: id });
console.log(res);
}
```
### `getMediaItemBlob`
```javascript
function getMediaItems() {
const id = "###";
const mediaItem = PhotoApp.getMediaItem({ mediaItemId: id });
const blob = PhotoApp.getMediaItemBlob(mediaItem);
blob.setName(mediaItem.filename);
DriveApp.createFile(blob);
console.log(res);
}
```
### `uploadMediaItems` ([mediaItems.batchCreate](https://developers.google.com/photos/library/reference/rest/v1/mediaItems/batchCreate))
```javascript
function uploadMediaItems() {
const albumId = "###"; // Album ID
const fileId = "###"; // File ID
const url = "###"; // URL of image file
const resource = {
albumId: albumId,
items: [
{
blob: DriveApp.getFileById(fileId).getBlob(),
description: "description1",
filename: "filename1",
},
{
blob: UrlFetchApp.fetch(url).getBlob(),
description: "description2",
filename: "filename2",
},
],
};
const res = PhotoApp.uploadMediaItems(resource);
console.log(JSON.stringify(res));
}
```
# License
[MIT](LICENSE)
# Authors
[Tanaike](https://tanaikech.github.io/about/), [kwikwag](https://github.com/kwikwag/GPhotoApp)
# Update History
- v1.0.0 (February 26, 2020) (tanaikech)
1. Initial release.
- v1.1.0 (January 20, 2022) (kwikwag)
1. Added some methods
2. Refactored code
3. Fixed broken pagination API
4. Minor breaking interface changes