Method: claims.list

Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
assetId

string

Use the claimSearch.list method's assetId parameter to search for claim snippets by asset ID. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.
id

string

The id parameter specifies a list of comma-separated YouTube claim 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. For example, set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.
q

string

Use the claimSearch.list method's q parameter to search for claim snippets that match a particular query string. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.
videoId

string

Use the claimSearch.list method's videoId parameter to search for claim snippets by video ID. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.

Request body

The request body must be empty.

Response body

A paginated list of claims returned in response to a claims.list call.

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

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

string

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

object (PageInfo)

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

object (Claim)

A list of claims 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.
previousPageToken

string

The token that can be used as the value of the pageToken parameter to retrieve the previous 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.