Method: assetShares.list

  • This API method retrieves either a list of asset shares mapped to a specified asset view ID or a list of asset views associated with a specified asset share ID.

  • The assetId query parameter is used to specify either an asset view ID or an asset share ID to retrieve the corresponding data.

  • The onBehalfOfContentOwner query parameter allows users to specify the content owner they are acting on behalf of, which is useful for users with accounts linked to multiple content owners.

  • The response body is a paginated list of assetShare resources, structured with fields like kind, pageInfo, items, and nextPageToken for navigating results.

  • An authorization scope of https://www.googleapis.com/auth/youtubepartner is required to make requests to this API.

This method either retrieves a list of asset shares the partner owns and that map to a specified asset view ID or it retrieves a list of asset views associated with a specified asset share ID owned by the partner.

HTTP request

GET https://youtubepartner.googleapis.com/youtube/partner/v1/assetShares

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
assetId

string

The assetId parameter specifies the asset ID for which you are retrieving data. The parameter can be an asset view ID or an asset share ID.

  • If the value is an asset view ID, the API response identifies any asset share ids mapped to the asset view.
  • If the value is an asset share ID, the API response identifies any asset view ids that maps to that asset share.
onBehalfOfContentOwner

string

The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.
pageToken

string

The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

Request body

The request body must be empty.

Response body

A paginated list of assetShare resources returned in response to a list request.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "pageInfo": {
    object (PageInfo)
  },
  "items": [
    {
      object (AssetShare)
    }
  ],
  "nextPageToken": string
}
Fields
kind

string

The type of the API response. For this operation, the value is youtubePartner#assetShareList.
pageInfo

object (PageInfo)

The pageInfo object encapsulates paging information for the result set.
items[]

object (AssetShare)

An assetShare resource that matches the request criteria.
nextPageToken

string

The token that can be used as the value of the pageToken parameter to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/youtubepartner

For more information, see the OAuth 2.0 Overview.