Class: Google::Apis::YoutubePartnerV1::YouTubePartnerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/youtube_partner_v1/service.rb

Overview

YouTube Content ID API

The YouTube Content ID API allows the management of YouTube assets along with their associated content, references, ownership, rights and policies.

Examples:

require 'google/apis/youtube_partner_v1'

YoutubePartner = Google::Apis::YoutubePartnerV1 # Alias the module
service = YoutubePartner::YouTubePartnerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeYouTubePartnerService

Returns a new instance of YouTubePartnerService.


46
47
48
49
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 46

def initialize
  super('https://www.googleapis.com/', '')
  @batch_path = 'batch/youtubePartner/v1'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


39
40
41
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


44
45
46
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Empty

Deletes a relationship between two assets.

Parameters:

  • asset_relationship_id (String)

    The assetRelationshipId parameter specifies a value that uniquely identifies the relationship you are deleting.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


272
273
274
275
276
277
278
279
280
281
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 272

def delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/partner/v1/assetRelationships/{assetRelationshipId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Empty
  command.params['assetRelationshipId'] = asset_relationship_id unless asset_relationship_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Empty

Deletes a specified campaign for an owner.

Parameters:

  • campaign_id (String)

    The campaignId parameter specifies the YouTube campaign ID of the campaign being deleted.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


767
768
769
770
771
772
773
774
775
776
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 767

def delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/partner/v1/campaigns/{campaignId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Empty
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Empty

Removes a whitelisted channel for a content owner.

Parameters:

  • id (String)

    The id parameter specifies the YouTube channel ID of the channel being removed from whitelist.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2564

def delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'youtube/partner/v1/whitelists/{id}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Empty
  command.params['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_asset(asset_id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Retrieves the metadata for the specified asset. Note that if the request identifies an asset that has been merged with another asset, meaning that YouTube identified the requested asset as a duplicate, then the request retrieves the merged, or synthesized, asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset being retrieved.

  • fetch_match_policy (String) (defaults to: nil)

    The fetchMatchPolicy parameter specifies the version of the asset's match policy that should be returned in the API response.

  • fetch_metadata (String) (defaults to: nil)

    The fetchMetadata parameter specifies the version of the asset's metadata that should be returned in the API response. In some cases, YouTube receives metadata for an asset from multiple sources, such as when different partners own the asset in different territories.

  • fetch_ownership (String) (defaults to: nil)

    The fetchOwnership parameter specifies the version of the asset's ownership data that should be returned in the API response. As with asset metadata, YouTube can receive asset ownership data from multiple sources.

  • fetch_ownership_conflicts (Boolean) (defaults to: nil)

    The fetchOwnershipConflicts parameter allows you to retrieve information about ownership conflicts.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 547

def get_asset(asset_id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Asset
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil?
  command.query['fetchMetadata'] =  unless .nil?
  command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil?
  command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetMatchPolicy

Retrieves the match policy assigned to the specified asset by the content owner associated with the authenticated user. This information is only accessible to an owner of the asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving the match policy.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


152
153
154
155
156
157
158
159
160
161
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 152

def get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Retrieves a particular campaign for an owner.

Parameters:

  • campaign_id (String)

    The campaignId parameter specifies the YouTube campaign ID of the campaign being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


803
804
805
806
807
808
809
810
811
812
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 803

def get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/campaigns/{campaignId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Campaign
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Claim

Retrieves a specific claim by ID.

Parameters:

  • claim_id (String)

    The claimId parameter specifies the claim ID of the claim being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1134

def get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/claims/{claimId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Claim
  command.params['claimId'] = claim_id unless claim_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ClaimHistory

Retrieves the claim history for a specified claim.

Parameters:

  • claim_id (String)

    The claimId parameter specifies the YouTube claim ID of the claim for which you are retrieving the claim history.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


990
991
992
993
994
995
996
997
998
999
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 990

def get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/claimHistory/{claimId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ClaimHistory::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ClaimHistory
  command.params['claimId'] = claim_id unless claim_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwner

Retrieves information about the specified content owner.

Parameters:

  • content_owner_id (String)

    The contentOwnerId parameter specifies a value that uniquely identifies the content owner.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1354

def get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/contentOwners/{contentOwnerId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwner::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ContentOwner
  command.params['contentOwnerId'] = content_owner_id unless content_owner_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::RightsOwnership

Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID for which you are retrieving ownership data.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1509

def get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/ownership', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Package

Retrieves information for the specified package.

Parameters:

  • package_id (String)

    The packageId parameter specifies the Content Delivery package ID of the package being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1674

def get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/package/{packageId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Package::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Package
  command.params['packageId'] = package_id unless package_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Retrieves the specified saved policy.

Parameters:

  • policy_id (String)

    The policyId parameter specifies a value that uniquely identifies the policy being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1745

def get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/policies/{policyId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Policy
  command.params['policyId'] = policy_id unless policy_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

Retrieves information about the specified reference.

Parameters:

  • reference_id (String)

    The referenceId parameter specifies the YouTube reference ID of the reference being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2008

def get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/references/{referenceId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Reference
  command.params['referenceId'] = reference_id unless reference_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ReferenceConflict

Retrieves information about the specified reference conflict.

Parameters:

  • reference_conflict_id (String)

    The referenceConflictId parameter specifies the YouTube reference conflict ID of the reference conflict being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1934

def get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts/{referenceConflictId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflict::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflict
  command.params['referenceConflictId'] = reference_conflict_id unless reference_conflict_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Retrieves advertising settings for the specified video.

Parameters:

  • video_id (String)

    The videoId parameter specifies the YouTube video ID of the video for which you are retrieving advertising settings.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2413

def get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
  command.params['videoId'] = video_id unless video_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse

Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video.

Parameters:

  • video_id (String)

    The videoId parameter specifies the YouTube video ID of the video for which you are retrieving advertising options.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2450

def get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse
  command.params['videoId'] = video_id unless video_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Whitelist

Retrieves a specific whitelisted channel by ID.

Parameters:

  • id (String)

    The id parameter specifies the YouTube channel ID of the whitelisted channel being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2600

def get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/whitelists/{id}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Whitelist
  command.params['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Inserts an asset with the specified metadata. After inserting an asset, you can set its ownership data and match policy.

Parameters:

  • asset_object (Google::Apis::YoutubePartnerV1::Asset) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


586
587
588
589
590
591
592
593
594
595
596
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 586

def insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/assets', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.request_object = asset_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Asset
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetLabel

Insert an asset label for an owner.

Parameters:

  • asset_label_object (Google::Apis::YoutubePartnerV1::AssetLabel) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


74
75
76
77
78
79
80
81
82
83
84
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 74

def insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/assetLabels', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation
  command.request_object = asset_label_object
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetLabel
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetRelationship

Creates a relationship that links two assets.

Parameters:

  • asset_relationship_object (Google::Apis::YoutubePartnerV1::AssetRelationship) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


306
307
308
309
310
311
312
313
314
315
316
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 306

def insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/assetRelationships', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation
  command.request_object = asset_relationship_object
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationship
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Insert a new campaign for an owner using the specified campaign data.

Parameters:

  • campaign_object (Google::Apis::YoutubePartnerV1::Campaign) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


837
838
839
840
841
842
843
844
845
846
847
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 837

def insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/campaigns', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Campaign
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Claim

Creates a claim. The video being claimed must have been uploaded to a channel associated with the same content owner as the API user sending the request. You can set the claim's policy in any of the following ways: - Use the claim resource's policy property to identify a saved policy by its unique ID. - Use the claim resource's policy property to specify a custom set of rules.

Parameters:

  • claim_object (Google::Apis::YoutubePartnerV1::Claim) (defaults to: nil)
  • is_manual_claim (Boolean) (defaults to: nil)

    restricted

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1174

def insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/claims', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.request_object = claim_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Claim
  command.query['isManualClaim'] = is_manual_claim unless is_manual_claim.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::LiveCuepoint

Inserts a cuepoint into a live broadcast.

Parameters:

  • channel_id (String)

    The channelId parameter identifies the channel that owns the broadcast into which the cuepoint is being inserted.

  • live_cuepoint_object (Google::Apis::YoutubePartnerV1::LiveCuepoint) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners. You can obtain the content owner ID that will serve as the parameter value by calling the YouTube Content ID API's contentOwners.list method.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1433

def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/liveCuepoints', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
  command.request_object = live_cuepoint_object
  command.response_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::LiveCuepoint
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::PackageInsertResponse

Inserts a metadata-only package.

Parameters:

  • package_object (Google::Apis::YoutubePartnerV1::Package) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1708

def insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/package', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Package::Representation
  command.request_object = package_object
  command.response_representation = Google::Apis::YoutubePartnerV1::PackageInsertResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::PackageInsertResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Creates a saved policy.

Parameters:

  • policy_object (Google::Apis::YoutubePartnerV1::Policy) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1779

def insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/policies', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Policy
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

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. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim.

Parameters:

  • reference_object (Google::Apis::YoutubePartnerV1::Reference) (defaults to: nil)
  • claim_id (String) (defaults to: nil)

    The claimId parameter specifies the YouTube claim ID of an existing claim from which a reference should be created. (The claimed video is used as the reference content.)

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2058

def insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'youtube/partner/v1/references', options)
  else
    command = make_upload_command(:post, 'youtube/partner/v1/references', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.request_object = reference_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Reference
  command.query['claimId'] = claim_id unless claim_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Whitelist

Whitelist a YouTube channel for your content owner. Whitelisted channels are channels that are not owned or managed by you, but you would like to whitelist so that no claims from your assets are placed on videos uploaded to these channels.

Parameters:

  • whitelist_object (Google::Apis::YoutubePartnerV1::Whitelist) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2637

def insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/whitelists', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
  command.request_object = whitelist_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Whitelist
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetLabelListResponse

Retrieves a list of all asset labels for an owner.

Parameters:

  • label_prefix (String) (defaults to: nil)

    The labelPrefix parameter identifies the prefix of asset labels to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • q (String) (defaults to: nil)

    The q parameter specifies the query string to use to filter search results. YouTube searches for the query string in the labelName field of asset labels.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


113
114
115
116
117
118
119
120
121
122
123
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 113

def list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assetLabels', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabelListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetLabelListResponse
  command.query['labelPrefix'] = label_prefix unless label_prefix.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse

Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the asset ID of the asset for which you are retrieving relationships.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


350
351
352
353
354
355
356
357
358
359
360
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 350

def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assetRelationships', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetSearchResponse

Searches for assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. This method mimics the functionality of the advanced search feature on the Assets page in CMS.

Parameters:

  • created_after (String) (defaults to: nil)

    The createdAfter parameter restricts the set of returned assets to ones originally created on or after the specified datetime. For example: 2015-01- 29T23:00:00Z

  • created_before (String) (defaults to: nil)

    The createdBefore parameter restricts the set of returned assets to ones originally created on or before the specified datetime. For example: 2015-01- 29T23:00:00Z

  • has_conflicts (Boolean) (defaults to: nil)

    The hasConflicts parameter enables you to only retrieve assets that have ownership conflicts. The only valid value is true. Setting the parameter value to false does not affect the results.

  • include_any_providedlabel (Boolean) (defaults to: nil)

    If includeAnyProvidedlabel parameter is set to true, will search for assets that contain any of the provided labels; else will search for assets that contain all the provided labels.

  • isrcs (String) (defaults to: nil)

    A comma-separated list of up to 50 ISRCs. If you specify a value for this parameter, the API server ignores any values set for the following parameters: q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort, and type.

  • labels (String) (defaults to: nil)

    The labels parameter specifies the assets with certain asset labels that you want to retrieve. The parameter value is a comma-separated list of asset labels.

  • metadata_search_fields (String) (defaults to: nil)

    The metadataSearchField parameter specifies which metadata fields to search by. It is a comma-separated list of metadata field and value pairs connected by colon(:). For example: customId:my_custom_id,artist:Dandexx

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • ownership_restriction (String) (defaults to: nil)

    The ownershipRestriction parameter specifies the ownership filtering option for the search. By default the search is performed in the assets owned by currently authenticated user only.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • q (String) (defaults to: nil)

    YouTube searches within the id, type, and customId fields for all assets as well as in numerous other metadata fields – such as actor, album, * director*, isrc, and tmsId – that vary for different types of assets ( movies, music videos, etc.).

  • sort (String) (defaults to: nil)

    The sort parameter specifies how the search results should be sorted. Note that results are always sorted in descending order.

  • type (String) (defaults to: nil)

    The type parameter specifies the types of assets that you want to retrieve. The parameter value is a comma-separated list of asset types.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 435

def list_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assetSearch', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetSearchResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetSearchResponse
  command.query['createdAfter'] = created_after unless created_after.nil?
  command.query['createdBefore'] = created_before unless created_before.nil?
  command.query['hasConflicts'] = has_conflicts unless has_conflicts.nil?
  command.query['includeAnyProvidedlabel'] = include_any_providedlabel unless include_any_providedlabel.nil?
  command.query['isrcs'] = isrcs unless isrcs.nil?
  command.query['labels'] = labels unless labels.nil?
  command.query['metadataSearchFields'] =  unless .nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['ownershipRestriction'] = ownership_restriction unless ownership_restriction.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetShareListResponse

This method either retrieves a list of asset shares the partner owns and that map to a specified asset view ID or it retrieves a list of asset views associated with a specified asset share ID owned by the partner.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the asset ID for which you are retrieving data. The parameter can be an asset view ID or an asset share ID. - If the value is an asset view ID, the API response identifies any asset share ids mapped to the asset view. - If the value is an asset share ID, the API response identifies any asset view ids that maps to that asset share.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


492
493
494
495
496
497
498
499
500
501
502
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 492

def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assetShares', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetListResponse

Retrieves a list of assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. Note that in cases where duplicate assets have been merged, the API response only contains the synthesized asset. (It does not contain the constituent assets that were merged into the synthesized asset.)

Parameters:

  • id (String)

    The id parameter specifies a comma-separated list of YouTube Asset IDs that identify the assets you want to retrieve. As noted in the method description, if you try to retrieve an asset that YouTube identified as a duplicate and merged with another asset, the API response only returns the synthesized asset. In that case, the aliasId property in the asset resource specifies a list of other asset IDs that can be used to identify that asset. Also note that the API response does not contain duplicates. As such, if your request identifies three asset IDs, and all of those have been merged into a single asset, then the API response identifies one matching asset.

  • fetch_match_policy (String) (defaults to: nil)

    The fetchMatchPolicy parameter specifies the version of the asset's match policy that should be returned in the API response.

  • fetch_metadata (String) (defaults to: nil)

    The fetchMetadata parameter specifies the version of the asset's metadata that should be returned in the API response. In some cases, YouTube receives metadata for an asset from multiple sources, such as when different partners own the asset in different territories.

  • fetch_ownership (String) (defaults to: nil)

    The fetchOwnership parameter specifies the version of the asset's ownership data that should be returned in the API response. As with asset metadata, YouTube can receive asset ownership data from multiple sources.

  • fetch_ownership_conflicts (Boolean) (defaults to: nil)

    The fetchOwnershipConflicts parameter allows you to retrieve information about ownership conflicts.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


649
650
651
652
653
654
655
656
657
658
659
660
661
662
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 649

def list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/assets', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse
  command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil?
  command.query['fetchMetadata'] =  unless .nil?
  command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil?
  command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil?
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::CampaignList

Retrieves a list of campaigns for an owner.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. For example, set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


876
877
878
879
880
881
882
883
884
885
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 876

def list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/campaigns', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::CampaignList::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::CampaignList
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ClaimSearchResponse

Retrieves a list of claims that match the search criteria. You can search for claims that are associated with a specific asset or video or that match a specified query string.

Parameters:

  • asset_id (String) (defaults to: nil)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving claims.

  • content_type (String) (defaults to: nil)

    The contentType parameter specifies the content type of claims that you want to retrieve.

  • created_after (String) (defaults to: nil)

    The createdAfter parameter allows you to restrict the set of returned claims to ones created on or after the specified date (inclusive).

  • created_before (String) (defaults to: nil)

    The createdBefore parameter allows you to restrict the set of returned claims to ones created before the specified date (exclusive).

  • inactive_reasons (String) (defaults to: nil)

    The inactiveReasons parameter allows you to specify what kind of inactive claims you want to find based on the reasons why the claims became inactive.

  • include_third_party_claims (Boolean) (defaults to: nil)

    Used along with the videoId parameter this parameter determines whether or not to include third party claims in the search results.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • origin (String) (defaults to: nil)

    The origin parameter specifies the origins you want to find claims for. It is a comma-separated list of origin values.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. For example, set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • partner_uploaded (Boolean) (defaults to: nil)

    The partnerUploaded parameter specifies whether you want to filter your search results to only partner uploaded or non partner uploaded claims.

  • q (String) (defaults to: nil)

    The q parameter specifies the query string to use to filter search results. YouTube searches for the query string in the following claim fields: * video_title*, video_keywords, user_name, isrc, iswc, grid, * custom_id*, and in the content owner's email address.

  • reference_id (String) (defaults to: nil)

    The referenceId parameter specifies the YouTube reference ID of the reference for which you are retrieving claims.

  • sort (String) (defaults to: nil)

    The sort parameter specifies the method that will be used to order resources in the API response. The default value is date. However, if the status parameter value is either appealed, disputed, pending, potential, or routedForReview, then results will be sorted by the time that the claim review period expires.

  • status (String) (defaults to: nil)

    The status parameter restricts your results to only claims in the specified status.

  • status_modified_after (String) (defaults to: nil)

    The statusModifiedAfter parameter allows you to restrict the result set to only include claims that have had their status modified on or after the specified date (inclusive). The date specified must be on or after June 30, 2016 (2016-06-30). The parameter value's format is YYYY-MM-DD.

  • status_modified_before (String) (defaults to: nil)

    The statusModifiedBefore parameter allows you to restrict the result set to only include claims that have had their status modified before the specified date (exclusive). The date specified must be on or after July 1, 2016 (2016-07- 01). The parameter value's format is YYYY-MM-DD.

  • video_id (String) (defaults to: nil)

    The videoId parameter specifies comma-separated list of YouTube video IDs for which you are retrieving claims.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1084

def list_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/claimSearch', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ClaimSearchResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ClaimSearchResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['contentType'] = content_type unless content_type.nil?
  command.query['createdAfter'] = created_after unless created_after.nil?
  command.query['createdBefore'] = created_before unless created_before.nil?
  command.query['inactiveReasons'] = inactive_reasons unless inactive_reasons.nil?
  command.query['includeThirdPartyClaims'] = include_third_party_claims unless include_third_party_claims.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['origin'] = origin unless origin.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerUploaded'] = partner_uploaded unless partner_uploaded.nil?
  command.query['q'] = q unless q.nil?
  command.query['referenceId'] = reference_id unless reference_id.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['status'] = status unless status.nil?
  command.query['statusModifiedAfter'] = status_modified_after unless status_modified_after.nil?
  command.query['statusModifiedBefore'] = status_modified_before unless status_modified_before.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ClaimListResponse

Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time.

Parameters:

  • asset_id (String) (defaults to: nil)

    Use the claimSearch.list method's assetId parameter to search for claim snippets by asset ID. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.

  • id (String) (defaults to: nil)

    The id parameter specifies a list of comma-separated YouTube claim IDs to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. For example, set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • q (String) (defaults to: nil)

    Use the claimSearch.list method's q parameter to search for claim snippets that match a particular query string. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.

  • video_id (String) (defaults to: nil)

    Use the claimSearch.list method's videoId parameter to search for claim snippets by video ID. You can then retrieve the claim resources for those claims by using this method's id parameter to specify a comma-separated list of claim IDs.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1234

def list_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/claims', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ClaimListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ClaimListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwnerListResponse

Retrieves a list of content owners that match the request criteria.

Parameters:

  • fetch_mine (Boolean) (defaults to: nil)

    The fetchMine parameter restricts the result set to content owners associated with the currently authenticated API user.

  • id (String) (defaults to: nil)

    The id parameter specifies a comma-separated list of YouTube content owner IDs to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1393

def list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/contentOwners', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse
  command.query['fetchMine'] = fetch_mine unless fetch_mine.nil?
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse

Retrieves a list of all metadata provided for an asset, regardless of which content owner provided the data.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving a metadata history.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1472

def (asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/metadataHistory', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse

Retrieves a list of the ownership data for an asset, regardless of which content owner provided the data. The list only includes the most recent ownership data for each content owner. However, if the content owner has submitted ownership data through multiple data sources (API, content feeds, etc.), the list will contain the most recent data for each content owner and data source.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving an ownership data history.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1638

def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/ownershipHistory', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::PolicyList

Retrieves a list of the content owner's saved policies.

Parameters:

  • id (String) (defaults to: nil)

    The id parameter specifies a comma-separated list of saved policy IDs to retrieve. Only policies belonging to the currently authenticated content owner will be available.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • sort (String) (defaults to: nil)

    The sort parameter specifies how the search results should be sorted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1819

def list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/policies', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::PolicyList::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::PolicyList
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse

Retrieves a list of unresolved reference conflicts.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1972

def list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ReferenceListResponse

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

Parameters:

  • asset_id (String) (defaults to: nil)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving references.

  • id (String) (defaults to: nil)

    The id parameter specifies a comma-separated list of YouTube reference IDs to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of search results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2111

def list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/references', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ReferenceListResponse
  command.query['assetId'] = asset_id unless asset_id.nil?
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse

Retrieves a list of spreadsheet templates for a content owner.

Parameters:

  • locale (String) (defaults to: nil)

    The locale parameter identifies the desired language for templates in the API response. The value is a string that contains a BCP-47 language code. The default value is en.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2240

def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/spreadsheetTemplate', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse
  command.query['locale'] = locale unless locale.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::UploaderListResponse

Retrieves a list of uploaders for a content owner.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2273
2274
2275
2276
2277
2278
2279
2280
2281
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2273

def list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/uploader', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::UploaderListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::UploaderListResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::WhitelistListResponse

Retrieves a list of whitelisted channels for a content owner.

Parameters:

  • id (String) (defaults to: nil)

    The id parameter specifies a comma-separated list of YouTube channel IDs that identify the whitelisted channels you want to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • page_token (String) (defaults to: nil)

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2678

def list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'youtube/partner/v1/whitelists', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::WhitelistListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::WhitelistListResponse
  command.query['id'] = id unless id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Patches the metadata for the specified asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset being patched.

  • asset_object (Google::Apis::YoutubePartnerV1::Asset) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


690
691
692
693
694
695
696
697
698
699
700
701
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 690

def patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.request_object = asset_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Asset
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetMatchPolicy

Patches the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving the match policy.

  • asset_match_policy_object (Google::Apis::YoutubePartnerV1::AssetMatchPolicy) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


192
193
194
195
196
197
198
199
200
201
202
203
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 192

def patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
  command.request_object = asset_match_policy_object
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Patch the data for a specific campaign.

Parameters:

  • campaign_id (String)

    The campaignId parameter specifies the YouTube campaign ID of the campaign being retrieved.

  • campaign_object (Google::Apis::YoutubePartnerV1::Campaign) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


913
914
915
916
917
918
919
920
921
922
923
924
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 913

def patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/campaigns/{campaignId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Campaign
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Claim

Patches an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim.

Parameters:

  • claim_id (String)

    The claimId parameter specifies the claim ID of the claim being updated.

  • claim_object (Google::Apis::YoutubePartnerV1::Claim) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1276

def patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/claims/{claimId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.request_object = claim_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Claim
  command.params['claimId'] = claim_id unless claim_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::RightsOwnership

Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset being updated.

  • rights_ownership_object (Google::Apis::YoutubePartnerV1::RightsOwnership) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1551

def patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/ownership', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
  command.request_object = rights_ownership_object
  command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Patches the specified saved policy.

Parameters:

  • policy_id (String)

    The policyId parameter specifies a value that uniquely identifies the policy being updated.

  • policy_object (Google::Apis::YoutubePartnerV1::Policy) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1857

def patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/policies/{policyId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Policy
  command.params['policyId'] = policy_id unless policy_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

Patches a reference.

Parameters:

  • reference_id (String)

    The referenceId parameter specifies the YouTube reference ID of the reference being updated.

  • reference_object (Google::Apis::YoutubePartnerV1::Reference) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • release_claims (Boolean) (defaults to: nil)

    The releaseClaims parameter indicates that you want to release all match claims associated with this reference. This parameter only works when the claim's status is being updated to 'inactive' - you can then set the parameter' s value to true to release all match claims produced by this reference.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2155

def patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/references/{referenceId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.request_object = reference_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Reference
  command.params['referenceId'] = reference_id unless reference_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['releaseClaims'] = release_claims unless release_claims.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Patches the advertising settings for the specified video.

Parameters:

  • video_id (String)

    The videoId parameter specifies the YouTube video ID of the video for which you are updating advertising settings.

  • video_advertising_option_object (Google::Apis::YoutubePartnerV1::VideoAdvertisingOption) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2487

def patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
  command.request_object = video_advertising_option_object
  command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
  command.params['videoId'] = video_id unless video_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Updates the metadata for the specified asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset being updated.

  • asset_object (Google::Apis::YoutubePartnerV1::Asset) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


729
730
731
732
733
734
735
736
737
738
739
740
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 729

def update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.request_object = asset_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Asset
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetMatchPolicy

Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset for which you are retrieving the match policy.

  • asset_match_policy_object (Google::Apis::YoutubePartnerV1::AssetMatchPolicy) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


234
235
236
237
238
239
240
241
242
243
244
245
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 234

def update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
  command.request_object = asset_match_policy_object
  command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Update the data for a specific campaign.

Parameters:

  • campaign_id (String)

    The campaignId parameter specifies the YouTube campaign ID of the campaign being retrieved.

  • campaign_object (Google::Apis::YoutubePartnerV1::Campaign) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


952
953
954
955
956
957
958
959
960
961
962
963
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 952

def update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/campaigns/{campaignId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Campaign
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Claim

Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim.

Parameters:

  • claim_id (String)

    The claimId parameter specifies the claim ID of the claim being updated.

  • claim_object (Google::Apis::YoutubePartnerV1::Claim) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1316

def update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/claims/{claimId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.request_object = claim_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Claim
  command.params['claimId'] = claim_id unless claim_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::RightsOwnership

Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership.

Parameters:

  • asset_id (String)

    The assetId parameter specifies the YouTube asset ID of the asset being updated.

  • rights_ownership_object (Google::Apis::YoutubePartnerV1::RightsOwnership) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1595

def update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/ownership', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
  command.request_object = rights_ownership_object
  command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
  command.params['assetId'] = asset_id unless asset_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Updates the specified saved policy.

Parameters:

  • policy_id (String)

    The policyId parameter specifies a value that uniquely identifies the policy being updated.

  • policy_object (Google::Apis::YoutubePartnerV1::Policy) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1896

def update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/policies/{policyId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Policy
  command.params['policyId'] = policy_id unless policy_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

Updates a reference.

Parameters:

  • reference_id (String)

    The referenceId parameter specifies the YouTube reference ID of the reference being updated.

  • reference_object (Google::Apis::YoutubePartnerV1::Reference) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • release_claims (Boolean) (defaults to: nil)

    The releaseClaims parameter indicates that you want to release all match claims associated with this reference. This parameter only works when the claim's status is being updated to 'inactive' - you can then set the parameter' s value to true to release all match claims produced by this reference.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2200

def update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/references/{referenceId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.request_object = reference_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Reference
  command.params['referenceId'] = reference_id unless reference_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['releaseClaims'] = release_claims unless release_claims.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Updates the advertising settings for the specified video.

Parameters:

  • video_id (String)

    The videoId parameter specifies the YouTube video ID of the video for which you are updating advertising settings.

  • video_advertising_option_object (Google::Apis::YoutubePartnerV1::VideoAdvertisingOption) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2526

def update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
  command.request_object = video_advertising_option_object
  command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
  command.params['videoId'] = video_id unless video_id.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateResponse

Validate a metadata file.

Parameters:

  • validate_request_object (Google::Apis::YoutubePartnerV1::ValidateRequest) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2306

def validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/validator', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::ValidateRequest::Representation
  command.request_object = validate_request_object
  command.response_representation = Google::Apis::YoutubePartnerV1::ValidateResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ValidateResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateAsyncResponse

Validate a metadata file asynchronously.

Parameters:

  • validate_async_request_object (Google::Apis::YoutubePartnerV1::ValidateAsyncRequest) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2341

def validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/validatorAsync', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncRequest::Representation
  command.request_object = validate_async_request_object
  command.response_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateStatusResponse

Get the asynchronous validation status.

Parameters:

  • validate_status_request_object (Google::Apis::YoutubePartnerV1::ValidateStatusRequest) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil)

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2376

def validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'youtube/partner/v1/validatorAsyncStatus', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::ValidateStatusRequest::Representation
  command.request_object = validate_status_request_object
  command.response_representation = Google::Apis::YoutubePartnerV1::ValidateStatusResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ValidateStatusResponse
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end