REST Resource: references

  • A Reference represents the actual content of an asset and is used by YouTube to generate claims for asset owners by comparing it to newly uploaded videos.

  • References have various attributes, including status, length, content type, and origination, and they can be marked as urgent for prioritized Content ID processing.

  • The ExcludedInterval feature allows specifying time windows within a reference that will be ignored during the match process, defined by low and high time markers.

  • References can be managed through various methods, such as retrieving, creating, updating, and patching, each serving a specific function in managing reference content.

  • The reference can be associated to an existing video, and in this case will have the corresponding videoId and claimId values.

Resource: Reference

A reference represents the actual content of an asset. YouTube compares newly uploaded videos to a library of references for the purpose of automatically generating claims for the asset's owner(s).

JSON representation 
{
  "kind": string,
  "status": string,
  "statusReason": string,
  "length": number,
  "hashCode": string,
  "urgent": boolean,
  "fpDirect": boolean,
  "contentType": string,
  "audioswapEnabled": boolean,
  "ignoreFpMatch": boolean,
  "origination": {
    object (Origination)
  },
  "excludedIntervals": [
    {
      object (ExcludedInterval)
    }
  ],
  "id": string,
  "assetId": string,
  "duplicateLeader": string,
  "claimId": string,
  "videoId": string
}
Fields
kind

string

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

string

The reference's status.
statusReason

string

An explanation of how a reference entered its current state. This value is only present if the reference's status is either inactive or deleted.
length

number

The length of the reference in seconds.
hashCode

string

The MD5 hashcode of the reference content. Deprecated! This is no longer populated.
urgent

boolean

Set this value to true to indicate that YouTube should prioritize Content ID processing for a video file. YouTube processes urgent video files before other files that are not marked as urgent. This setting is primarily used for videos of live events or other videos that require time-sensitive processing. The sooner YouTube completes Content ID processing for a video, the sooner YouTube can match user-uploaded videos to that video.

Note that marking all of your files as urgent could delay processing for those files.
fpDirect

boolean

When uploading a reference, set this value to true to indicate that the reference is a pre-generated fingerprint.
contentType

string

The type of content that the reference represents.
audioswapEnabled

boolean

Set this field's value to true to indicate that the reference content should be included in YouTube's AudioSwap program.
ignoreFpMatch

boolean

Set this value to true to indicate that the reference should not be used to generate claims. This field is only used on AudioSwap references.
origination

object (Origination)

The origination object contains information that describes the reference source.
excludedIntervals[]

object (ExcludedInterval)

The list of time intervals from this reference that will be ignored during the match process.
id

string

A value that YouTube assigns and uses to uniquely identify a reference.
assetId

string

The ID that uniquely identifies the asset that the reference is associated with.
duplicateLeader

string

The ID that uniquely identifies the reference that this reference duplicates. This field is only present if the reference's status is inactive with reason REASON_DUPLICATE_FOR_OWNERS.
claimId

string

This field is present if the reference was created by associating an asset with an existing YouTube video that was uploaded to a YouTube channel linked to your CMS account. In that case, this field contains the ID of the claim representing the resulting association between the asset and the video.
videoId

string

This field is present if the reference was created by associating an asset with an existing YouTube video that was uploaded to a YouTube channel linked to your CMS account. In that case, this field contains the ID of the source video.

ExcludedInterval

Defines a time window within the reference that will be ignored during the match process.

JSON representation 
{
  "low": number,
  "high": number,
  "origin": string,
  "timeCreated": string
}
Fields
low

number

The start (inclusive) time in seconds of the time window. The value can be any value between 0 and high. Every interval must specify a value for this field.
high

number

The end (inclusive) time in seconds of the time window. The value can be any value greater than low. If high is greater than the length of the reference, the interval between low and the end of the reference will be excluded. Every interval must specify a value for this field.
origin

string

The source of the request to exclude the interval from Content ID matching.
timeCreated

string

The date and time that the exclusion was created. The value is specified in RFC 3339 (YYYY-MM-DDThh:mm:ss.000Z) format.

Methods

get

 Retrieves information about the specified reference.

insert

 Creates a reference in one of the following ways:
  • If your request is uploading a reference file, YouTube creates the reference from the provided content.

list

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

patch

 Patches a reference.

update

 Updates a reference.