Method: references.list

  • This endpoint retrieves a list of YouTube references, either by specific reference IDs or by the references associated with a particular asset ID.

  • The request is made using a GET HTTP method to the specified URL and can utilize query parameters to filter results, such as assetId, id, onBehalfOfContentOwner, and pageToken.

  • The request body should be empty, while the response body will contain a paginated list of references in a JSON format, including fields like kind, pageInfo, items, and nextPageToken.

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

Retrieves a list of references by ID or the list of references for the specified asset.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
assetId

string

The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving references.
id

string

The id parameter specifies a comma-separated list of YouTube reference IDs 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.
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 resources returned in response to a references.list request.

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

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

string

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

object (PageInfo)

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

object (Reference)

A list of references 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 in the result set.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.