Method: assetLabels.list

  • This API endpoint retrieves a list of asset labels associated with a content owner via a GET request to https://youtubepartner.googleapis.com/youtube/partner/v1/assetLabels.

  • The request supports several query parameters, including labelPrefix, onBehalfOfContentOwner, q, and pageToken, which allow for filtering and pagination of results.

  • The request body must be empty for this endpoint.

  • A successful response returns a paginated list of assetLabel resources, including details like kind, pageInfo, items, and a nextPageToken for subsequent requests.

  • Authorization for this endpoint requires the https://www.googleapis.com/auth/youtubepartner OAuth scope.

Retrieves a list of all asset labels for an owner.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
labelPrefix

string

The labelPrefix parameter identifies the prefix of asset labels to retrieve.
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.
q

string

The q parameter specifies the query string to use to filter search results. YouTube searches for the query string in the labelName field of asset labels.
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 assetLabel resources returned in response to a assetLabel.list request.

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

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

string

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

object (PageInfo)

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

object (AssetLabel)

A list of assetLabel resources that match 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.