REST Resource: assets

Resource: Asset

An asset resource represents a piece of intellectual property, such as a sound recording or television episode.

JSON representation
{
  "kind": string,
  "type": string,
  "status": string,
  "metadata": {
    object (Metadata)
  },
  "ownership": {
    object (RightsOwnership)
  },
  "matchPolicy": {
    object (AssetMatchPolicy)
  },
  "timeCreated": string,
  "metadataMine": {
    object (Metadata)
  },
  "metadataEffective": {
    object (Metadata)
  },
  "ownershipMine": {
    object (RightsOwnership)
  },
  "ownershipEffective": {
    object (RightsOwnership)
  },
  "matchPolicyMine": {
    object (AssetMatchPolicy)
  },
  "matchPolicyEffective": {
    object (AssetMatchPolicy)
  },
  "ownershipConflicts": {
    object (OwnershipConflicts)
  },
  "id": string,
  "aliasId": [
    string
  ],
  "label": [
    string
  ],
  "licensability": {
    object (AssetLicensability)
  },
  "nWayRevenueSharing": {
    object (NWayRevenueSharing)
  }
}
Fields
kind

string

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

type

string

The asset's type. This value determines the metadata fields that you can set for the asset. In addition, certain API functions may only be supported for specific types of assets. For example, composition assets may have more complex ownership data than other types of assets.

Valid values for this property are:

  • art_track_video

  • composition

  • episode

  • general

  • movie

  • music_video

  • season

  • show

  • sound_recording

  • video_game

  • web

status

string

The asset's status.

metadata

object (Metadata)

The metadata object contains information that identifies and describes the asset. This information could be used to search for the asset or to eliminate duplication within YouTube's database.

ownership

object (RightsOwnership)

The ownership object identifies an asset's owners and provides additional details about their ownership, such as the territories where they own the asset.

matchPolicy

object (AssetMatchPolicy)

The matchPolicy object contains information about the asset's match policy, which YouTube applies to user-uploaded videos that match the asset.

timeCreated

string

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

metadataMine

object (Metadata)

metadataEffective

object (Metadata)

ownershipMine

object (RightsOwnership)

ownershipEffective

object (RightsOwnership)

matchPolicyMine

object (AssetMatchPolicy)

matchPolicyEffective

object (AssetMatchPolicy)

ownershipConflicts

object (OwnershipConflicts)

The ownershipConflicts object contains information about the asset's ownership conflicts.

id

string

An ID that YouTube assigns and uses to uniquely identify the asset.

aliasId[]

string

A list of asset IDs that can be used to refer to the asset. The list contains values if the asset represents multiple constituent assets that have been merged. In that case, any of the asset IDs originally assigned to the constituent assets could be used to update the master, or synthesized, asset.

label[]

string

A list of asset labels on the asset.

licensability

object (AssetLicensability)

Asset licensability information.

nWayRevenueSharing

object (NWayRevenueSharing)

N way revenue sharing (Pangea) information.

OwnershipConflicts

The ownershipConflicts resource represents information about asset's conflicting ownership.

JSON representation
{
  "general": [
    {
      object (TerritoryConflicts)
    }
  ],
  "performance": [
    {
      object (TerritoryConflicts)
    }
  ],
  "synchronization": [
    {
      object (TerritoryConflicts)
    }
  ],
  "mechanical": [
    {
      object (TerritoryConflicts)
    }
  ],
  "kind": string
}
Fields
general[]

object (TerritoryConflicts)

A list that identifies ownership conflicts of an asset and the territories where conflicting ownership is inserted.

performance[]

object (TerritoryConflicts)

A list that identifies ownership conflicts of the performance rights for a composition asset and the territories where conflicting ownership is inserted.

synchronization[]

object (TerritoryConflicts)

A list that identifies ownership conflicts of the synchronization rights for a composition asset and the territories where conflicting ownership is inserted.

mechanical[]

object (TerritoryConflicts)

A list that identifies ownership conflicts of the mechanical rights for a composition asset and the territories where conflicting ownership is inserted.

kind

string

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

TerritoryConflicts

Method to look up terrories with ownership conflicts.

JSON representation
{
  "territory": string,
  "conflictingOwnership": [
    {
      object (ConflictingOwnership)
    }
  ]
}
Fields
territory

string

A territories where the ownership conflict is present. Territory is an ISO 3166 two-letter country code..

conflictingOwnership[]

object (ConflictingOwnership)

A list of conflicting ownerships.

ConflictingOwnership

Represents information about one of conflicting ownerships.

JSON representation
{
  "ratio": number,
  "owner": string
}
Fields
ratio

number

The percentage of the asset that the owner controls or administers.

owner

string

The ID of the conflicting asset's owner.

AssetLicensability

Asset licensability information.

JSON representation
{
  "licensable": boolean,
  "licensabilityState": string,
  "unlicensableReason": [
    string
  ]
}
Fields
licensable

boolean

Whether the reconciled asset is licensable.

licensabilityState

string

The licensability state of the asset.

unlicensableReason[]

string

The reason for why the asset is not licensable.

NWayRevenueSharing

Information asset's n-way revshare.

JSON representation
{
  "status": string,
  "eligibleTerritories": [
    string
  ],
  "ineligibleTerritories": [
    {
      object (TerritoriesIneligibleForNWayRevenueSharing)
    }
  ]
}
Fields
status

string

Status of n-way revenue sharing.

eligibleTerritories[]

string

Each country is represented by its two-letter ISO country code (ISO 3166-1 alpha-2).

ineligibleTerritories[]

object (TerritoriesIneligibleForNWayRevenueSharing)

Information about teritorries in which an asset is ineligible for n-way revenue sharing.

TerritoriesIneligibleForNWayRevenueSharing

Information about territories where an asset is not eligible for n-way revshare.

JSON representation
{
  "reason": string,
  "territories": [
    string
  ]
}
Fields
reason

string

Ineligibility reason for teritorries listed below.

territories[]

string

Each country is represented by its two-letter ISO country code (ISO 3166-1 alpha-2).

Methods

get

Retrieves the metadata for the specified asset.

insert

Inserts an asset with the specified metadata.

list

Retrieves a list of assets based on asset metadata.

patch

Patches the metadata for the specified asset.

update

Updates the metadata for the specified asset.