AlbumPosition

  • AlbumPosition defines the position of media or enrichment items within an album using the PositionType enum.

  • PositionType includes options for positioning items at the beginning, end, or relative to other media or enrichment items within the album.

  • When specifying positions relative to other items, relativeMediaItemId or relativeEnrichmentItemId must be used depending on the item type.

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.