REST Resource: claims

Resource: Claim

A claim links a partner- or user-uploaded video to an asset that the video matches. The claim indicates whether the video matches the audio, video, or audiovisual (audio and video) components of the asset. The claim also specifies the policy that the rights owner wants YouTube to apply to the claimed video.

JSON representation 
{
  "kind": string,
  "policy": {
    object (Policy)
  },
  "timeCreated": string,
  "contentType": string,
  "ugcType": string,
  "isPartnerUploaded": boolean,
  "timeStatusLastModified": string,
  "blockOutsideOwnership": boolean,
  "status": string,
  "appliedPolicy": {
    object (Policy)
  },
  "id": string,
  "assetId": string,
  "videoId": string,
  "origin": {
    object (Origin)
  },
  "matchInfo": {
    object (MatchInfo)
  },
  "studioInfo": {
    object (StudioInfo)
  }
}
Fields
kind

string

The type of the API resource. For claim resources, this value is youtubePartner#claim.
policy

object (Policy)

The policy provided by the viewing owner on the claim.
timeCreated

string

The time the claim was created.
contentType

string

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

string

UGC type of the claim (standard, premium, song).
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.
blockOutsideOwnership

boolean

Indicates whether or not the claimed video should be blocked anywhere it is not explicitly owned.
status

string

The claim's status. When updating a claim, you can update its status from active to inactive to effectively release the claim, but the API does not support other updates to a claim's status.
appliedPolicy

object (Policy)

The applied policy for the viewing owner on the claim. This might not be the same as the final claim policy on the video as it does not consider other partners' policy of the same claim.
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)
matchInfo

object (MatchInfo)

If this claim was auto-generated based on a provided reference, this section will provide details of the match that generated the claim.
studioInfo

object (StudioInfo)

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

Origin

This object contains information that describes the source of the metadata or ownership data.

JSON representation 
{
  "source": string
}
Fields
source

string

MatchInfo

Match information about the claim.

JSON representation 
{
  "matchSegments": [
    {
      object (MatchSegment)
    }
  ],
  "referenceId": string,
  "longestMatch": {
    object (LongestMatch)
  },
  "totalMatch": {
    object (TotalMatch)
  }
}
Fields
matchSegments[]

object (MatchSegment)

Details about each match segment. Each item in the list contains information about one match segment associated with the claim. It is possible to have multiple match segments. For example, if the audio and video content of an uploaded video match that of a reference video, there would be two match segments. One segment would describe the audio match and the other would describe the video match.
referenceId

string

The reference ID that generated this match.
longestMatch

object (LongestMatch)

Details of the longest match between the reference and the user video.
totalMatch

object (TotalMatch)

Details of the total amount of reference and user video content which matched each other. Note these two values may differ if either the reference or the user video contains a loop.

MatchSegment

Info about a single match segment on a claim.

JSON representation 
{
  "video_segment": {
    object (Segment)
  },
  "reference_segment": {
    object (Segment)
  },
  "channel": string,
  "manual_segment": {
    object (Segment2)
  }
}
Fields
video_segment

object (Segment)

The videoSegment object contains information about the matched portion of the claimed video.
reference_segment

object (Segment)

The referenceSegment object contains information about the matched portion of the reference content.
channel

string

Identifies the manner in which the claimed video matches the reference video.
manual_segment

object (Segment2)

On insert operation of manual claims, the manualSegment object contains information about the specific portion of the video that is claimed to be matching.

Segment

This resource represents a simple segment with start and finish time formatted as a "hh:mm:ss.mmm" string.

JSON representation 
{
  "start": string,
  "duration": string,
  "kind": string
}
Fields
start

string

The start time of the segment, measured in milliseconds from the beginning.
duration

string

The duration of the segment in milliseconds.
kind

string

The type of the API resource. For segment resources, the value is youtubePartner#segment.

Segment2

This resource represents a another simple segment with start and finish time formatted as a "hh:mm:ss.mmm" string.

JSON representation 
{
  "start": string,
  "kind": string,
  "finish": string
}
Fields
start

string

The start time of the segment, measured in milliseconds from the beginning.
kind

string

The type of the API resource. For segment resources, the value is youtubePartner#segment.
finish

string

The finish time of the segment, measured in milliseconds from the beginning.

LongestMatch

Longest claim match.

JSON representation 
{
  "durationSecs": string,
  "userVideoOffset": string,
  "referenceOffset": string
}
Fields
durationSecs

string

The duration of the longest match between the reference and the user video.
userVideoOffset

string

The offset in seconds into the user video at which the longest match began.
referenceOffset

string

The offset in seconds into the reference at which the longest match began.

TotalMatch

Total claim match.

JSON representation 
{
  "userVideoDurationSecs": string,
  "referenceDurationSecs": string
}
Fields
userVideoDurationSecs

string

The total amount of content in the user video which matched the reference in seconds.
referenceDurationSecs

string

The total amount of content in the reference which matched the user video in seconds.

Methods

get

 Retrieves a specific claim by ID.

insert

 Creates a claim.

list

 Retrieves a list of claims administered by the content owner associated with the currently authenticated user.

patch

 Patches an existing claim by either changing its policy or its status.

update

 Updates an existing claim by either changing its policy or its status.