Page Summary
-
The YouTube Content ID API facilitates the management of YouTube assets, including their content, references, ownership, rights, and policies.
-
This API offers numerous REST resources such as
assets,claims,policies, andreferences, enabling diverse operations on YouTube content. -
The service endpoint for this API is
https://youtubepartner.googleapis.com, and all resource URIs are relative to this base URL. -
The API uses Discovery Documents, including the one provided at
https://youtubepartner.googleapis.com/$discovery/rest?version=v1, to define its REST API specifications. -
Google-provided client libraries are recommended for interacting with this API; however, the service's structure enables the use of custom libraries.
The YouTube Content ID API allows the management of YouTube assets along with their associated content, references, ownership, rights and policies.
- REST Resource: assetLabels
- REST Resource: assetMatchPolicy
- REST Resource: assetRelationships
- REST Resource: assetSearch
- REST Resource: assetShares
- REST Resource: assets
- REST Resource: campaigns
- REST Resource: claimHistory
- REST Resource: claimSearch
- REST Resource: claims
- REST Resource: contentOwners
- REST Resource: liveCuepoints
- REST Resource: metadataHistory
- REST Resource: musicChangeRequests
- REST Resource: musicReleases
- REST Resource: musicTracks
- REST Resource: ownership
- REST Resource: ownershipHistory
- REST Resource: package
- REST Resource: policies
- REST Resource: referenceConflicts
- REST Resource: references
- REST Resource: spreadsheetTemplate
- REST Resource: uploader
- REST Resource: validator
- REST Resource: videoAdvertisingOptions
- REST Resource: whitelists
Service: youtubepartner.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://youtubepartner.googleapis.com
REST Resource: assetLabels
| Methods | |
|---|---|
insert |
POST /youtube/partner/v1/assetLabels Insert an asset label for an owner. |
list |
GET /youtube/partner/v1/assetLabels Retrieves a list of all asset labels for an owner. |
REST Resource: assetMatchPolicy
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/assets/{assetId}/matchPolicy Retrieves the match policy assigned to the specified asset by the content owner associated with the authenticated user. |
patch |
PATCH /youtube/partner/v1/assets/{assetId}/matchPolicy Patches the asset's match policy. |
update |
PUT /youtube/partner/v1/assets/{assetId}/matchPolicy Updates the asset's match policy. |
REST Resource: assetRelationships
| Methods | |
|---|---|
delete |
DELETE /youtube/partner/v1/assetRelationships/{assetRelationshipId} Deletes a relationship between two assets. |
insert |
POST /youtube/partner/v1/assetRelationships Creates a relationship that links two assets. |
list |
GET /youtube/partner/v1/assetRelationships Retrieves a list of relationships for a given asset. |
REST Resource: assetSearch
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/assetSearch Searches for assets based on asset metadata. |
REST Resource: assets
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/assets/{assetId} Retrieves the metadata for the specified asset. |
insert |
POST /youtube/partner/v1/assets Inserts an asset with the specified metadata. |
list |
GET /youtube/partner/v1/assets Retrieves a list of assets based on asset metadata. |
patch |
PATCH /youtube/partner/v1/assets/{assetId} Patches the metadata for the specified asset. |
update |
PUT /youtube/partner/v1/assets/{assetId} Updates the metadata for the specified asset. |
REST Resource: campaigns
| Methods | |
|---|---|
delete |
DELETE /youtube/partner/v1/campaigns/{campaignId} Deletes a specified campaign for an owner. |
get |
GET /youtube/partner/v1/campaigns/{campaignId} Retrieves a particular campaign for an owner. |
insert |
POST /youtube/partner/v1/campaigns Insert a new campaign for an owner using the specified campaign data. |
list |
GET /youtube/partner/v1/campaigns Retrieves a list of campaigns for an owner. |
patch |
PATCH /youtube/partner/v1/campaigns/{campaignId} Patch the data for a specific campaign. |
update |
PUT /youtube/partner/v1/campaigns/{campaignId} Update the data for a specific campaign. |
REST Resource: claimHistory
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/claimHistory/{claimId} Retrieves the claim history for a specified claim. |
REST Resource: claimSearch
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/claimSearch Retrieves a list of claims that match the search criteria. |
REST Resource: claims
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/claims/{claimId} Retrieves a specific claim by ID. |
insert |
POST /youtube/partner/v1/claims Creates a claim. |
list |
GET /youtube/partner/v1/claims Retrieves a list of claims administered by the content owner associated with the currently authenticated user. |
patch |
PATCH /youtube/partner/v1/claims/{claimId} Patches an existing claim by either changing its policy or its status. |
update |
PUT /youtube/partner/v1/claims/{claimId} Updates an existing claim by either changing its policy or its status. |
REST Resource: contentOwners
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/contentOwners/{contentOwnerId} Retrieves information about the specified content owner. |
list |
GET /youtube/partner/v1/contentOwners Retrieves a list of content owners that match the request criteria. |
REST Resource: liveCuepoints
| Methods | |
|---|---|
insert |
POST /youtube/partner/v1/liveCuepoints Inserts a cuepoint into a live broadcast. |
REST Resource: metadataHistory
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/metadataHistory Retrieves a list of all metadata provided for an asset, regardless of which content owner provided the data. |
REST Resource: musicChangeRequests
| Methods | |
|---|---|
create |
POST /youtube/partner/v1/music/changeRequests Creates a music change request reported to a release or a track. |
list |
GET /youtube/partner/v1/music/changeRequests Retrieves a list of music change requests reported to a release or a track. |
REST Resource: musicReleases
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/music/releases Retrieves a list of music releases. |
REST Resource: musicTracks
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/music/{parent=releases/*}/tracks Retrieves a list of music tracks. |
REST Resource: ownership
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/assets/{assetId}/ownership Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user. |
patch |
PATCH /youtube/partner/v1/assets/{assetId}/ownership Provides new ownership information for the specified asset. |
update |
PUT /youtube/partner/v1/assets/{assetId}/ownership Provides new ownership information for the specified asset. |
REST Resource: ownershipHistory
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/ownershipHistory Retrieves a list of the ownership data for an asset, regardless of which content owner provided the data. |
REST Resource: package
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/package/{packageId} Retrieves information for the specified package. |
insert |
POST /youtube/partner/v1/package Inserts a metadata-only package. |
REST Resource: policies
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/policies/{policyId} Retrieves the specified saved policy. |
insert |
POST /youtube/partner/v1/policies Creates a saved policy. |
list |
GET /youtube/partner/v1/policies Retrieves a list of the content owner's saved policies. |
patch |
PATCH /youtube/partner/v1/policies/{policyId} Patches the specified saved policy. |
update |
PUT /youtube/partner/v1/policies/{policyId} Updates the specified saved policy. |
REST Resource: referenceConflicts
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/referenceConflicts/{referenceConflictId} Retrieves information about the specified reference conflict. |
list |
GET /youtube/partner/v1/referenceConflicts Retrieves a list of unresolved reference conflicts. |
REST Resource: references
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/references/{referenceId} Retrieves information about the specified reference. |
insert |
POST /youtube/partner/v1/references POST /upload/youtube/partner/v1/references Creates a reference in one of the following ways:
|
list |
GET /youtube/partner/v1/references Retrieves a list of references by ID or the list of references for the specified asset. |
patch |
PATCH /youtube/partner/v1/references/{referenceId} Patches a reference. |
update |
PUT /youtube/partner/v1/references/{referenceId} Updates a reference. |
REST Resource: spreadsheetTemplate
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/spreadsheetTemplate Retrieves a list of spreadsheet templates for a content owner. |
REST Resource: uploader
| Methods | |
|---|---|
list |
GET /youtube/partner/v1/uploader Retrieves a list of uploaders for a content owner. |
REST Resource: validator
| Methods | |
|---|---|
validate |
POST /youtube/partner/v1/validator Validate a metadata file. |
validateAsync |
POST /youtube/partner/v1/validatorAsync Validate a metadata file asynchronously. |
validateAsyncStatus |
POST /youtube/partner/v1/validatorAsyncStatus Get the asynchronous validation status. |
REST Resource: videoAdvertisingOptions
| Methods | |
|---|---|
get |
GET /youtube/partner/v1/videoAdvertisingOptions/{videoId} Retrieves advertising settings for the specified video. |
getEnabledAds |
GET /youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video. |
patch |
PATCH /youtube/partner/v1/videoAdvertisingOptions/{videoId} Patches the advertising settings for the specified video. |
update |
PUT /youtube/partner/v1/videoAdvertisingOptions/{videoId} Updates the advertising settings for the specified video. |
REST Resource: whitelists
| Methods | |
|---|---|
delete |
DELETE /youtube/partner/v1/whitelists/{id} Removes a whitelisted channel for a content owner. |
get |
GET /youtube/partner/v1/whitelists/{id} Retrieves a specific whitelisted channel by ID. |
insert |
POST /youtube/partner/v1/whitelists Whitelist a YouTube channel for your content owner. |
list |
GET /youtube/partner/v1/whitelists Retrieves a list of whitelisted channels for a content owner. |