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 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

Constructor Details

#initialize ⇒ YouTubePartnerService

Returns a new instance of YouTubePartnerService.



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

def initialize
  super('https://www.googleapis.com/', 'youtube/partner/v1/')
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



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

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

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.

Parameters:

  • asset_relationship_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

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:



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

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.

Parameters:

  • campaign_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

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:



795
796
797
798
799
800
801
802
803
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 795

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.

Parameters:

  • order_id (String) —

    Id of the order to delete.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOwnerId that super admin acts in behalf of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

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:



1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1738

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.

Parameters:

  • id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

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:



3067
3068
3069
3070
3071
3072
3073
3074
3075
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3067

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.

Parameters:

  • asset_id (String) —

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

  • fetch_match_policy (String) (defaults to: nil) —

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

  • fetch_metadata (String) (defaults to: nil) —

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

  • fetch_ownership (String) (defaults to: nil) —

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

  • fetch_ownership_conflicts (Boolean) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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'] = fetch_metadata unless fetch_metadata.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.

Parameters:

  • asset_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



170
171
172
173
174
175
176
177
178
179
180
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 170

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.

Parameters:

  • campaign_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



834
835
836
837
838
839
840
841
842
843
844
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 834

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.

Parameters:

  • claim_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1200

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.

Parameters:

  • claim_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1046

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.

Parameters:

  • content_owner_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1566

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.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1444

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.

Parameters:

  • order_id (String) —

    The id of the order.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOnwerId that super admin acts in behalf of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1774

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.

Parameters:

  • asset_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2013

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_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.

Parameters:

  • policy_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • publisher_id (String) —

    The publisherId parameter specifies a publisher ID that uniquely identifies the publisher being retrieved.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • reference_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • reference_conflict_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2517

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.

Parameters:

  • video_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2895

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.

Parameters:

  • video_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3106

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 593

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 82

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 342

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

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

    restricted

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • channel_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1655

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.

Parameters:

  • order_object (Google::Apis::YoutubePartnerV1::Order) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOnwerId that super admin acts in behalf of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1812

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_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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

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

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2655

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3148

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.

