Update the album with the specified id. Only the id, title and cover_photo_media_item_id fields of the album are read. The album must have been created by the developer via the API and must be owned by the user.

Scopes

You will need authorization for the https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata. You can set the scope for this method like this: photoslibrary1 --scope <scope> albums patch ...

Required Scalar Argument

• <id> (string)
  • Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Album:
  cover-photo-base-url: string
  cover-photo-media-item-id: string
  id: string
  is-writeable: boolean
  media-items-count: int64
  product-url: string
  share-info:
    is-joinable: boolean
    is-joined: boolean
    is-owned: boolean
    share-token: string
    shareable-url: string
    shared-album-options:
      is-collaborative: boolean
      is-commentable: boolean
  title: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . cover-photo-base-url=eos
  • [Output only] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the developer documentation for a complete list of supported parameters. For example, '=w2048-h1024' sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px.
• cover-photo-media-item-id=labore
  • Identifier for the media item associated with the cover photo.
• id=sed
  • Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.
• is-writeable=false
  • [Output only] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.
• media-items-count=-80
  • [Output only] The number of media items in the album.
• product-url=no
  • [Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.
• share-info is-joinable=true
  • True if the album can be joined by users.
• is-joined=true
  • True if the user is joined to the album. This is always true for the owner of the album.
• is-owned=false
  • True if the user owns the album.
• share-token=erat
  • A token that is used to join, leave, or retrieve the details of a shared album on behalf of a user who isn't the owner. A shareToken is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.
• shareable-url=sed
  • A link to the shared Google Photos album. Anyone with the link can view the contents of the album, so it should be treated with care. The shareableUrl parameter is only returned if the album has link sharing turned on. If a user is already joined to an album that isn't link-shared, they can use the album's productUrl to access it instead. A shareableUrl is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.
• shared-album-options is-collaborative=false
  • True if the shared album allows collaborators (users who have joined the album) to add media items to it. Defaults to false.

• is-commentable=false

  • True if the shared album allows collaborators (users who have joined the album) to add comments to the album. Defaults to false.

• ... title=dolor

  • Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • Required. Indicate what fields in the provided album to update. The only valid values are title and cover_photo_media_item_id.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").