Skip to main content

Package animeshon.library.v1alpha1

Index

Library

GetPlaylist
rpc GetPlaylist(GetPlaylistRequest) Playlist

ListPlaylists
rpc ListPlaylists(ListPlaylistsRequest) ListPlaylistsResponse

CreatePlaylist
rpc CreatePlaylist(CreatePlaylistRequest) Playlist

UpdatePlaylist
rpc UpdatePlaylist(UpdatePlaylistRequest) Playlist

DeletePlaylist
rpc DeletePlaylist(DeletePlaylistRequest) .google.protobuf.Empty

ListPlaylistItems
rpc ListPlaylistItems(ListPlaylistItemsRequest) ListPlaylistItemsResponse

CreatePlaylistItem
rpc CreatePlaylistItem(CreatePlaylistItemRequest) PlaylistItem

BatchCreatePlaylistItems
rpc BatchCreatePlaylistItems(BatchCreatePlaylistItemsRequest) BatchCreatePlaylistItemsResponse

DeletePlaylistItem
rpc DeletePlaylistItem(DeletePlaylistItemRequest) .google.protobuf.Empty

Audience

TODO: this is represented as a group in authorization. TODO: who should be the owner of an audience? the user who created it?

FieldDescription
name string
The id of the audience.
membersrepeated string
The members of this audience.

BatchCreatePlaylistItemsRequest

FieldDescription
parent string
The parent this playlist item belongs to.
itemsrepeated PlaylistItem
The playlist items to create.

BatchCreatePlaylistItemsResponse

FieldDescription
itemsrepeated PlaylistItem
The list of items added to the playlist

CreatePlaylistItemRequest

FieldDescription
parent string
The parent this playlist item belongs to.
item PlaylistItem
The playlist item to create.

CreatePlaylistRequest

FieldDescription
parent string
The parent this playlist belongs to.
playlist Playlist
The playlist to create.

DeletePlaylistItemRequest

FieldDescription
name string
The name of the playlist item to delete.

DeletePlaylistRequest

FieldDescription
name string
The name of the playlist to delete.

GetPlaylistRequest

FieldDescription
name string
The name of the playlist to retrieve.

ListPlaylistItemsRequest

FieldDescription
parent string
The playlist this item belongs to.
page_size int32
If unspecified, server will pick an appropriate default.
page_token string
The value returned from the previous call.
filter string
A filter to be applied to results.

ListPlaylistItemsResponse

FieldDescription
itemsrepeated PlaylistItem
The list of playlist items.
next_page_token string
A token to retrieve next page of results.
total_size int32
The total number of items available in this playlist.

ListPlaylistsRequest

FieldDescription
parent string
The user this playlist belongs to.
page_size int32
If unspecified, server will pick an appropriate default.
page_token string
The value returned from the previous call.
filter string
A filter to be applied to results.

ListPlaylistsResponse

FieldDescription
playlistsrepeated Playlist
The list of playlists.
next_page_token string
A token to retrieve next page of results.

Playlist

FieldDescription
name string
The id of the playlist.
display_name string
The display name of the playlist.
type Type
The type of the playlist.

PlaylistItem

FieldDescription
name string
The id of the playlist.
resource string
The full resource name that identifies the resource.
create_time google.protobuf.Timestamp
The timestamp at which the playlist item was created.

UpdatePlaylistRequest

FieldDescription
playlist Playlist
The playlist to update.
update_mask google.protobuf.FieldMask
The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

Type

NameDescription
TYPE_UNSPECIFIEDNo description.
LATERThe playlist holds items intended to be consumed at a later date
LIKEDThe playlist holds liked items
CUSTOMThe playlist is custom made by the user