Parameters:

  • label_prefix (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • q (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 126

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.

Parameters:

  • asset_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 390

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.

Parameters:

  • created_after (DateTime) (defaults to: nil) —

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

  • created_before (DateTime) (defaults to: nil) —

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

  • has_conflicts (Boolean) (defaults to: nil) —

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

  • include_any_providedlabel (Boolean) (defaults to: nil) —

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

  • isrcs (String) (defaults to: nil) —

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

  • labels (String) (defaults to: nil) —

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

  • metadata_search_fields (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • ownership_restriction (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • q (String) (defaults to: nil) —

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

  • sort (String) (defaults to: nil) —

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

  • type (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 479

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'] = metadata_search_fields unless metadata_search_fields.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_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.)

Parameters:

  • id (String) —

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

  • fetch_match_policy (String) (defaults to: nil) —

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

  • fetch_metadata (String) (defaults to: nil) —

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

  • fetch_ownership (String) (defaults to: nil) —

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

  • fetch_ownership_conflicts (Boolean) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 661

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'] = fetch_metadata unless fetch_metadata.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.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



917
918
919
920
921
922
923
924
925
926
927
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 917

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.

Parameters:

  • asset_id (String) (defaults to: nil) —

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

  • content_type (String) (defaults to: nil) —

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

  • created_after (DateTime) (defaults to: nil) —

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

  • created_before (DateTime) (defaults to: nil) —

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

  • inactive_reasons (String) (defaults to: nil) —

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

  • include_third_party_claims (Boolean) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • origin (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • partner_uploaded (Boolean) (defaults to: nil) —

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

  • q (String) (defaults to: nil) —

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

  • reference_id (String) (defaults to: nil) —

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

  • sort (String) (defaults to: nil) —

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

  • status (String) (defaults to: nil) —

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

  • status_modified_after (DateTime) (defaults to: nil) —

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

  • status_modified_before (DateTime) (defaults to: nil) —

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

  • video_id (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1145

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.

Parameters:

  • asset_id (String) (defaults to: nil) —

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

  • id (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • q (String) (defaults to: nil) —

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

  • video_id (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • fetch_mine (Boolean) (defaults to: nil) —

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

  • id (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1610

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.

Parameters:

  • asset_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1699

def list_metadata_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, '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.

Parameters:

  • channel_id (String) (defaults to: nil) —

    Filter results to only a specific channel ( use encrypted ID).

  • content_type (String) (defaults to: nil) —

    Filter the results by type, possible values are SHOW or MOVIE.

  • country (String) (defaults to: nil) —

    Filter results by country, two letter ISO country codes are used.

  • custom_id (String) (defaults to: nil) —

    Filter result by orders that have this custom ID.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOnwerId that super admin acts in behalf of.

  • page_token (String) (defaults to: nil) —

    The continuation token is an optional value that is only used to page through large result sets.

    • To retrieve the next page of results for a request, set this parameter to the value of the nextPageToken value from the previous response.
    • To get the previous page of results, set this parameter to the value of the previousPageToken value from the previous response.
  • priority (String) (defaults to: nil) —

    Filter results by priority. P0, P1, P2, P3 and P4 are the acceptable options.

  • production_house (String) (defaults to: nil) —

    Filter results by a particular production house. Specified by the name of the production house.

  • q (String) (defaults to: nil) —

    Filter results to only orders that contain this string in the title.

  • status (String) (defaults to: nil) —

    Filter results to have this status, available options are STATUS_AVAILED, STATUS_ORDERED, STATUS_RECEIVED, STATUS_READY_FOR_QC, STATUS_MOC_FIX, STATUS_PARTNER_FIX, STATUS_YOUTUBE_FIX, STATUS_QC_APPROVED, STATUS_INACTIVE, STATUS_INGESTION_COMPLETE, STATUS_REORDERED

  • video_id (String) (defaults to: nil) —

    Filter results to orders that are associated with this YouTube external video id.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1880

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.

Parameters:

  • asset_id (String) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • id (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • sort (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2283

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.

Parameters:

  • cae_number (String) (defaults to: nil) —

    The caeNumber parameter specifies the CAE number of the publisher that you want to retrieve.

  • id (String) (defaults to: nil) —

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

  • ipi_number (String) (defaults to: nil) —

    The ipiNumber parameter specifies the IPI number of the publisher that you want to retrieve.

  • max_results (Fixnum) (defaults to: nil) —

    The maxResults parameter specifies the maximum number of results to return per page.

  • name_prefix (String) (defaults to: nil) —

    The namePrefix parameter indicates that the API should only return publishers whose name starts with this prefix.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2471

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.

Parameters:

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2559

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.

Parameters:

  • asset_id (String) (defaults to: nil) —

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

  • id (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2712

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_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.

Parameters:

  • id (String) (defaults to: nil) —

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

  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3194

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 708

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 215

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.

Parameters:

  • campaign_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



959
960
961
962
963
964
965
966
967
968
969
970
971
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 959

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.

Parameters:

  • claim_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1358

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.

Parameters:

  • content_owner_advertising_option_object (Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1483

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.

Parameters:

  • order_id (String) —

    The id of the order.

  • order_object (Google::Apis::YoutubePartnerV1::Order) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOwnerId that super admin acts in behalf of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1928

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • policy_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2326

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.

Parameters:

  • reference_id (String) —

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

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

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

  • release_claims (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2761

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.

Parameters:

  • video_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2980

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 752

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 262

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.

Parameters:

  • campaign_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1003

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.

Parameters:

  • claim_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1403

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.

Parameters:

  • content_owner_advertising_option_object (Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 1524

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.

Parameters:

  • order_id (String) —

    The id of the order.

  • order_object (Google::Apis::YoutubePartnerV1::Order) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

    ContentOwnerId that super admin acts in behalf of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • asset_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

Parameters:

  • policy_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2370

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.

Parameters:

  • reference_id (String) —

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

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

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

  • release_claims (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2811

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.

Parameters:

  • video_id (String) —

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

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 3024

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.

Parameters:

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

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
 
# File 'generated/google/apis/youtube_partner_v1/service.rb', line 2853

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