REST Resource: claimSearch

  • The ClaimSnippet resource allows searching for claims associated with specific asset or video IDs, or by a query string within your set of claims.

  • ClaimSnippet JSON representation contains details such as claim ID, creation time, status, content type, video views, title, third-party status, partner upload status, and related asset/video IDs.

  • The Origin object in ClaimSnippet identifies the source of the claim, represented by a string field named source.

  • The ClaimSnippet resource has a list method that can be used to retrieve multiple claims based on search criteria.

Resource: ClaimSnippet

The claim search collection lets you search within the set of your claims for claims that are associated with a specific asset ID or video ID or that match a specified query string.

JSON representation 
{
  "kind": string,
  "timeCreated": string,
  "status": string,
  "contentType": string,
  "videoViews": string,
  "engagedViews": string,
  "videoTitle": string,
  "thirdPartyClaim": boolean,
  "isPartnerUploaded": boolean,
  "timeStatusLastModified": string,
  "id": string,
  "assetId": string,
  "videoId": string,
  "origin": {
    object (Origin)
  },
  "isVideoShortsEligible": boolean,
  "studioInfo": {
    object (StudioInfo)
  }
}
Fields
kind

string

The type of the API resource. For this operation, the value is youtubePartner#claimSnippet.
timeCreated

string

The time the claim was created.
status

string

The claim's status.
contentType

string

This value indicates whether the claim covers the audio, video, or audiovisual portion of the claimed content.
videoViews

string

Number of engaged views for the claimed video.
engagedViews

string (int64 format)

Number of engaged views for the claimed video.
videoTitle

string

The title of the claimed video.
thirdPartyClaim

boolean

Indicates that this is a third party claim.
isPartnerUploaded

boolean

Indicates whether or not the claim is a partner uploaded claim.
timeStatusLastModified

string

The time the claim status and/or status detail was last modified.
id

string

The ID that YouTube assigns and uses to uniquely identify the claim.
assetId

string

The unique YouTube asset ID that identifies the asset associated with the claim.
videoId

string

The unique YouTube video ID that identifies the video associated with the claim.
origin

object (Origin)
isVideoShortsEligible

boolean

Indicates whether or not the claim is on a video that is eligible for YouTube Shorts.
studioInfo

object (StudioInfo)

Contains URLs linking back to claim-related pages in Studio.

Origin

JSON representation 
{
  "source": string
}
Fields
source

string

Methods

list

 Retrieves a list of claims that match the search criteria.