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

API for YouTube partners. To use this API a YouTube CMS account is required.

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


49
50
51
52
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 49

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

Instance Attribute Details

#keyString


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

def key
  @key
end

#quota_userString


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

def quota_user
  @quota_user
end

#user_ipString


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

def user_ip
  @user_ip
end

Instance Method Details

#delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a relationship between two assets.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


292
293
294
295
296
297
298
299
300
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 292

def delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'assetRelationships/{assetRelationshipId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a specified campaign for an owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


814
815
816
817
818
819
820
821
822
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 814

def delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'campaigns/{campaignId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete an order, which moves orders to inactive state and removes any associated video.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1717
1718
1719
1720
1721
1722
1723
1724
1725
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1717

def delete_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'orders/{orderId}', options)
  command.params['orderId'] = order_id unless order_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a whitelisted channel for a content owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


3216
3217
3218
3219
3220
3221
3222
3223
3224
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3216

def delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'whitelists/{id}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 578

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


163
164
165
166
167
168
169
170
171
172
173
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 163

def get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a particular campaign for an owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


851
852
853
854
855
856
857
858
859
860
861
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 851

def get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a specific claim by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1203

def get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the claim history for a specified claim.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1053

def get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwner

Retrieves information about the specified content owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves advertising options for the content owner associated with the authenticated user.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1437

def get_content_owner_advertising_option(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'contentOwnerAdvertisingOptions', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Order

Retrieve the details of an existing order.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1751

def get_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'orders/{orderId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Order
  command.params['orderId'] = order_id unless order_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1980

def get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves information for the specified package.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the specified saved policy.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2235

def get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_publisher(publisher_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Publisher

Retrieves information about the specified publisher.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2439

def get_publisher(publisher_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'publishers/{publisherId}', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::Publisher::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Publisher
  command.params['publisherId'] = publisher_id unless publisher_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves information about the specified reference.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2618

def get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ReferenceConflict

Retrieves information about the specified reference conflict.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2539

def get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Retrieves advertising settings for the specified video.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3052

def get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3092

def get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a specific whitelisted channel by ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3253

def get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


620
621
622
623
624
625
626
627
628
629
630
631
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 620

def insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetLabel

Insert an asset label for an owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


79
80
81
82
83
84
85
86
87
88
89
90
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 79

def insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetRelationship

Creates a relationship that links two assets.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


327
328
329
330
331
332
333
334
335
336
337
338
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 327

def insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


888
889
890
891
892
893
894
895
896
897
898
899
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 888

def insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1247

def insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::LiveCuepoint

Inserts a cuepoint into a live broadcast.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_order(order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Order

Creates a new basic order entry in the YouTube premium asset order management system. You must supply at least a country and channel in the new order.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1787

def insert_order(order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'orders', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.request_object = order_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Order
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Inserts a metadata-only package.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2195

def insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a saved policy.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2671

def insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, 'references', options)
  else
    command = make_upload_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3293

def insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::AssetLabelListResponse

Retrieves a list of all asset labels for an owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


121
122
123
124
125
126
127
128
129
130
131
132
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 121

def list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


373
374
375
376
377
378
379
380
381
382
383
384
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 373

def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 460

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


520
521
522
523
524
525
526
527
528
529
530
531
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 520

def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.)

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a list of campaigns for an owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


930
931
932
933
934
935
936
937
938
939
940
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 930

def list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1150

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1310

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwnerListResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

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 list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1680

def (asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_orders(channel_id: nil, content_type: nil, country: nil, custom_id: nil, on_behalf_of_content_owner: nil, page_token: nil, priority: nil, production_house: nil, q: nil, status: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::OrderListResponse

Return a list of orders, filtered by the parameters below, may return more than a single page of results.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1853

def list_orders(channel_id: nil, content_type: nil, country: nil, custom_id: nil, on_behalf_of_content_owner: nil, page_token: nil, priority: nil, production_house: nil, q: nil, status: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'orders', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::OrderListResponse::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::OrderListResponse
  command.query['channelId'] = channel_id unless channel_id.nil?
  command.query['contentType'] = content_type unless content_type.nil?
  command.query['country'] = country unless country.nil?
  command.query['customId'] = custom_id unless custom_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['priority'] = priority unless priority.nil?
  command.query['productionHouse'] = production_house unless production_house.nil?
  command.query['q'] = q unless q.nil?
  command.query['status'] = status unless status.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2119

def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::PolicyList

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2315

def list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_publishers(cae_number: nil, id: nil, ipi_number: nil, max_results: nil, name_prefix: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::PublisherList

Retrieves a list of publishers that match the request criteria. This method is analogous to a publisher search function.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2495

def list_publishers(cae_number: nil, id: nil, ipi_number: nil, max_results: nil, name_prefix: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'publishers', options)
  command.response_representation = Google::Apis::YoutubePartnerV1::PublisherList::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::PublisherList
  command.query['caeNumber'] = cae_number unless cae_number.nil?
  command.query['id'] = id unless id.nil?
  command.query['ipiNumber'] = ipi_number unless ipi_number.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['namePrefix'] = name_prefix unless name_prefix.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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse

Retrieves a list of unresolved reference conflicts.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2579

def list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2726

def list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a list of spreadsheet templates for a content owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2864

def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves a list of uploaders for a content owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2900

def list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::WhitelistListResponse

Retrieves a list of whitelisted channels for a content owner.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3337

def list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Updates the metadata for the specified asset. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 206

def patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Update the data for a specific campaign. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


970
971
972
973
974
975
976
977
978
979
980
981
982
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 970

def patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

def patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption

Updates advertising options for the content owner associated with the authenticated API user. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1474

def patch_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'contentOwnerAdvertisingOptions', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation
  command.request_object = content_owner_advertising_option_object
  command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Order

Update the values in an existing order. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1899

def patch_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'orders/{orderId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.request_object = order_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Order
  command.params['orderId'] = order_id unless order_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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2026

def patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Updates the specified saved policy. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2356

def patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

Updates a reference. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2773

def patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Updates the advertising settings for the specified video. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3133

def patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Asset

Updates the metadata for the specified asset.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 773

def update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 251

def update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Campaign

Update the data for a specific campaign.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1012

def update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1398

def update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption

Updates advertising options for the content owner associated with the authenticated API user.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1513

def update_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'contentOwnerAdvertisingOptions', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation
  command.request_object = content_owner_advertising_option_object
  command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Order

Update the values in an existing order.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1938

def update_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'orders/{orderId}', options)
  command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.request_object = order_object
  command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation
  command.response_class = Google::Apis::YoutubePartnerV1::Order
  command.params['orderId'] = order_id unless order_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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2073

def update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Policy

Updates the specified saved policy.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2398

def update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::Reference

Updates a reference.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2821

def update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::VideoAdvertisingOption

Updates the advertising settings for the specified video.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3175

def update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateResponse

Validate a metadata file.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2936

def validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateAsyncResponse

Validate a metadata file asynchronously.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2974

def validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubePartnerV1::ValidateStatusResponse

Get the asynchronous validation status.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3012

def validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end