AlbumPosition

  • AlbumPosition defines the position of media or enrichment items within a Google Photos album.

  • It offers five position types: POSITION_TYPE_UNSPECIFIED, FIRST_IN_ALBUM, LAST_IN_ALBUM, AFTER_MEDIA_ITEM, and AFTER_ENRICHMENT_ITEM.

  • For positions relative to other items (AFTER_MEDIA_ITEM, AFTER_ENRICHMENT_ITEM), you must specify the ID of the relative media or enrichment item.

  • The JSON representation includes the position type and, if necessary, the ID of the relative item (relativeMediaItemId or relativeEnrichmentItemId).

Specifies a position in an album.

JSON representation 
{
  "position": enum (PositionType),

  // Union field relative_item can be only one of the following:
  "relativeMediaItemId": string,
  "relativeEnrichmentItemId": string
  // End of list of possible types for union field relative_item.
}
Fields
position

enum (PositionType)

Type of position, for a media or enrichment item.
Union field relative_item. The item to which the position is relative to. This must be set only if using position type AFTER_MEDIA_ITEM or AFTER_ENRICHMENT_ITEM. relative_item can be only one of the following:
relativeMediaItemId

string

The media item to which the position is relative to. Only used when position type is AFTER_MEDIA_ITEM.
relativeEnrichmentItemId

string

The enrichment item to which the position is relative to. Only used when position type is AFTER_ENRICHMENT_ITEM.

PositionType

Possible positions in an album.

Enums
POSITION_TYPE_UNSPECIFIED Default value if this enum isn't set.
FIRST_IN_ALBUM At the beginning of the album.
LAST_IN_ALBUM At the end of the album.
AFTER_MEDIA_ITEM After a media item.
AFTER_ENRICHMENT_ITEM After an enrichment item.