google-apis-youtube_partner_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2701 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module YoutubePartnerV1
23
+ # YouTube Content ID API
24
+ #
25
+ # The YouTube Content ID API allows the management of YouTube assets along with
26
+ # their associated content, references, ownership, rights and policies.
27
+ #
28
+ # @example
29
+ # require 'google/apis/youtube_partner_v1'
30
+ #
31
+ # YoutubePartner = Google::Apis::YoutubePartnerV1 # Alias the module
32
+ # service = YoutubePartner::YouTubePartnerService.new
33
+ #
34
+ # @see https://devsite.googleplex.com/youtube/partner/docs/v1/
35
+ class YouTubePartnerService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ attr_accessor :quota_user
45
+
46
+ def initialize
47
+ super('https://www.googleapis.com/', '',
48
+ client_name: 'google-apis-youtube_partner_v1',
49
+ client_version: Google::Apis::YoutubePartnerV1::GEM_VERSION)
50
+ @batch_path = 'batch/youtubePartner/v1'
51
+ end
52
+
53
+ # Insert an asset label for an owner.
54
+ # @param [Google::Apis::YoutubePartnerV1::AssetLabel] asset_label_object
55
+ # @param [String] on_behalf_of_content_owner
56
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
57
+ # user is acting on behalf of. This parameter supports users whose accounts are
58
+ # associated with multiple content owners.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetLabel] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::YoutubePartnerV1::AssetLabel]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:post, 'youtube/partner/v1/assetLabels', options)
78
+ command.request_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation
79
+ command.request_object = asset_label_object
80
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation
81
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetLabel
82
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
83
+ command.query['fields'] = fields unless fields.nil?
84
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
85
+ execute_or_queue_command(command, &block)
86
+ end
87
+
88
+ # Retrieves a list of all asset labels for an owner.
89
+ # @param [String] label_prefix
90
+ # The *labelPrefix* parameter identifies the prefix of asset labels to retrieve.
91
+ # @param [String] on_behalf_of_content_owner
92
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
93
+ # user is acting on behalf of. This parameter supports users whose accounts are
94
+ # associated with multiple content owners.
95
+ # @param [String] q
96
+ # The *q* parameter specifies the query string to use to filter search results.
97
+ # YouTube searches for the query string in the *labelName* field of asset labels.
98
+ # @param [String] fields
99
+ # Selector specifying which fields to include in a partial response.
100
+ # @param [String] quota_user
101
+ # Available to use for quota purposes for server-side applications. Can be any
102
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
103
+ # @param [Google::Apis::RequestOptions] options
104
+ # Request-specific options
105
+ #
106
+ # @yield [result, err] Result & error if block supplied
107
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetLabelListResponse] parsed result object
108
+ # @yieldparam err [StandardError] error object if request failed
109
+ #
110
+ # @return [Google::Apis::YoutubePartnerV1::AssetLabelListResponse]
111
+ #
112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
115
+ def list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
116
+ command = make_simple_command(:get, 'youtube/partner/v1/assetLabels', options)
117
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabelListResponse::Representation
118
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetLabelListResponse
119
+ command.query['labelPrefix'] = label_prefix unless label_prefix.nil?
120
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
121
+ command.query['q'] = q unless q.nil?
122
+ command.query['fields'] = fields unless fields.nil?
123
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
124
+ execute_or_queue_command(command, &block)
125
+ end
126
+
127
+ # Retrieves the match policy assigned to the specified asset by the content
128
+ # owner associated with the authenticated user. This information is only
129
+ # accessible to an owner of the asset.
130
+ # @param [String] asset_id
131
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
132
+ # you are retrieving the match policy.
133
+ # @param [String] on_behalf_of_content_owner
134
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
135
+ # user is acting on behalf of. This parameter supports users whose accounts are
136
+ # associated with multiple content owners.
137
+ # @param [String] fields
138
+ # Selector specifying which fields to include in a partial response.
139
+ # @param [String] quota_user
140
+ # Available to use for quota purposes for server-side applications. Can be any
141
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
142
+ # @param [Google::Apis::RequestOptions] options
143
+ # Request-specific options
144
+ #
145
+ # @yield [result, err] Result & error if block supplied
146
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object
147
+ # @yieldparam err [StandardError] error object if request failed
148
+ #
149
+ # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy]
150
+ #
151
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
152
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
153
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
154
+ def get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
155
+ command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
156
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
157
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
158
+ command.params['assetId'] = asset_id unless asset_id.nil?
159
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
160
+ command.query['fields'] = fields unless fields.nil?
161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
162
+ execute_or_queue_command(command, &block)
163
+ end
164
+
165
+ # Patches the asset's match policy. If an asset has multiple owners, each owner
166
+ # may set its own match policy for the asset. YouTube then computes the match
167
+ # policy that is actually applied for the asset based on the territories where
168
+ # each owner owns the asset.
169
+ # @param [String] asset_id
170
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
171
+ # you are retrieving the match policy.
172
+ # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object
173
+ # @param [String] on_behalf_of_content_owner
174
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
175
+ # user is acting on behalf of. This parameter supports users whose accounts are
176
+ # associated with multiple content owners.
177
+ # @param [String] fields
178
+ # Selector specifying which fields to include in a partial response.
179
+ # @param [String] quota_user
180
+ # Available to use for quota purposes for server-side applications. Can be any
181
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
182
+ # @param [Google::Apis::RequestOptions] options
183
+ # Request-specific options
184
+ #
185
+ # @yield [result, err] Result & error if block supplied
186
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object
187
+ # @yieldparam err [StandardError] error object if request failed
188
+ #
189
+ # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy]
190
+ #
191
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
192
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
193
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
194
+ def patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
195
+ command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
196
+ command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
197
+ command.request_object = asset_match_policy_object
198
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
199
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
200
+ command.params['assetId'] = asset_id unless asset_id.nil?
201
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
202
+ command.query['fields'] = fields unless fields.nil?
203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
204
+ execute_or_queue_command(command, &block)
205
+ end
206
+
207
+ # Updates the asset's match policy. If an asset has multiple owners, each owner
208
+ # may set its own match policy for the asset. YouTube then computes the match
209
+ # policy that is actually applied for the asset based on the territories where
210
+ # each owner owns the asset.
211
+ # @param [String] asset_id
212
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
213
+ # you are retrieving the match policy.
214
+ # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object
215
+ # @param [String] on_behalf_of_content_owner
216
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
217
+ # user is acting on behalf of. This parameter supports users whose accounts are
218
+ # associated with multiple content owners.
219
+ # @param [String] fields
220
+ # Selector specifying which fields to include in a partial response.
221
+ # @param [String] quota_user
222
+ # Available to use for quota purposes for server-side applications. Can be any
223
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
224
+ # @param [Google::Apis::RequestOptions] options
225
+ # Request-specific options
226
+ #
227
+ # @yield [result, err] Result & error if block supplied
228
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object
229
+ # @yieldparam err [StandardError] error object if request failed
230
+ #
231
+ # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy]
232
+ #
233
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
234
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
235
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
236
+ def update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
237
+ command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options)
238
+ command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
239
+ command.request_object = asset_match_policy_object
240
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation
241
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy
242
+ command.params['assetId'] = asset_id unless asset_id.nil?
243
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
244
+ command.query['fields'] = fields unless fields.nil?
245
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
246
+ execute_or_queue_command(command, &block)
247
+ end
248
+
249
+ # Deletes a relationship between two assets.
250
+ # @param [String] asset_relationship_id
251
+ # The *assetRelationshipId* parameter specifies a value that uniquely identifies
252
+ # the relationship you are deleting.
253
+ # @param [String] on_behalf_of_content_owner
254
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
255
+ # user is acting on behalf of. This parameter supports users whose accounts are
256
+ # associated with multiple content owners.
257
+ # @param [String] fields
258
+ # Selector specifying which fields to include in a partial response.
259
+ # @param [String] quota_user
260
+ # Available to use for quota purposes for server-side applications. Can be any
261
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
262
+ # @param [Google::Apis::RequestOptions] options
263
+ # Request-specific options
264
+ #
265
+ # @yield [result, err] Result & error if block supplied
266
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object
267
+ # @yieldparam err [StandardError] error object if request failed
268
+ #
269
+ # @return [Google::Apis::YoutubePartnerV1::Empty]
270
+ #
271
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
272
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
273
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
274
+ def delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
275
+ command = make_simple_command(:delete, 'youtube/partner/v1/assetRelationships/{assetRelationshipId}', options)
276
+ command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
277
+ command.response_class = Google::Apis::YoutubePartnerV1::Empty
278
+ command.params['assetRelationshipId'] = asset_relationship_id unless asset_relationship_id.nil?
279
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
280
+ command.query['fields'] = fields unless fields.nil?
281
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
282
+ execute_or_queue_command(command, &block)
283
+ end
284
+
285
+ # Creates a relationship that links two assets.
286
+ # @param [Google::Apis::YoutubePartnerV1::AssetRelationship] asset_relationship_object
287
+ # @param [String] on_behalf_of_content_owner
288
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
289
+ # user is acting on behalf of. This parameter supports users whose accounts are
290
+ # associated with multiple content owners.
291
+ # @param [String] fields
292
+ # Selector specifying which fields to include in a partial response.
293
+ # @param [String] quota_user
294
+ # Available to use for quota purposes for server-side applications. Can be any
295
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
296
+ # @param [Google::Apis::RequestOptions] options
297
+ # Request-specific options
298
+ #
299
+ # @yield [result, err] Result & error if block supplied
300
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetRelationship] parsed result object
301
+ # @yieldparam err [StandardError] error object if request failed
302
+ #
303
+ # @return [Google::Apis::YoutubePartnerV1::AssetRelationship]
304
+ #
305
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
306
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
307
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
308
+ def insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
309
+ command = make_simple_command(:post, 'youtube/partner/v1/assetRelationships', options)
310
+ command.request_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation
311
+ command.request_object = asset_relationship_object
312
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation
313
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationship
314
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
315
+ command.query['fields'] = fields unless fields.nil?
316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
317
+ execute_or_queue_command(command, &block)
318
+ end
319
+
320
+ # Retrieves a list of relationships for a given asset. The list contains
321
+ # relationships where the specified asset is either the parent (embedding) or
322
+ # child (embedded) asset in the relationship.
323
+ # @param [String] asset_id
324
+ # The *assetId* parameter specifies the asset ID of the asset for which you are
325
+ # retrieving relationships.
326
+ # @param [String] on_behalf_of_content_owner
327
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
328
+ # user is acting on behalf of. This parameter supports users whose accounts are
329
+ # associated with multiple content owners.
330
+ # @param [String] page_token
331
+ # The *pageToken* parameter specifies a token that identifies a particular page
332
+ # of results to return. Set this parameter to the value of the nextPageToken
333
+ # value from the previous API response to retrieve the next page of search
334
+ # results.
335
+ # @param [String] fields
336
+ # Selector specifying which fields to include in a partial response.
337
+ # @param [String] quota_user
338
+ # Available to use for quota purposes for server-side applications. Can be any
339
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
340
+ # @param [Google::Apis::RequestOptions] options
341
+ # Request-specific options
342
+ #
343
+ # @yield [result, err] Result & error if block supplied
344
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse] parsed result object
345
+ # @yieldparam err [StandardError] error object if request failed
346
+ #
347
+ # @return [Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse]
348
+ #
349
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
350
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
351
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
352
+ def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
353
+ command = make_simple_command(:get, 'youtube/partner/v1/assetRelationships', options)
354
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation
355
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse
356
+ command.query['assetId'] = asset_id unless asset_id.nil?
357
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
358
+ command.query['pageToken'] = page_token unless page_token.nil?
359
+ command.query['fields'] = fields unless fields.nil?
360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
361
+ execute_or_queue_command(command, &block)
362
+ end
363
+
364
+ # Searches for assets based on asset metadata. The method can retrieve all
365
+ # assets or only assets owned by the content owner. This method mimics the
366
+ # functionality of the advanced search feature on the Assets page in CMS.
367
+ # @param [String] created_after
368
+ # The *createdAfter* parameter restricts the set of returned assets to ones
369
+ # originally created on or after the specified datetime. For example: 2015-01-
370
+ # 29T23:00:00Z
371
+ # @param [String] created_before
372
+ # The *createdBefore* parameter restricts the set of returned assets to ones
373
+ # originally created on or before the specified datetime. For example: 2015-01-
374
+ # 29T23:00:00Z
375
+ # @param [Boolean] has_conflicts
376
+ # The *hasConflicts* parameter enables you to only retrieve assets that have
377
+ # ownership conflicts. The only valid value is true. Setting the parameter value
378
+ # to false does not affect the results.
379
+ # @param [Boolean] include_any_providedlabel
380
+ # If *includeAnyProvidedlabel* parameter is set to true, will search for assets
381
+ # that contain any of the provided labels; else will search for assets that
382
+ # contain all the provided labels.
383
+ # @param [String] isrcs
384
+ # A comma-separated list of up to 50 ISRCs. If you specify a value for this
385
+ # parameter, the API server ignores any values set for the following parameters:
386
+ # q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort,
387
+ # and type.
388
+ # @param [String] labels
389
+ # The *labels* parameter specifies the assets with certain asset labels that you
390
+ # want to retrieve. The parameter value is a comma-separated list of asset
391
+ # labels.
392
+ # @param [String] metadata_search_fields
393
+ # The *metadataSearchField* parameter specifies which metadata fields to search
394
+ # by. It is a comma-separated list of metadata field and value pairs connected
395
+ # by colon(:). For example: customId:my_custom_id,artist:Dandexx
396
+ # @param [String] on_behalf_of_content_owner
397
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
398
+ # user is acting on behalf of. This parameter supports users whose accounts are
399
+ # associated with multiple content owners.
400
+ # @param [String] ownership_restriction
401
+ # The *ownershipRestriction* parameter specifies the ownership filtering option
402
+ # for the search. By default the search is performed in the assets owned by
403
+ # currently authenticated user only.
404
+ # @param [String] page_token
405
+ # The *pageToken* parameter specifies a token that identifies a particular page
406
+ # of results to return. Set this parameter to the value of the nextPageToken
407
+ # value from the previous API response to retrieve the next page of search
408
+ # results.
409
+ # @param [String] q
410
+ # YouTube searches within the *id*, *type*, and *customId* fields for all assets
411
+ # as well as in numerous other metadata fields – such as *actor*, *album*, *
412
+ # director*, *isrc*, and *tmsId* – that vary for different types of assets (
413
+ # movies, music videos, etc.).
414
+ # @param [String] sort
415
+ # The *sort* parameter specifies how the search results should be sorted. Note
416
+ # that results are always sorted in descending order.
417
+ # @param [String] type
418
+ # The *type* parameter specifies the types of assets that you want to retrieve.
419
+ # The parameter value is a comma-separated list of asset types.
420
+ # @param [String] fields
421
+ # Selector specifying which fields to include in a partial response.
422
+ # @param [String] quota_user
423
+ # Available to use for quota purposes for server-side applications. Can be any
424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
425
+ # @param [Google::Apis::RequestOptions] options
426
+ # Request-specific options
427
+ #
428
+ # @yield [result, err] Result & error if block supplied
429
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetSearchResponse] parsed result object
430
+ # @yieldparam err [StandardError] error object if request failed
431
+ #
432
+ # @return [Google::Apis::YoutubePartnerV1::AssetSearchResponse]
433
+ #
434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
437
+ def list_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
438
+ command = make_simple_command(:get, 'youtube/partner/v1/assetSearch', options)
439
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetSearchResponse::Representation
440
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetSearchResponse
441
+ command.query['createdAfter'] = created_after unless created_after.nil?
442
+ command.query['createdBefore'] = created_before unless created_before.nil?
443
+ command.query['hasConflicts'] = has_conflicts unless has_conflicts.nil?
444
+ command.query['includeAnyProvidedlabel'] = include_any_providedlabel unless include_any_providedlabel.nil?
445
+ command.query['isrcs'] = isrcs unless isrcs.nil?
446
+ command.query['labels'] = labels unless labels.nil?
447
+ command.query['metadataSearchFields'] = metadata_search_fields unless metadata_search_fields.nil?
448
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
449
+ command.query['ownershipRestriction'] = ownership_restriction unless ownership_restriction.nil?
450
+ command.query['pageToken'] = page_token unless page_token.nil?
451
+ command.query['q'] = q unless q.nil?
452
+ command.query['sort'] = sort unless sort.nil?
453
+ command.query['type'] = type unless type.nil?
454
+ command.query['fields'] = fields unless fields.nil?
455
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
456
+ execute_or_queue_command(command, &block)
457
+ end
458
+
459
+ # This method either retrieves a list of asset shares the partner owns and that
460
+ # map to a specified asset view ID *or* it retrieves a list of asset views
461
+ # associated with a specified asset share ID owned by the partner.
462
+ # @param [String] asset_id
463
+ # The *assetId* parameter specifies the asset ID for which you are retrieving
464
+ # data. The parameter can be an asset view ID or an asset share ID. - If the
465
+ # value is an asset view ID, the API response identifies any asset share ids
466
+ # mapped to the asset view. - If the value is an asset share ID, the API
467
+ # response identifies any asset view ids that maps to that asset share.
468
+ # @param [String] on_behalf_of_content_owner
469
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
470
+ # user is acting on behalf of. This parameter supports users whose accounts are
471
+ # associated with multiple content owners.
472
+ # @param [String] page_token
473
+ # The *pageToken* parameter specifies a token that identifies a particular page
474
+ # of results to return. Set this parameter to the value of the nextPageToken
475
+ # value from the previous API response to retrieve the next page of search
476
+ # results.
477
+ # @param [String] fields
478
+ # Selector specifying which fields to include in a partial response.
479
+ # @param [String] quota_user
480
+ # Available to use for quota purposes for server-side applications. Can be any
481
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
482
+ # @param [Google::Apis::RequestOptions] options
483
+ # Request-specific options
484
+ #
485
+ # @yield [result, err] Result & error if block supplied
486
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetShareListResponse] parsed result object
487
+ # @yieldparam err [StandardError] error object if request failed
488
+ #
489
+ # @return [Google::Apis::YoutubePartnerV1::AssetShareListResponse]
490
+ #
491
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
492
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
493
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
494
+ def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
495
+ command = make_simple_command(:get, 'youtube/partner/v1/assetShares', options)
496
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation
497
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse
498
+ command.query['assetId'] = asset_id unless asset_id.nil?
499
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
500
+ command.query['pageToken'] = page_token unless page_token.nil?
501
+ command.query['fields'] = fields unless fields.nil?
502
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
503
+ execute_or_queue_command(command, &block)
504
+ end
505
+
506
+ # Retrieves the metadata for the specified asset. Note that if the request
507
+ # identifies an asset that has been merged with another asset, meaning that
508
+ # YouTube identified the requested asset as a duplicate, then the request
509
+ # retrieves the merged, or synthesized, asset.
510
+ # @param [String] asset_id
511
+ # The *assetId* parameter specifies the YouTube asset ID of the asset being
512
+ # retrieved.
513
+ # @param [String] fetch_match_policy
514
+ # The *fetchMatchPolicy* parameter specifies the version of the asset's match
515
+ # policy that should be returned in the API response.
516
+ # @param [String] fetch_metadata
517
+ # The *fetchMetadata* parameter specifies the version of the asset's metadata
518
+ # that should be returned in the API response. In some cases, YouTube receives
519
+ # metadata for an asset from multiple sources, such as when different partners
520
+ # own the asset in different territories.
521
+ # @param [String] fetch_ownership
522
+ # The *fetchOwnership* parameter specifies the version of the asset's ownership
523
+ # data that should be returned in the API response. As with asset metadata,
524
+ # YouTube can receive asset ownership data from multiple sources.
525
+ # @param [Boolean] fetch_ownership_conflicts
526
+ # The *fetchOwnershipConflicts* parameter allows you to retrieve information
527
+ # about ownership conflicts.
528
+ # @param [String] on_behalf_of_content_owner
529
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
530
+ # user is acting on behalf of. This parameter supports users whose accounts are
531
+ # associated with multiple content owners.
532
+ # @param [String] fields
533
+ # Selector specifying which fields to include in a partial response.
534
+ # @param [String] quota_user
535
+ # Available to use for quota purposes for server-side applications. Can be any
536
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
537
+ # @param [Google::Apis::RequestOptions] options
538
+ # Request-specific options
539
+ #
540
+ # @yield [result, err] Result & error if block supplied
541
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object
542
+ # @yieldparam err [StandardError] error object if request failed
543
+ #
544
+ # @return [Google::Apis::YoutubePartnerV1::Asset]
545
+ #
546
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
547
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
548
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
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, options: nil, &block)
550
+ command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}', options)
551
+ command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
552
+ command.response_class = Google::Apis::YoutubePartnerV1::Asset
553
+ command.params['assetId'] = asset_id unless asset_id.nil?
554
+ command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil?
555
+ command.query['fetchMetadata'] = fetch_metadata unless fetch_metadata.nil?
556
+ command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil?
557
+ command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil?
558
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
559
+ command.query['fields'] = fields unless fields.nil?
560
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
561
+ execute_or_queue_command(command, &block)
562
+ end
563
+
564
+ # Inserts an asset with the specified metadata. After inserting an asset, you
565
+ # can set its ownership data and match policy.
566
+ # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object
567
+ # @param [String] on_behalf_of_content_owner
568
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
569
+ # user is acting on behalf of. This parameter supports users whose accounts are
570
+ # associated with multiple content owners.
571
+ # @param [String] fields
572
+ # Selector specifying which fields to include in a partial response.
573
+ # @param [String] quota_user
574
+ # Available to use for quota purposes for server-side applications. Can be any
575
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
576
+ # @param [Google::Apis::RequestOptions] options
577
+ # Request-specific options
578
+ #
579
+ # @yield [result, err] Result & error if block supplied
580
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object
581
+ # @yieldparam err [StandardError] error object if request failed
582
+ #
583
+ # @return [Google::Apis::YoutubePartnerV1::Asset]
584
+ #
585
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
586
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
587
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
588
+ def insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
589
+ command = make_simple_command(:post, 'youtube/partner/v1/assets', options)
590
+ command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
591
+ command.request_object = asset_object
592
+ command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
593
+ command.response_class = Google::Apis::YoutubePartnerV1::Asset
594
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
595
+ command.query['fields'] = fields unless fields.nil?
596
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
597
+ execute_or_queue_command(command, &block)
598
+ end
599
+
600
+ # Retrieves a list of assets based on asset metadata. The method can retrieve
601
+ # all assets or only assets owned by the content owner. Note that in cases where
602
+ # duplicate assets have been merged, the API response only contains the
603
+ # synthesized asset. (It does not contain the constituent assets that were
604
+ # merged into the synthesized asset.)
605
+ # @param [String] id
606
+ # The *id* parameter specifies a comma-separated list of YouTube Asset IDs that
607
+ # identify the assets you want to retrieve. As noted in the method description,
608
+ # if you try to retrieve an asset that YouTube identified as a duplicate and
609
+ # merged with another asset, the API response only returns the synthesized asset.
610
+ # In that case, the aliasId property in the asset resource specifies a list of
611
+ # other asset IDs that can be used to identify that asset. Also note that the
612
+ # API response does not contain duplicates. As such, if your request identifies
613
+ # three asset IDs, and all of those have been merged into a single asset, then
614
+ # the API response identifies one matching asset.
615
+ # @param [String] fetch_match_policy
616
+ # The *fetchMatchPolicy* parameter specifies the version of the asset's match
617
+ # policy that should be returned in the API response.
618
+ # @param [String] fetch_metadata
619
+ # The *fetchMetadata* parameter specifies the version of the asset's metadata
620
+ # that should be returned in the API response. In some cases, YouTube receives
621
+ # metadata for an asset from multiple sources, such as when different partners
622
+ # own the asset in different territories.
623
+ # @param [String] fetch_ownership
624
+ # The *fetchOwnership* parameter specifies the version of the asset's ownership
625
+ # data that should be returned in the API response. As with asset metadata,
626
+ # YouTube can receive asset ownership data from multiple sources.
627
+ # @param [Boolean] fetch_ownership_conflicts
628
+ # The *fetchOwnershipConflicts* parameter allows you to retrieve information
629
+ # about ownership conflicts.
630
+ # @param [String] on_behalf_of_content_owner
631
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
632
+ # user is acting on behalf of. This parameter supports users whose accounts are
633
+ # associated with multiple content owners.
634
+ # @param [String] fields
635
+ # Selector specifying which fields to include in a partial response.
636
+ # @param [String] quota_user
637
+ # Available to use for quota purposes for server-side applications. Can be any
638
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
639
+ # @param [Google::Apis::RequestOptions] options
640
+ # Request-specific options
641
+ #
642
+ # @yield [result, err] Result & error if block supplied
643
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetListResponse] parsed result object
644
+ # @yieldparam err [StandardError] error object if request failed
645
+ #
646
+ # @return [Google::Apis::YoutubePartnerV1::AssetListResponse]
647
+ #
648
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
649
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
650
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
651
+ def list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
652
+ command = make_simple_command(:get, 'youtube/partner/v1/assets', options)
653
+ command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation
654
+ command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse
655
+ command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil?
656
+ command.query['fetchMetadata'] = fetch_metadata unless fetch_metadata.nil?
657
+ command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil?
658
+ command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil?
659
+ command.query['id'] = id unless id.nil?
660
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
661
+ command.query['fields'] = fields unless fields.nil?
662
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
663
+ execute_or_queue_command(command, &block)
664
+ end
665
+
666
+ # Patches the metadata for the specified asset.
667
+ # @param [String] asset_id
668
+ # The *assetId* parameter specifies the YouTube asset ID of the asset being
669
+ # patched.
670
+ # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object
671
+ # @param [String] on_behalf_of_content_owner
672
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
673
+ # user is acting on behalf of. This parameter supports users whose accounts are
674
+ # associated with multiple content owners.
675
+ # @param [String] fields
676
+ # Selector specifying which fields to include in a partial response.
677
+ # @param [String] quota_user
678
+ # Available to use for quota purposes for server-side applications. Can be any
679
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
680
+ # @param [Google::Apis::RequestOptions] options
681
+ # Request-specific options
682
+ #
683
+ # @yield [result, err] Result & error if block supplied
684
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object
685
+ # @yieldparam err [StandardError] error object if request failed
686
+ #
687
+ # @return [Google::Apis::YoutubePartnerV1::Asset]
688
+ #
689
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
690
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
691
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
692
+ def patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
693
+ command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}', options)
694
+ command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
695
+ command.request_object = asset_object
696
+ command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
697
+ command.response_class = Google::Apis::YoutubePartnerV1::Asset
698
+ command.params['assetId'] = asset_id unless asset_id.nil?
699
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
700
+ command.query['fields'] = fields unless fields.nil?
701
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
702
+ execute_or_queue_command(command, &block)
703
+ end
704
+
705
+ # Updates the metadata for the specified asset.
706
+ # @param [String] asset_id
707
+ # The *assetId* parameter specifies the YouTube asset ID of the asset being
708
+ # updated.
709
+ # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object
710
+ # @param [String] on_behalf_of_content_owner
711
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
712
+ # user is acting on behalf of. This parameter supports users whose accounts are
713
+ # associated with multiple content owners.
714
+ # @param [String] fields
715
+ # Selector specifying which fields to include in a partial response.
716
+ # @param [String] quota_user
717
+ # Available to use for quota purposes for server-side applications. Can be any
718
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
719
+ # @param [Google::Apis::RequestOptions] options
720
+ # Request-specific options
721
+ #
722
+ # @yield [result, err] Result & error if block supplied
723
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object
724
+ # @yieldparam err [StandardError] error object if request failed
725
+ #
726
+ # @return [Google::Apis::YoutubePartnerV1::Asset]
727
+ #
728
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
729
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
730
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
731
+ def update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
732
+ command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}', options)
733
+ command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
734
+ command.request_object = asset_object
735
+ command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation
736
+ command.response_class = Google::Apis::YoutubePartnerV1::Asset
737
+ command.params['assetId'] = asset_id unless asset_id.nil?
738
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
739
+ command.query['fields'] = fields unless fields.nil?
740
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
741
+ execute_or_queue_command(command, &block)
742
+ end
743
+
744
+ # Deletes a specified campaign for an owner.
745
+ # @param [String] campaign_id
746
+ # The *campaignId* parameter specifies the YouTube campaign ID of the campaign
747
+ # being deleted.
748
+ # @param [String] on_behalf_of_content_owner
749
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
750
+ # user is acting on behalf of. This parameter supports users whose accounts are
751
+ # associated with multiple content owners.
752
+ # @param [String] fields
753
+ # Selector specifying which fields to include in a partial response.
754
+ # @param [String] quota_user
755
+ # Available to use for quota purposes for server-side applications. Can be any
756
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
757
+ # @param [Google::Apis::RequestOptions] options
758
+ # Request-specific options
759
+ #
760
+ # @yield [result, err] Result & error if block supplied
761
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object
762
+ # @yieldparam err [StandardError] error object if request failed
763
+ #
764
+ # @return [Google::Apis::YoutubePartnerV1::Empty]
765
+ #
766
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
767
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
768
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
769
+ def delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
770
+ command = make_simple_command(:delete, 'youtube/partner/v1/campaigns/{campaignId}', options)
771
+ command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
772
+ command.response_class = Google::Apis::YoutubePartnerV1::Empty
773
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
774
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
775
+ command.query['fields'] = fields unless fields.nil?
776
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
777
+ execute_or_queue_command(command, &block)
778
+ end
779
+
780
+ # Retrieves a particular campaign for an owner.
781
+ # @param [String] campaign_id
782
+ # The *campaignId* parameter specifies the YouTube campaign ID of the campaign
783
+ # being retrieved.
784
+ # @param [String] on_behalf_of_content_owner
785
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
786
+ # user is acting on behalf of. This parameter supports users whose accounts are
787
+ # associated with multiple content owners.
788
+ # @param [String] fields
789
+ # Selector specifying which fields to include in a partial response.
790
+ # @param [String] quota_user
791
+ # Available to use for quota purposes for server-side applications. Can be any
792
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
793
+ # @param [Google::Apis::RequestOptions] options
794
+ # Request-specific options
795
+ #
796
+ # @yield [result, err] Result & error if block supplied
797
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object
798
+ # @yieldparam err [StandardError] error object if request failed
799
+ #
800
+ # @return [Google::Apis::YoutubePartnerV1::Campaign]
801
+ #
802
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
803
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
804
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
805
+ def get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
806
+ command = make_simple_command(:get, 'youtube/partner/v1/campaigns/{campaignId}', options)
807
+ command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
808
+ command.response_class = Google::Apis::YoutubePartnerV1::Campaign
809
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
810
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
811
+ command.query['fields'] = fields unless fields.nil?
812
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
813
+ execute_or_queue_command(command, &block)
814
+ end
815
+
816
+ # Insert a new campaign for an owner using the specified campaign data.
817
+ # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object
818
+ # @param [String] on_behalf_of_content_owner
819
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
820
+ # user is acting on behalf of. This parameter supports users whose accounts are
821
+ # associated with multiple content owners.
822
+ # @param [String] fields
823
+ # Selector specifying which fields to include in a partial response.
824
+ # @param [String] quota_user
825
+ # Available to use for quota purposes for server-side applications. Can be any
826
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
827
+ # @param [Google::Apis::RequestOptions] options
828
+ # Request-specific options
829
+ #
830
+ # @yield [result, err] Result & error if block supplied
831
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object
832
+ # @yieldparam err [StandardError] error object if request failed
833
+ #
834
+ # @return [Google::Apis::YoutubePartnerV1::Campaign]
835
+ #
836
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
837
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
838
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
839
+ def insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
840
+ command = make_simple_command(:post, 'youtube/partner/v1/campaigns', options)
841
+ command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
842
+ command.request_object = campaign_object
843
+ command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
844
+ command.response_class = Google::Apis::YoutubePartnerV1::Campaign
845
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
846
+ command.query['fields'] = fields unless fields.nil?
847
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
848
+ execute_or_queue_command(command, &block)
849
+ end
850
+
851
+ # Retrieves a list of campaigns for an owner.
852
+ # @param [String] on_behalf_of_content_owner
853
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
854
+ # user is acting on behalf of. This parameter supports users whose accounts are
855
+ # associated with multiple content owners.
856
+ # @param [String] page_token
857
+ # The *pageToken* parameter specifies a token that identifies a particular page
858
+ # of results to return. For example, set this parameter to the value of the
859
+ # nextPageToken value from the previous API response to retrieve the next page
860
+ # of search results.
861
+ # @param [String] fields
862
+ # Selector specifying which fields to include in a partial response.
863
+ # @param [String] quota_user
864
+ # Available to use for quota purposes for server-side applications. Can be any
865
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
866
+ # @param [Google::Apis::RequestOptions] options
867
+ # Request-specific options
868
+ #
869
+ # @yield [result, err] Result & error if block supplied
870
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::CampaignList] parsed result object
871
+ # @yieldparam err [StandardError] error object if request failed
872
+ #
873
+ # @return [Google::Apis::YoutubePartnerV1::CampaignList]
874
+ #
875
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
876
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
877
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
878
+ def list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
879
+ command = make_simple_command(:get, 'youtube/partner/v1/campaigns', options)
880
+ command.response_representation = Google::Apis::YoutubePartnerV1::CampaignList::Representation
881
+ command.response_class = Google::Apis::YoutubePartnerV1::CampaignList
882
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
883
+ command.query['pageToken'] = page_token unless page_token.nil?
884
+ command.query['fields'] = fields unless fields.nil?
885
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
886
+ execute_or_queue_command(command, &block)
887
+ end
888
+
889
+ # Patch the data for a specific campaign.
890
+ # @param [String] campaign_id
891
+ # The *campaignId* parameter specifies the YouTube campaign ID of the campaign
892
+ # being retrieved.
893
+ # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object
894
+ # @param [String] on_behalf_of_content_owner
895
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
896
+ # user is acting on behalf of. This parameter supports users whose accounts are
897
+ # associated with multiple content owners.
898
+ # @param [String] fields
899
+ # Selector specifying which fields to include in a partial response.
900
+ # @param [String] quota_user
901
+ # Available to use for quota purposes for server-side applications. Can be any
902
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
903
+ # @param [Google::Apis::RequestOptions] options
904
+ # Request-specific options
905
+ #
906
+ # @yield [result, err] Result & error if block supplied
907
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object
908
+ # @yieldparam err [StandardError] error object if request failed
909
+ #
910
+ # @return [Google::Apis::YoutubePartnerV1::Campaign]
911
+ #
912
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
913
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
914
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
915
+ def patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
916
+ command = make_simple_command(:patch, 'youtube/partner/v1/campaigns/{campaignId}', options)
917
+ command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
918
+ command.request_object = campaign_object
919
+ command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
920
+ command.response_class = Google::Apis::YoutubePartnerV1::Campaign
921
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
922
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
923
+ command.query['fields'] = fields unless fields.nil?
924
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
925
+ execute_or_queue_command(command, &block)
926
+ end
927
+
928
+ # Update the data for a specific campaign.
929
+ # @param [String] campaign_id
930
+ # The *campaignId* parameter specifies the YouTube campaign ID of the campaign
931
+ # being retrieved.
932
+ # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object
933
+ # @param [String] on_behalf_of_content_owner
934
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
935
+ # user is acting on behalf of. This parameter supports users whose accounts are
936
+ # associated with multiple content owners.
937
+ # @param [String] fields
938
+ # Selector specifying which fields to include in a partial response.
939
+ # @param [String] quota_user
940
+ # Available to use for quota purposes for server-side applications. Can be any
941
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
942
+ # @param [Google::Apis::RequestOptions] options
943
+ # Request-specific options
944
+ #
945
+ # @yield [result, err] Result & error if block supplied
946
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object
947
+ # @yieldparam err [StandardError] error object if request failed
948
+ #
949
+ # @return [Google::Apis::YoutubePartnerV1::Campaign]
950
+ #
951
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
952
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
953
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
954
+ def update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
955
+ command = make_simple_command(:put, 'youtube/partner/v1/campaigns/{campaignId}', options)
956
+ command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
957
+ command.request_object = campaign_object
958
+ command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation
959
+ command.response_class = Google::Apis::YoutubePartnerV1::Campaign
960
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
961
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
962
+ command.query['fields'] = fields unless fields.nil?
963
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
964
+ execute_or_queue_command(command, &block)
965
+ end
966
+
967
+ # Retrieves the claim history for a specified claim.
968
+ # @param [String] claim_id
969
+ # The *claimId* parameter specifies the YouTube claim ID of the claim for which
970
+ # you are retrieving the claim history.
971
+ # @param [String] on_behalf_of_content_owner
972
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
973
+ # user is acting on behalf of. This parameter supports users whose accounts are
974
+ # associated with multiple content owners.
975
+ # @param [String] fields
976
+ # Selector specifying which fields to include in a partial response.
977
+ # @param [String] quota_user
978
+ # Available to use for quota purposes for server-side applications. Can be any
979
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
980
+ # @param [Google::Apis::RequestOptions] options
981
+ # Request-specific options
982
+ #
983
+ # @yield [result, err] Result & error if block supplied
984
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimHistory] parsed result object
985
+ # @yieldparam err [StandardError] error object if request failed
986
+ #
987
+ # @return [Google::Apis::YoutubePartnerV1::ClaimHistory]
988
+ #
989
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
990
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
991
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
992
+ def get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
993
+ command = make_simple_command(:get, 'youtube/partner/v1/claimHistory/{claimId}', options)
994
+ command.response_representation = Google::Apis::YoutubePartnerV1::ClaimHistory::Representation
995
+ command.response_class = Google::Apis::YoutubePartnerV1::ClaimHistory
996
+ command.params['claimId'] = claim_id unless claim_id.nil?
997
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
998
+ command.query['fields'] = fields unless fields.nil?
999
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1000
+ execute_or_queue_command(command, &block)
1001
+ end
1002
+
1003
+ # Retrieves a list of claims that match the search criteria. You can search for
1004
+ # claims that are associated with a specific asset or video or that match a
1005
+ # specified query string.
1006
+ # @param [String] asset_id
1007
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
1008
+ # you are retrieving claims.
1009
+ # @param [String] content_type
1010
+ # The *contentType* parameter specifies the content type of claims that you want
1011
+ # to retrieve.
1012
+ # @param [String] created_after
1013
+ # The *createdAfter* parameter allows you to restrict the set of returned claims
1014
+ # to ones created on or after the specified date (inclusive).
1015
+ # @param [String] created_before
1016
+ # The *createdBefore* parameter allows you to restrict the set of returned
1017
+ # claims to ones created before the specified date (exclusive).
1018
+ # @param [String] inactive_reasons
1019
+ # The *inactiveReasons* parameter allows you to specify what kind of inactive
1020
+ # claims you want to find based on the reasons why the claims became inactive.
1021
+ # @param [Boolean] include_third_party_claims
1022
+ # Used along with the *videoId* parameter this parameter determines whether or
1023
+ # not to include third party claims in the search results.
1024
+ # @param [String] on_behalf_of_content_owner
1025
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1026
+ # user is acting on behalf of. This parameter supports users whose accounts are
1027
+ # associated with multiple content owners.
1028
+ # @param [String] origin
1029
+ # The *origin* parameter specifies the origins you want to find claims for. It
1030
+ # is a comma-separated list of origin values.
1031
+ # @param [String] page_token
1032
+ # The *pageToken* parameter specifies a token that identifies a particular page
1033
+ # of results to return. For example, set this parameter to the value of the
1034
+ # nextPageToken value from the previous API response to retrieve the next page
1035
+ # of search results.
1036
+ # @param [Boolean] partner_uploaded
1037
+ # The *partnerUploaded* parameter specifies whether you want to filter your
1038
+ # search results to only partner uploaded or non partner uploaded claims.
1039
+ # @param [String] q
1040
+ # The *q* parameter specifies the query string to use to filter search results.
1041
+ # YouTube searches for the query string in the following claim fields: *
1042
+ # video_title*, *video_keywords*, *user_name*, *isrc*, *iswc*, *grid*, *
1043
+ # custom_id*, and in the content owner's email address.
1044
+ # @param [String] reference_id
1045
+ # The *referenceId* parameter specifies the YouTube reference ID of the
1046
+ # reference for which you are retrieving claims.
1047
+ # @param [String] sort
1048
+ # The *sort* parameter specifies the method that will be used to order resources
1049
+ # in the API response. The default value is date. However, if the status
1050
+ # parameter value is either appealed, disputed, pending, potential, or
1051
+ # routedForReview, then results will be sorted by the time that the claim review
1052
+ # period expires.
1053
+ # @param [String] status
1054
+ # The *status* parameter restricts your results to only claims in the specified
1055
+ # status.
1056
+ # @param [String] status_modified_after
1057
+ # The *statusModifiedAfter* parameter allows you to restrict the result set to
1058
+ # only include claims that have had their status modified on or after the
1059
+ # specified date (inclusive). The date specified must be on or after June 30,
1060
+ # 2016 (2016-06-30). The parameter value's format is YYYY-MM-DD.
1061
+ # @param [String] status_modified_before
1062
+ # The *statusModifiedBefore* parameter allows you to restrict the result set to
1063
+ # only include claims that have had their status modified before the specified
1064
+ # date (exclusive). The date specified must be on or after July 1, 2016 (2016-07-
1065
+ # 01). The parameter value's format is YYYY-MM-DD.
1066
+ # @param [String] video_id
1067
+ # The *videoId* parameter specifies comma-separated list of YouTube video IDs
1068
+ # for which you are retrieving claims.
1069
+ # @param [String] fields
1070
+ # Selector specifying which fields to include in a partial response.
1071
+ # @param [String] quota_user
1072
+ # Available to use for quota purposes for server-side applications. Can be any
1073
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1074
+ # @param [Google::Apis::RequestOptions] options
1075
+ # Request-specific options
1076
+ #
1077
+ # @yield [result, err] Result & error if block supplied
1078
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimSearchResponse] parsed result object
1079
+ # @yieldparam err [StandardError] error object if request failed
1080
+ #
1081
+ # @return [Google::Apis::YoutubePartnerV1::ClaimSearchResponse]
1082
+ #
1083
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1084
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1085
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1086
+ def list_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1087
+ command = make_simple_command(:get, 'youtube/partner/v1/claimSearch', options)
1088
+ command.response_representation = Google::Apis::YoutubePartnerV1::ClaimSearchResponse::Representation
1089
+ command.response_class = Google::Apis::YoutubePartnerV1::ClaimSearchResponse
1090
+ command.query['assetId'] = asset_id unless asset_id.nil?
1091
+ command.query['contentType'] = content_type unless content_type.nil?
1092
+ command.query['createdAfter'] = created_after unless created_after.nil?
1093
+ command.query['createdBefore'] = created_before unless created_before.nil?
1094
+ command.query['inactiveReasons'] = inactive_reasons unless inactive_reasons.nil?
1095
+ command.query['includeThirdPartyClaims'] = include_third_party_claims unless include_third_party_claims.nil?
1096
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1097
+ command.query['origin'] = origin unless origin.nil?
1098
+ command.query['pageToken'] = page_token unless page_token.nil?
1099
+ command.query['partnerUploaded'] = partner_uploaded unless partner_uploaded.nil?
1100
+ command.query['q'] = q unless q.nil?
1101
+ command.query['referenceId'] = reference_id unless reference_id.nil?
1102
+ command.query['sort'] = sort unless sort.nil?
1103
+ command.query['status'] = status unless status.nil?
1104
+ command.query['statusModifiedAfter'] = status_modified_after unless status_modified_after.nil?
1105
+ command.query['statusModifiedBefore'] = status_modified_before unless status_modified_before.nil?
1106
+ command.query['videoId'] = video_id unless video_id.nil?
1107
+ command.query['fields'] = fields unless fields.nil?
1108
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1109
+ execute_or_queue_command(command, &block)
1110
+ end
1111
+
1112
+ # Retrieves a specific claim by ID.
1113
+ # @param [String] claim_id
1114
+ # The *claimId* parameter specifies the claim ID of the claim being retrieved.
1115
+ # @param [String] on_behalf_of_content_owner
1116
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1117
+ # user is acting on behalf of. This parameter supports users whose accounts are
1118
+ # associated with multiple content owners.
1119
+ # @param [String] fields
1120
+ # Selector specifying which fields to include in a partial response.
1121
+ # @param [String] quota_user
1122
+ # Available to use for quota purposes for server-side applications. Can be any
1123
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1124
+ # @param [Google::Apis::RequestOptions] options
1125
+ # Request-specific options
1126
+ #
1127
+ # @yield [result, err] Result & error if block supplied
1128
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object
1129
+ # @yieldparam err [StandardError] error object if request failed
1130
+ #
1131
+ # @return [Google::Apis::YoutubePartnerV1::Claim]
1132
+ #
1133
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1134
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1135
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1136
+ def get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1137
+ command = make_simple_command(:get, 'youtube/partner/v1/claims/{claimId}', options)
1138
+ command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1139
+ command.response_class = Google::Apis::YoutubePartnerV1::Claim
1140
+ command.params['claimId'] = claim_id unless claim_id.nil?
1141
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1142
+ command.query['fields'] = fields unless fields.nil?
1143
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1144
+ execute_or_queue_command(command, &block)
1145
+ end
1146
+
1147
+ # Creates a claim. The video being claimed must have been uploaded to a channel
1148
+ # associated with the same content owner as the API user sending the request.
1149
+ # You can set the claim's policy in any of the following ways: - Use the claim
1150
+ # resource's policy property to identify a saved policy by its unique ID. - Use
1151
+ # the claim resource's policy property to specify a custom set of rules.
1152
+ # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object
1153
+ # @param [Boolean] is_manual_claim
1154
+ # restricted
1155
+ # @param [String] on_behalf_of_content_owner
1156
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1157
+ # user is acting on behalf of. This parameter supports users whose accounts are
1158
+ # associated with multiple content owners.
1159
+ # @param [String] fields
1160
+ # Selector specifying which fields to include in a partial response.
1161
+ # @param [String] quota_user
1162
+ # Available to use for quota purposes for server-side applications. Can be any
1163
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1164
+ # @param [Google::Apis::RequestOptions] options
1165
+ # Request-specific options
1166
+ #
1167
+ # @yield [result, err] Result & error if block supplied
1168
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object
1169
+ # @yieldparam err [StandardError] error object if request failed
1170
+ #
1171
+ # @return [Google::Apis::YoutubePartnerV1::Claim]
1172
+ #
1173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1176
+ def insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1177
+ command = make_simple_command(:post, 'youtube/partner/v1/claims', options)
1178
+ command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1179
+ command.request_object = claim_object
1180
+ command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1181
+ command.response_class = Google::Apis::YoutubePartnerV1::Claim
1182
+ command.query['isManualClaim'] = is_manual_claim unless is_manual_claim.nil?
1183
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1184
+ command.query['fields'] = fields unless fields.nil?
1185
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1186
+ execute_or_queue_command(command, &block)
1187
+ end
1188
+
1189
+ # Retrieves a list of claims administered by the content owner associated with
1190
+ # the currently authenticated user. Results are sorted in descending order of
1191
+ # creation time.
1192
+ # @param [String] asset_id
1193
+ # Use the claimSearch.list method's assetId parameter to search for claim
1194
+ # snippets by asset ID. You can then retrieve the claim resources for those
1195
+ # claims by using this method's *id* parameter to specify a comma-separated list
1196
+ # of claim IDs.
1197
+ # @param [String] id
1198
+ # The *id* parameter specifies a list of comma-separated YouTube claim IDs to
1199
+ # retrieve.
1200
+ # @param [String] on_behalf_of_content_owner
1201
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1202
+ # user is acting on behalf of. This parameter supports users whose accounts are
1203
+ # associated with multiple content owners.
1204
+ # @param [String] page_token
1205
+ # The *pageToken* parameter specifies a token that identifies a particular page
1206
+ # of results to return. For example, set this parameter to the value of the
1207
+ # nextPageToken value from the previous API response to retrieve the next page
1208
+ # of search results.
1209
+ # @param [String] q
1210
+ # Use the claimSearch.list method's q parameter to search for claim snippets
1211
+ # that match a particular query string. You can then retrieve the claim
1212
+ # resources for those claims by using this method's *id* parameter to specify a
1213
+ # comma-separated list of claim IDs.
1214
+ # @param [String] video_id
1215
+ # Use the claimSearch.list method's videoId parameter to search for claim
1216
+ # snippets by video ID. You can then retrieve the claim resources for those
1217
+ # claims by using this method's *id* parameter to specify a comma-separated list
1218
+ # of claim IDs.
1219
+ # @param [String] fields
1220
+ # Selector specifying which fields to include in a partial response.
1221
+ # @param [String] quota_user
1222
+ # Available to use for quota purposes for server-side applications. Can be any
1223
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1224
+ # @param [Google::Apis::RequestOptions] options
1225
+ # Request-specific options
1226
+ #
1227
+ # @yield [result, err] Result & error if block supplied
1228
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimListResponse] parsed result object
1229
+ # @yieldparam err [StandardError] error object if request failed
1230
+ #
1231
+ # @return [Google::Apis::YoutubePartnerV1::ClaimListResponse]
1232
+ #
1233
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1234
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1235
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1236
+ def list_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1237
+ command = make_simple_command(:get, 'youtube/partner/v1/claims', options)
1238
+ command.response_representation = Google::Apis::YoutubePartnerV1::ClaimListResponse::Representation
1239
+ command.response_class = Google::Apis::YoutubePartnerV1::ClaimListResponse
1240
+ command.query['assetId'] = asset_id unless asset_id.nil?
1241
+ command.query['id'] = id unless id.nil?
1242
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1243
+ command.query['pageToken'] = page_token unless page_token.nil?
1244
+ command.query['q'] = q unless q.nil?
1245
+ command.query['videoId'] = video_id unless video_id.nil?
1246
+ command.query['fields'] = fields unless fields.nil?
1247
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1248
+ execute_or_queue_command(command, &block)
1249
+ end
1250
+
1251
+ # Patches an existing claim by either changing its policy or its status. You can
1252
+ # update a claim's status from active to inactive to effectively release the
1253
+ # claim.
1254
+ # @param [String] claim_id
1255
+ # The *claimId* parameter specifies the claim ID of the claim being updated.
1256
+ # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object
1257
+ # @param [String] on_behalf_of_content_owner
1258
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1259
+ # user is acting on behalf of. This parameter supports users whose accounts are
1260
+ # associated with multiple content owners.
1261
+ # @param [String] fields
1262
+ # Selector specifying which fields to include in a partial response.
1263
+ # @param [String] quota_user
1264
+ # Available to use for quota purposes for server-side applications. Can be any
1265
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1266
+ # @param [Google::Apis::RequestOptions] options
1267
+ # Request-specific options
1268
+ #
1269
+ # @yield [result, err] Result & error if block supplied
1270
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object
1271
+ # @yieldparam err [StandardError] error object if request failed
1272
+ #
1273
+ # @return [Google::Apis::YoutubePartnerV1::Claim]
1274
+ #
1275
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1276
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1277
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1278
+ def patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1279
+ command = make_simple_command(:patch, 'youtube/partner/v1/claims/{claimId}', options)
1280
+ command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1281
+ command.request_object = claim_object
1282
+ command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1283
+ command.response_class = Google::Apis::YoutubePartnerV1::Claim
1284
+ command.params['claimId'] = claim_id unless claim_id.nil?
1285
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1286
+ command.query['fields'] = fields unless fields.nil?
1287
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1288
+ execute_or_queue_command(command, &block)
1289
+ end
1290
+
1291
+ # Updates an existing claim by either changing its policy or its status. You can
1292
+ # update a claim's status from active to inactive to effectively release the
1293
+ # claim.
1294
+ # @param [String] claim_id
1295
+ # The *claimId* parameter specifies the claim ID of the claim being updated.
1296
+ # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object
1297
+ # @param [String] on_behalf_of_content_owner
1298
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1299
+ # user is acting on behalf of. This parameter supports users whose accounts are
1300
+ # associated with multiple content owners.
1301
+ # @param [String] fields
1302
+ # Selector specifying which fields to include in a partial response.
1303
+ # @param [String] quota_user
1304
+ # Available to use for quota purposes for server-side applications. Can be any
1305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1306
+ # @param [Google::Apis::RequestOptions] options
1307
+ # Request-specific options
1308
+ #
1309
+ # @yield [result, err] Result & error if block supplied
1310
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object
1311
+ # @yieldparam err [StandardError] error object if request failed
1312
+ #
1313
+ # @return [Google::Apis::YoutubePartnerV1::Claim]
1314
+ #
1315
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1316
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1317
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1318
+ def update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1319
+ command = make_simple_command(:put, 'youtube/partner/v1/claims/{claimId}', options)
1320
+ command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1321
+ command.request_object = claim_object
1322
+ command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation
1323
+ command.response_class = Google::Apis::YoutubePartnerV1::Claim
1324
+ command.params['claimId'] = claim_id unless claim_id.nil?
1325
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1326
+ command.query['fields'] = fields unless fields.nil?
1327
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1328
+ execute_or_queue_command(command, &block)
1329
+ end
1330
+
1331
+ # Retrieves information about the specified content owner.
1332
+ # @param [String] content_owner_id
1333
+ # The *contentOwnerId* parameter specifies a value that uniquely identifies the
1334
+ # content owner.
1335
+ # @param [String] on_behalf_of_content_owner
1336
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1337
+ # user is acting on behalf of. This parameter supports users whose accounts are
1338
+ # associated with multiple content owners.
1339
+ # @param [String] fields
1340
+ # Selector specifying which fields to include in a partial response.
1341
+ # @param [String] quota_user
1342
+ # Available to use for quota purposes for server-side applications. Can be any
1343
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1344
+ # @param [Google::Apis::RequestOptions] options
1345
+ # Request-specific options
1346
+ #
1347
+ # @yield [result, err] Result & error if block supplied
1348
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwner] parsed result object
1349
+ # @yieldparam err [StandardError] error object if request failed
1350
+ #
1351
+ # @return [Google::Apis::YoutubePartnerV1::ContentOwner]
1352
+ #
1353
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1354
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1355
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1356
+ def get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1357
+ command = make_simple_command(:get, 'youtube/partner/v1/contentOwners/{contentOwnerId}', options)
1358
+ command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwner::Representation
1359
+ command.response_class = Google::Apis::YoutubePartnerV1::ContentOwner
1360
+ command.params['contentOwnerId'] = content_owner_id unless content_owner_id.nil?
1361
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1362
+ command.query['fields'] = fields unless fields.nil?
1363
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1364
+ execute_or_queue_command(command, &block)
1365
+ end
1366
+
1367
+ # Retrieves a list of content owners that match the request criteria.
1368
+ # @param [Boolean] fetch_mine
1369
+ # The *fetchMine* parameter restricts the result set to content owners
1370
+ # associated with the currently authenticated API user.
1371
+ # @param [String] id
1372
+ # The *id* parameter specifies a comma-separated list of YouTube content owner
1373
+ # IDs to retrieve.
1374
+ # @param [String] on_behalf_of_content_owner
1375
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1376
+ # user is acting on behalf of. This parameter supports users whose accounts are
1377
+ # associated with multiple content owners.
1378
+ # @param [String] fields
1379
+ # Selector specifying which fields to include in a partial response.
1380
+ # @param [String] quota_user
1381
+ # Available to use for quota purposes for server-side applications. Can be any
1382
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1383
+ # @param [Google::Apis::RequestOptions] options
1384
+ # Request-specific options
1385
+ #
1386
+ # @yield [result, err] Result & error if block supplied
1387
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerListResponse] parsed result object
1388
+ # @yieldparam err [StandardError] error object if request failed
1389
+ #
1390
+ # @return [Google::Apis::YoutubePartnerV1::ContentOwnerListResponse]
1391
+ #
1392
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1393
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1394
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1395
+ def list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1396
+ command = make_simple_command(:get, 'youtube/partner/v1/contentOwners', options)
1397
+ command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse::Representation
1398
+ command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse
1399
+ command.query['fetchMine'] = fetch_mine unless fetch_mine.nil?
1400
+ command.query['id'] = id unless id.nil?
1401
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1402
+ command.query['fields'] = fields unless fields.nil?
1403
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1404
+ execute_or_queue_command(command, &block)
1405
+ end
1406
+
1407
+ # Inserts a cuepoint into a live broadcast.
1408
+ # @param [String] channel_id
1409
+ # The *channelId* parameter identifies the channel that owns the broadcast into
1410
+ # which the cuepoint is being inserted.
1411
+ # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object
1412
+ # @param [String] on_behalf_of_content_owner
1413
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1414
+ # user is acting on behalf of. This parameter supports users whose accounts are
1415
+ # associated with multiple content owners. You can obtain the content owner ID
1416
+ # that will serve as the parameter value by calling the YouTube Content ID API's
1417
+ # contentOwners.list method.
1418
+ # @param [String] fields
1419
+ # Selector specifying which fields to include in a partial response.
1420
+ # @param [String] quota_user
1421
+ # Available to use for quota purposes for server-side applications. Can be any
1422
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1423
+ # @param [Google::Apis::RequestOptions] options
1424
+ # Request-specific options
1425
+ #
1426
+ # @yield [result, err] Result & error if block supplied
1427
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::LiveCuepoint] parsed result object
1428
+ # @yieldparam err [StandardError] error object if request failed
1429
+ #
1430
+ # @return [Google::Apis::YoutubePartnerV1::LiveCuepoint]
1431
+ #
1432
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1433
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1434
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1435
+ def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1436
+ command = make_simple_command(:post, 'youtube/partner/v1/liveCuepoints', options)
1437
+ command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
1438
+ command.request_object = live_cuepoint_object
1439
+ command.response_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
1440
+ command.response_class = Google::Apis::YoutubePartnerV1::LiveCuepoint
1441
+ command.query['channelId'] = channel_id unless channel_id.nil?
1442
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1443
+ command.query['fields'] = fields unless fields.nil?
1444
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1445
+ execute_or_queue_command(command, &block)
1446
+ end
1447
+
1448
+ # Retrieves a list of all metadata provided for an asset, regardless of which
1449
+ # content owner provided the data.
1450
+ # @param [String] asset_id
1451
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
1452
+ # you are retrieving a metadata history.
1453
+ # @param [String] on_behalf_of_content_owner
1454
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1455
+ # user is acting on behalf of. This parameter supports users whose accounts are
1456
+ # associated with multiple content owners.
1457
+ # @param [String] fields
1458
+ # Selector specifying which fields to include in a partial response.
1459
+ # @param [String] quota_user
1460
+ # Available to use for quota purposes for server-side applications. Can be any
1461
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1462
+ # @param [Google::Apis::RequestOptions] options
1463
+ # Request-specific options
1464
+ #
1465
+ # @yield [result, err] Result & error if block supplied
1466
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse] parsed result object
1467
+ # @yieldparam err [StandardError] error object if request failed
1468
+ #
1469
+ # @return [Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse]
1470
+ #
1471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1474
+ def list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1475
+ command = make_simple_command(:get, 'youtube/partner/v1/metadataHistory', options)
1476
+ command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation
1477
+ command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse
1478
+ command.query['assetId'] = asset_id unless asset_id.nil?
1479
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1480
+ command.query['fields'] = fields unless fields.nil?
1481
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1482
+ execute_or_queue_command(command, &block)
1483
+ end
1484
+
1485
+ # Retrieves the ownership data provided for the specified asset by the content
1486
+ # owner associated with the authenticated user.
1487
+ # @param [String] asset_id
1488
+ # The *assetId* parameter specifies the YouTube asset ID for which you are
1489
+ # retrieving ownership data.
1490
+ # @param [String] on_behalf_of_content_owner
1491
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1492
+ # user is acting on behalf of. This parameter supports users whose accounts are
1493
+ # associated with multiple content owners.
1494
+ # @param [String] fields
1495
+ # Selector specifying which fields to include in a partial response.
1496
+ # @param [String] quota_user
1497
+ # Available to use for quota purposes for server-side applications. Can be any
1498
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1499
+ # @param [Google::Apis::RequestOptions] options
1500
+ # Request-specific options
1501
+ #
1502
+ # @yield [result, err] Result & error if block supplied
1503
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object
1504
+ # @yieldparam err [StandardError] error object if request failed
1505
+ #
1506
+ # @return [Google::Apis::YoutubePartnerV1::RightsOwnership]
1507
+ #
1508
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1509
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1510
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1511
+ def get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1512
+ command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/ownership', options)
1513
+ command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
1514
+ command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
1515
+ command.params['assetId'] = asset_id unless asset_id.nil?
1516
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1517
+ command.query['fields'] = fields unless fields.nil?
1518
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1519
+ execute_or_queue_command(command, &block)
1520
+ end
1521
+
1522
+ # Provides new ownership information for the specified asset. Note that YouTube
1523
+ # may receive ownership information from multiple sources. For example, if an
1524
+ # asset has multiple owners, each owner might send ownership data for the asset.
1525
+ # YouTube algorithmically combines the ownership data received from all of those
1526
+ # sources to generate the asset's canonical ownership data, which should provide
1527
+ # the most comprehensive and accurate representation of the asset's ownership.
1528
+ # @param [String] asset_id
1529
+ # The *assetId* parameter specifies the YouTube asset ID of the asset being
1530
+ # updated.
1531
+ # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object
1532
+ # @param [String] on_behalf_of_content_owner
1533
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1534
+ # user is acting on behalf of. This parameter supports users whose accounts are
1535
+ # associated with multiple content owners.
1536
+ # @param [String] fields
1537
+ # Selector specifying which fields to include in a partial response.
1538
+ # @param [String] quota_user
1539
+ # Available to use for quota purposes for server-side applications. Can be any
1540
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1541
+ # @param [Google::Apis::RequestOptions] options
1542
+ # Request-specific options
1543
+ #
1544
+ # @yield [result, err] Result & error if block supplied
1545
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object
1546
+ # @yieldparam err [StandardError] error object if request failed
1547
+ #
1548
+ # @return [Google::Apis::YoutubePartnerV1::RightsOwnership]
1549
+ #
1550
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1551
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1552
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1553
+ def patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1554
+ command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/ownership', options)
1555
+ command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
1556
+ command.request_object = rights_ownership_object
1557
+ command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
1558
+ command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
1559
+ command.params['assetId'] = asset_id unless asset_id.nil?
1560
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1561
+ command.query['fields'] = fields unless fields.nil?
1562
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1563
+ execute_or_queue_command(command, &block)
1564
+ end
1565
+
1566
+ # Provides new ownership information for the specified asset. Note that YouTube
1567
+ # may receive ownership information from multiple sources. For example, if an
1568
+ # asset has multiple owners, each owner might send ownership data for the asset.
1569
+ # YouTube algorithmically combines the ownership data received from all of those
1570
+ # sources to generate the asset's canonical ownership data, which should provide
1571
+ # the most comprehensive and accurate representation of the asset's ownership.
1572
+ # @param [String] asset_id
1573
+ # The *assetId* parameter specifies the YouTube asset ID of the asset being
1574
+ # updated.
1575
+ # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object
1576
+ # @param [String] on_behalf_of_content_owner
1577
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1578
+ # user is acting on behalf of. This parameter supports users whose accounts are
1579
+ # associated with multiple content owners.
1580
+ # @param [String] fields
1581
+ # Selector specifying which fields to include in a partial response.
1582
+ # @param [String] quota_user
1583
+ # Available to use for quota purposes for server-side applications. Can be any
1584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1585
+ # @param [Google::Apis::RequestOptions] options
1586
+ # Request-specific options
1587
+ #
1588
+ # @yield [result, err] Result & error if block supplied
1589
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object
1590
+ # @yieldparam err [StandardError] error object if request failed
1591
+ #
1592
+ # @return [Google::Apis::YoutubePartnerV1::RightsOwnership]
1593
+ #
1594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1597
+ def update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1598
+ command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/ownership', options)
1599
+ command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
1600
+ command.request_object = rights_ownership_object
1601
+ command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation
1602
+ command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership
1603
+ command.params['assetId'] = asset_id unless asset_id.nil?
1604
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1605
+ command.query['fields'] = fields unless fields.nil?
1606
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1607
+ execute_or_queue_command(command, &block)
1608
+ end
1609
+
1610
+ # Retrieves a list of the ownership data for an asset, regardless of which
1611
+ # content owner provided the data. The list only includes the most recent
1612
+ # ownership data for each content owner. However, if the content owner has
1613
+ # submitted ownership data through multiple data sources (API, content feeds,
1614
+ # etc.), the list will contain the most recent data for each content owner and
1615
+ # data source.
1616
+ # @param [String] asset_id
1617
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
1618
+ # you are retrieving an ownership data history.
1619
+ # @param [String] on_behalf_of_content_owner
1620
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1621
+ # user is acting on behalf of. This parameter supports users whose accounts are
1622
+ # associated with multiple content owners.
1623
+ # @param [String] fields
1624
+ # Selector specifying which fields to include in a partial response.
1625
+ # @param [String] quota_user
1626
+ # Available to use for quota purposes for server-side applications. Can be any
1627
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1628
+ # @param [Google::Apis::RequestOptions] options
1629
+ # Request-specific options
1630
+ #
1631
+ # @yield [result, err] Result & error if block supplied
1632
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse] parsed result object
1633
+ # @yieldparam err [StandardError] error object if request failed
1634
+ #
1635
+ # @return [Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse]
1636
+ #
1637
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1638
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1639
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1640
+ def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1641
+ command = make_simple_command(:get, 'youtube/partner/v1/ownershipHistory', options)
1642
+ command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation
1643
+ command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse
1644
+ command.query['assetId'] = asset_id unless asset_id.nil?
1645
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1646
+ command.query['fields'] = fields unless fields.nil?
1647
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1648
+ execute_or_queue_command(command, &block)
1649
+ end
1650
+
1651
+ # Retrieves information for the specified package.
1652
+ # @param [String] package_id
1653
+ # The *packageId* parameter specifies the Content Delivery package ID of the
1654
+ # package being retrieved.
1655
+ # @param [String] on_behalf_of_content_owner
1656
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1657
+ # user is acting on behalf of. This parameter supports users whose accounts are
1658
+ # associated with multiple content owners.
1659
+ # @param [String] fields
1660
+ # Selector specifying which fields to include in a partial response.
1661
+ # @param [String] quota_user
1662
+ # Available to use for quota purposes for server-side applications. Can be any
1663
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1664
+ # @param [Google::Apis::RequestOptions] options
1665
+ # Request-specific options
1666
+ #
1667
+ # @yield [result, err] Result & error if block supplied
1668
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Package] parsed result object
1669
+ # @yieldparam err [StandardError] error object if request failed
1670
+ #
1671
+ # @return [Google::Apis::YoutubePartnerV1::Package]
1672
+ #
1673
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1674
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1675
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1676
+ def get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1677
+ command = make_simple_command(:get, 'youtube/partner/v1/package/{packageId}', options)
1678
+ command.response_representation = Google::Apis::YoutubePartnerV1::Package::Representation
1679
+ command.response_class = Google::Apis::YoutubePartnerV1::Package
1680
+ command.params['packageId'] = package_id unless package_id.nil?
1681
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1682
+ command.query['fields'] = fields unless fields.nil?
1683
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1684
+ execute_or_queue_command(command, &block)
1685
+ end
1686
+
1687
+ # Inserts a metadata-only package.
1688
+ # @param [Google::Apis::YoutubePartnerV1::Package] package_object
1689
+ # @param [String] on_behalf_of_content_owner
1690
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1691
+ # user is acting on behalf of. This parameter supports users whose accounts are
1692
+ # associated with multiple content owners.
1693
+ # @param [String] fields
1694
+ # Selector specifying which fields to include in a partial response.
1695
+ # @param [String] quota_user
1696
+ # Available to use for quota purposes for server-side applications. Can be any
1697
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1698
+ # @param [Google::Apis::RequestOptions] options
1699
+ # Request-specific options
1700
+ #
1701
+ # @yield [result, err] Result & error if block supplied
1702
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::PackageInsertResponse] parsed result object
1703
+ # @yieldparam err [StandardError] error object if request failed
1704
+ #
1705
+ # @return [Google::Apis::YoutubePartnerV1::PackageInsertResponse]
1706
+ #
1707
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1708
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1709
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1710
+ def insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1711
+ command = make_simple_command(:post, 'youtube/partner/v1/package', options)
1712
+ command.request_representation = Google::Apis::YoutubePartnerV1::Package::Representation
1713
+ command.request_object = package_object
1714
+ command.response_representation = Google::Apis::YoutubePartnerV1::PackageInsertResponse::Representation
1715
+ command.response_class = Google::Apis::YoutubePartnerV1::PackageInsertResponse
1716
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1717
+ command.query['fields'] = fields unless fields.nil?
1718
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1719
+ execute_or_queue_command(command, &block)
1720
+ end
1721
+
1722
+ # Retrieves the specified saved policy.
1723
+ # @param [String] policy_id
1724
+ # The *policyId* parameter specifies a value that uniquely identifies the policy
1725
+ # being retrieved.
1726
+ # @param [String] on_behalf_of_content_owner
1727
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1728
+ # user is acting on behalf of. This parameter supports users whose accounts are
1729
+ # associated with multiple content owners.
1730
+ # @param [String] fields
1731
+ # Selector specifying which fields to include in a partial response.
1732
+ # @param [String] quota_user
1733
+ # Available to use for quota purposes for server-side applications. Can be any
1734
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1735
+ # @param [Google::Apis::RequestOptions] options
1736
+ # Request-specific options
1737
+ #
1738
+ # @yield [result, err] Result & error if block supplied
1739
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object
1740
+ # @yieldparam err [StandardError] error object if request failed
1741
+ #
1742
+ # @return [Google::Apis::YoutubePartnerV1::Policy]
1743
+ #
1744
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1745
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1746
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1747
+ def get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1748
+ command = make_simple_command(:get, 'youtube/partner/v1/policies/{policyId}', options)
1749
+ command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1750
+ command.response_class = Google::Apis::YoutubePartnerV1::Policy
1751
+ command.params['policyId'] = policy_id unless policy_id.nil?
1752
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1753
+ command.query['fields'] = fields unless fields.nil?
1754
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1755
+ execute_or_queue_command(command, &block)
1756
+ end
1757
+
1758
+ # Creates a saved policy.
1759
+ # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object
1760
+ # @param [String] on_behalf_of_content_owner
1761
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1762
+ # user is acting on behalf of. This parameter supports users whose accounts are
1763
+ # associated with multiple content owners.
1764
+ # @param [String] fields
1765
+ # Selector specifying which fields to include in a partial response.
1766
+ # @param [String] quota_user
1767
+ # Available to use for quota purposes for server-side applications. Can be any
1768
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1769
+ # @param [Google::Apis::RequestOptions] options
1770
+ # Request-specific options
1771
+ #
1772
+ # @yield [result, err] Result & error if block supplied
1773
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object
1774
+ # @yieldparam err [StandardError] error object if request failed
1775
+ #
1776
+ # @return [Google::Apis::YoutubePartnerV1::Policy]
1777
+ #
1778
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1779
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1780
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1781
+ def insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1782
+ command = make_simple_command(:post, 'youtube/partner/v1/policies', options)
1783
+ command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1784
+ command.request_object = policy_object
1785
+ command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1786
+ command.response_class = Google::Apis::YoutubePartnerV1::Policy
1787
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1788
+ command.query['fields'] = fields unless fields.nil?
1789
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1790
+ execute_or_queue_command(command, &block)
1791
+ end
1792
+
1793
+ # Retrieves a list of the content owner's saved policies.
1794
+ # @param [String] id
1795
+ # The *id* parameter specifies a comma-separated list of saved policy IDs to
1796
+ # retrieve. Only policies belonging to the currently authenticated content owner
1797
+ # will be available.
1798
+ # @param [String] on_behalf_of_content_owner
1799
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1800
+ # user is acting on behalf of. This parameter supports users whose accounts are
1801
+ # associated with multiple content owners.
1802
+ # @param [String] sort
1803
+ # The *sort* parameter specifies how the search results should be sorted.
1804
+ # @param [String] fields
1805
+ # Selector specifying which fields to include in a partial response.
1806
+ # @param [String] quota_user
1807
+ # Available to use for quota purposes for server-side applications. Can be any
1808
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1809
+ # @param [Google::Apis::RequestOptions] options
1810
+ # Request-specific options
1811
+ #
1812
+ # @yield [result, err] Result & error if block supplied
1813
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::PolicyList] parsed result object
1814
+ # @yieldparam err [StandardError] error object if request failed
1815
+ #
1816
+ # @return [Google::Apis::YoutubePartnerV1::PolicyList]
1817
+ #
1818
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1819
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1820
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1821
+ def list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, options: nil, &block)
1822
+ command = make_simple_command(:get, 'youtube/partner/v1/policies', options)
1823
+ command.response_representation = Google::Apis::YoutubePartnerV1::PolicyList::Representation
1824
+ command.response_class = Google::Apis::YoutubePartnerV1::PolicyList
1825
+ command.query['id'] = id unless id.nil?
1826
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1827
+ command.query['sort'] = sort unless sort.nil?
1828
+ command.query['fields'] = fields unless fields.nil?
1829
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1830
+ execute_or_queue_command(command, &block)
1831
+ end
1832
+
1833
+ # Patches the specified saved policy.
1834
+ # @param [String] policy_id
1835
+ # The *policyId* parameter specifies a value that uniquely identifies the policy
1836
+ # being updated.
1837
+ # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object
1838
+ # @param [String] on_behalf_of_content_owner
1839
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1840
+ # user is acting on behalf of. This parameter supports users whose accounts are
1841
+ # associated with multiple content owners.
1842
+ # @param [String] fields
1843
+ # Selector specifying which fields to include in a partial response.
1844
+ # @param [String] quota_user
1845
+ # Available to use for quota purposes for server-side applications. Can be any
1846
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1847
+ # @param [Google::Apis::RequestOptions] options
1848
+ # Request-specific options
1849
+ #
1850
+ # @yield [result, err] Result & error if block supplied
1851
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object
1852
+ # @yieldparam err [StandardError] error object if request failed
1853
+ #
1854
+ # @return [Google::Apis::YoutubePartnerV1::Policy]
1855
+ #
1856
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1857
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1858
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1859
+ def patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1860
+ command = make_simple_command(:patch, 'youtube/partner/v1/policies/{policyId}', options)
1861
+ command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1862
+ command.request_object = policy_object
1863
+ command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1864
+ command.response_class = Google::Apis::YoutubePartnerV1::Policy
1865
+ command.params['policyId'] = policy_id unless policy_id.nil?
1866
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1867
+ command.query['fields'] = fields unless fields.nil?
1868
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1869
+ execute_or_queue_command(command, &block)
1870
+ end
1871
+
1872
+ # Updates the specified saved policy.
1873
+ # @param [String] policy_id
1874
+ # The *policyId* parameter specifies a value that uniquely identifies the policy
1875
+ # being updated.
1876
+ # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object
1877
+ # @param [String] on_behalf_of_content_owner
1878
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1879
+ # user is acting on behalf of. This parameter supports users whose accounts are
1880
+ # associated with multiple content owners.
1881
+ # @param [String] fields
1882
+ # Selector specifying which fields to include in a partial response.
1883
+ # @param [String] quota_user
1884
+ # Available to use for quota purposes for server-side applications. Can be any
1885
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1886
+ # @param [Google::Apis::RequestOptions] options
1887
+ # Request-specific options
1888
+ #
1889
+ # @yield [result, err] Result & error if block supplied
1890
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object
1891
+ # @yieldparam err [StandardError] error object if request failed
1892
+ #
1893
+ # @return [Google::Apis::YoutubePartnerV1::Policy]
1894
+ #
1895
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1896
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1897
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1898
+ def update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1899
+ command = make_simple_command(:put, 'youtube/partner/v1/policies/{policyId}', options)
1900
+ command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1901
+ command.request_object = policy_object
1902
+ command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation
1903
+ command.response_class = Google::Apis::YoutubePartnerV1::Policy
1904
+ command.params['policyId'] = policy_id unless policy_id.nil?
1905
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1906
+ command.query['fields'] = fields unless fields.nil?
1907
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1908
+ execute_or_queue_command(command, &block)
1909
+ end
1910
+
1911
+ # Retrieves information about the specified reference conflict.
1912
+ # @param [String] reference_conflict_id
1913
+ # The *referenceConflictId* parameter specifies the YouTube reference conflict
1914
+ # ID of the reference conflict being retrieved.
1915
+ # @param [String] on_behalf_of_content_owner
1916
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1917
+ # user is acting on behalf of. This parameter supports users whose accounts are
1918
+ # associated with multiple content owners.
1919
+ # @param [String] fields
1920
+ # Selector specifying which fields to include in a partial response.
1921
+ # @param [String] quota_user
1922
+ # Available to use for quota purposes for server-side applications. Can be any
1923
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1924
+ # @param [Google::Apis::RequestOptions] options
1925
+ # Request-specific options
1926
+ #
1927
+ # @yield [result, err] Result & error if block supplied
1928
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceConflict] parsed result object
1929
+ # @yieldparam err [StandardError] error object if request failed
1930
+ #
1931
+ # @return [Google::Apis::YoutubePartnerV1::ReferenceConflict]
1932
+ #
1933
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1934
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1935
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1936
+ def get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
1937
+ command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts/{referenceConflictId}', options)
1938
+ command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflict::Representation
1939
+ command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflict
1940
+ command.params['referenceConflictId'] = reference_conflict_id unless reference_conflict_id.nil?
1941
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1942
+ command.query['fields'] = fields unless fields.nil?
1943
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1944
+ execute_or_queue_command(command, &block)
1945
+ end
1946
+
1947
+ # Retrieves a list of unresolved reference conflicts.
1948
+ # @param [String] on_behalf_of_content_owner
1949
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1950
+ # user is acting on behalf of. This parameter supports users whose accounts are
1951
+ # associated with multiple content owners.
1952
+ # @param [String] page_token
1953
+ # The *pageToken* parameter specifies a token that identifies a particular page
1954
+ # of results to return. Set this parameter to the value of the nextPageToken
1955
+ # value from the previous API response to retrieve the next page of search
1956
+ # results.
1957
+ # @param [String] fields
1958
+ # Selector specifying which fields to include in a partial response.
1959
+ # @param [String] quota_user
1960
+ # Available to use for quota purposes for server-side applications. Can be any
1961
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1962
+ # @param [Google::Apis::RequestOptions] options
1963
+ # Request-specific options
1964
+ #
1965
+ # @yield [result, err] Result & error if block supplied
1966
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse] parsed result object
1967
+ # @yieldparam err [StandardError] error object if request failed
1968
+ #
1969
+ # @return [Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse]
1970
+ #
1971
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1972
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1973
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1974
+ def list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1975
+ command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts', options)
1976
+ command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse::Representation
1977
+ command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse
1978
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
1979
+ command.query['pageToken'] = page_token unless page_token.nil?
1980
+ command.query['fields'] = fields unless fields.nil?
1981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1982
+ execute_or_queue_command(command, &block)
1983
+ end
1984
+
1985
+ # Retrieves information about the specified reference.
1986
+ # @param [String] reference_id
1987
+ # The *referenceId* parameter specifies the YouTube reference ID of the
1988
+ # reference being retrieved.
1989
+ # @param [String] on_behalf_of_content_owner
1990
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
1991
+ # user is acting on behalf of. This parameter supports users whose accounts are
1992
+ # associated with multiple content owners.
1993
+ # @param [String] fields
1994
+ # Selector specifying which fields to include in a partial response.
1995
+ # @param [String] quota_user
1996
+ # Available to use for quota purposes for server-side applications. Can be any
1997
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1998
+ # @param [Google::Apis::RequestOptions] options
1999
+ # Request-specific options
2000
+ #
2001
+ # @yield [result, err] Result & error if block supplied
2002
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object
2003
+ # @yieldparam err [StandardError] error object if request failed
2004
+ #
2005
+ # @return [Google::Apis::YoutubePartnerV1::Reference]
2006
+ #
2007
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2008
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2009
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2010
+ def get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2011
+ command = make_simple_command(:get, 'youtube/partner/v1/references/{referenceId}', options)
2012
+ command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2013
+ command.response_class = Google::Apis::YoutubePartnerV1::Reference
2014
+ command.params['referenceId'] = reference_id unless reference_id.nil?
2015
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2016
+ command.query['fields'] = fields unless fields.nil?
2017
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2018
+ execute_or_queue_command(command, &block)
2019
+ end
2020
+
2021
+ # Creates a reference in one of the following ways: - If your request is
2022
+ # uploading a reference file, YouTube creates the reference from the provided
2023
+ # content. You can provide either a video/audio file or a pre-generated
2024
+ # fingerprint. If you are providing a pre-generated fingerprint, set the
2025
+ # reference resource's fpDirect property to true in the request body. In this
2026
+ # flow, you can use either the multipart or resumable upload flows to provide
2027
+ # the reference content. - If you want to create a reference using a claimed
2028
+ # video as the reference content, use the claimId parameter to identify the
2029
+ # claim.
2030
+ # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object
2031
+ # @param [String] claim_id
2032
+ # The *claimId* parameter specifies the YouTube claim ID of an existing claim
2033
+ # from which a reference should be created. (The claimed video is used as the
2034
+ # reference content.)
2035
+ # @param [String] on_behalf_of_content_owner
2036
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2037
+ # user is acting on behalf of. This parameter supports users whose accounts are
2038
+ # associated with multiple content owners.
2039
+ # @param [String] fields
2040
+ # Selector specifying which fields to include in a partial response.
2041
+ # @param [String] quota_user
2042
+ # Available to use for quota purposes for server-side applications. Can be any
2043
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2044
+ # @param [IO, String] upload_source
2045
+ # IO stream or filename containing content to upload
2046
+ # @param [String] content_type
2047
+ # Content type of the uploaded content.
2048
+ # @param [Google::Apis::RequestOptions] options
2049
+ # Request-specific options
2050
+ #
2051
+ # @yield [result, err] Result & error if block supplied
2052
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object
2053
+ # @yieldparam err [StandardError] error object if request failed
2054
+ #
2055
+ # @return [Google::Apis::YoutubePartnerV1::Reference]
2056
+ #
2057
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2058
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2059
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2060
+ def insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
2061
+ if upload_source.nil?
2062
+ command = make_simple_command(:post, 'youtube/partner/v1/references', options)
2063
+ else
2064
+ command = make_upload_command(:post, 'youtube/partner/v1/references', options)
2065
+ command.upload_source = upload_source
2066
+ command.upload_content_type = content_type
2067
+ end
2068
+ command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2069
+ command.request_object = reference_object
2070
+ command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2071
+ command.response_class = Google::Apis::YoutubePartnerV1::Reference
2072
+ command.query['claimId'] = claim_id unless claim_id.nil?
2073
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2074
+ command.query['fields'] = fields unless fields.nil?
2075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2076
+ execute_or_queue_command(command, &block)
2077
+ end
2078
+
2079
+ # Retrieves a list of references by ID or the list of references for the
2080
+ # specified asset.
2081
+ # @param [String] asset_id
2082
+ # The *assetId* parameter specifies the YouTube asset ID of the asset for which
2083
+ # you are retrieving references.
2084
+ # @param [String] id
2085
+ # The *id* parameter specifies a comma-separated list of YouTube reference IDs
2086
+ # to retrieve.
2087
+ # @param [String] on_behalf_of_content_owner
2088
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2089
+ # user is acting on behalf of. This parameter supports users whose accounts are
2090
+ # associated with multiple content owners.
2091
+ # @param [String] page_token
2092
+ # The *pageToken* parameter specifies a token that identifies a particular page
2093
+ # of results to return. Set this parameter to the value of the nextPageToken
2094
+ # value from the previous API response to retrieve the next page of search
2095
+ # results.
2096
+ # @param [String] fields
2097
+ # Selector specifying which fields to include in a partial response.
2098
+ # @param [String] quota_user
2099
+ # Available to use for quota purposes for server-side applications. Can be any
2100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2101
+ # @param [Google::Apis::RequestOptions] options
2102
+ # Request-specific options
2103
+ #
2104
+ # @yield [result, err] Result & error if block supplied
2105
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceListResponse] parsed result object
2106
+ # @yieldparam err [StandardError] error object if request failed
2107
+ #
2108
+ # @return [Google::Apis::YoutubePartnerV1::ReferenceListResponse]
2109
+ #
2110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2113
+ def list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2114
+ command = make_simple_command(:get, 'youtube/partner/v1/references', options)
2115
+ command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceListResponse::Representation
2116
+ command.response_class = Google::Apis::YoutubePartnerV1::ReferenceListResponse
2117
+ command.query['assetId'] = asset_id unless asset_id.nil?
2118
+ command.query['id'] = id unless id.nil?
2119
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2120
+ command.query['pageToken'] = page_token unless page_token.nil?
2121
+ command.query['fields'] = fields unless fields.nil?
2122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2123
+ execute_or_queue_command(command, &block)
2124
+ end
2125
+
2126
+ # Patches a reference.
2127
+ # @param [String] reference_id
2128
+ # The *referenceId* parameter specifies the YouTube reference ID of the
2129
+ # reference being updated.
2130
+ # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object
2131
+ # @param [String] on_behalf_of_content_owner
2132
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2133
+ # user is acting on behalf of. This parameter supports users whose accounts are
2134
+ # associated with multiple content owners.
2135
+ # @param [Boolean] release_claims
2136
+ # The *releaseClaims* parameter indicates that you want to release all match
2137
+ # claims associated with this reference. This parameter only works when the
2138
+ # claim's status is being updated to 'inactive' - you can then set the parameter'
2139
+ # s value to true to release all match claims produced by this reference.
2140
+ # @param [String] fields
2141
+ # Selector specifying which fields to include in a partial response.
2142
+ # @param [String] quota_user
2143
+ # Available to use for quota purposes for server-side applications. Can be any
2144
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2145
+ # @param [Google::Apis::RequestOptions] options
2146
+ # Request-specific options
2147
+ #
2148
+ # @yield [result, err] Result & error if block supplied
2149
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object
2150
+ # @yieldparam err [StandardError] error object if request failed
2151
+ #
2152
+ # @return [Google::Apis::YoutubePartnerV1::Reference]
2153
+ #
2154
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2155
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2156
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2157
+ def patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block)
2158
+ command = make_simple_command(:patch, 'youtube/partner/v1/references/{referenceId}', options)
2159
+ command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2160
+ command.request_object = reference_object
2161
+ command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2162
+ command.response_class = Google::Apis::YoutubePartnerV1::Reference
2163
+ command.params['referenceId'] = reference_id unless reference_id.nil?
2164
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2165
+ command.query['releaseClaims'] = release_claims unless release_claims.nil?
2166
+ command.query['fields'] = fields unless fields.nil?
2167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2168
+ execute_or_queue_command(command, &block)
2169
+ end
2170
+
2171
+ # Updates a reference.
2172
+ # @param [String] reference_id
2173
+ # The *referenceId* parameter specifies the YouTube reference ID of the
2174
+ # reference being updated.
2175
+ # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object
2176
+ # @param [String] on_behalf_of_content_owner
2177
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2178
+ # user is acting on behalf of. This parameter supports users whose accounts are
2179
+ # associated with multiple content owners.
2180
+ # @param [Boolean] release_claims
2181
+ # The *releaseClaims* parameter indicates that you want to release all match
2182
+ # claims associated with this reference. This parameter only works when the
2183
+ # claim's status is being updated to 'inactive' - you can then set the parameter'
2184
+ # s value to true to release all match claims produced by this reference.
2185
+ # @param [String] fields
2186
+ # Selector specifying which fields to include in a partial response.
2187
+ # @param [String] quota_user
2188
+ # Available to use for quota purposes for server-side applications. Can be any
2189
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2190
+ # @param [Google::Apis::RequestOptions] options
2191
+ # Request-specific options
2192
+ #
2193
+ # @yield [result, err] Result & error if block supplied
2194
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object
2195
+ # @yieldparam err [StandardError] error object if request failed
2196
+ #
2197
+ # @return [Google::Apis::YoutubePartnerV1::Reference]
2198
+ #
2199
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2200
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2201
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2202
+ def update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block)
2203
+ command = make_simple_command(:put, 'youtube/partner/v1/references/{referenceId}', options)
2204
+ command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2205
+ command.request_object = reference_object
2206
+ command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation
2207
+ command.response_class = Google::Apis::YoutubePartnerV1::Reference
2208
+ command.params['referenceId'] = reference_id unless reference_id.nil?
2209
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2210
+ command.query['releaseClaims'] = release_claims unless release_claims.nil?
2211
+ command.query['fields'] = fields unless fields.nil?
2212
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2213
+ execute_or_queue_command(command, &block)
2214
+ end
2215
+
2216
+ # Retrieves a list of spreadsheet templates for a content owner.
2217
+ # @param [String] locale
2218
+ # The *locale* parameter identifies the desired language for templates in the
2219
+ # API response. The value is a string that contains a BCP-47 language code. The
2220
+ # default value is en.
2221
+ # @param [String] on_behalf_of_content_owner
2222
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2223
+ # user is acting on behalf of. This parameter supports users whose accounts are
2224
+ # associated with multiple content owners.
2225
+ # @param [String] fields
2226
+ # Selector specifying which fields to include in a partial response.
2227
+ # @param [String] quota_user
2228
+ # Available to use for quota purposes for server-side applications. Can be any
2229
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2230
+ # @param [Google::Apis::RequestOptions] options
2231
+ # Request-specific options
2232
+ #
2233
+ # @yield [result, err] Result & error if block supplied
2234
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse] parsed result object
2235
+ # @yieldparam err [StandardError] error object if request failed
2236
+ #
2237
+ # @return [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse]
2238
+ #
2239
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2240
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2241
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2242
+ def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2243
+ command = make_simple_command(:get, 'youtube/partner/v1/spreadsheetTemplate', options)
2244
+ command.response_representation = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse::Representation
2245
+ command.response_class = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse
2246
+ command.query['locale'] = locale unless locale.nil?
2247
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2248
+ command.query['fields'] = fields unless fields.nil?
2249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2250
+ execute_or_queue_command(command, &block)
2251
+ end
2252
+
2253
+ # Retrieves a list of uploaders for a content owner.
2254
+ # @param [String] on_behalf_of_content_owner
2255
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2256
+ # user is acting on behalf of. This parameter supports users whose accounts are
2257
+ # associated with multiple content owners.
2258
+ # @param [String] fields
2259
+ # Selector specifying which fields to include in a partial response.
2260
+ # @param [String] quota_user
2261
+ # Available to use for quota purposes for server-side applications. Can be any
2262
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2263
+ # @param [Google::Apis::RequestOptions] options
2264
+ # Request-specific options
2265
+ #
2266
+ # @yield [result, err] Result & error if block supplied
2267
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::UploaderListResponse] parsed result object
2268
+ # @yieldparam err [StandardError] error object if request failed
2269
+ #
2270
+ # @return [Google::Apis::YoutubePartnerV1::UploaderListResponse]
2271
+ #
2272
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2273
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2274
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2275
+ def list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2276
+ command = make_simple_command(:get, 'youtube/partner/v1/uploader', options)
2277
+ command.response_representation = Google::Apis::YoutubePartnerV1::UploaderListResponse::Representation
2278
+ command.response_class = Google::Apis::YoutubePartnerV1::UploaderListResponse
2279
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2280
+ command.query['fields'] = fields unless fields.nil?
2281
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2282
+ execute_or_queue_command(command, &block)
2283
+ end
2284
+
2285
+ # Validate a metadata file.
2286
+ # @param [Google::Apis::YoutubePartnerV1::ValidateRequest] validate_request_object
2287
+ # @param [String] on_behalf_of_content_owner
2288
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2289
+ # user is acting on behalf of. This parameter supports users whose accounts are
2290
+ # associated with multiple content owners.
2291
+ # @param [String] fields
2292
+ # Selector specifying which fields to include in a partial response.
2293
+ # @param [String] quota_user
2294
+ # Available to use for quota purposes for server-side applications. Can be any
2295
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2296
+ # @param [Google::Apis::RequestOptions] options
2297
+ # Request-specific options
2298
+ #
2299
+ # @yield [result, err] Result & error if block supplied
2300
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateResponse] parsed result object
2301
+ # @yieldparam err [StandardError] error object if request failed
2302
+ #
2303
+ # @return [Google::Apis::YoutubePartnerV1::ValidateResponse]
2304
+ #
2305
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2306
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2307
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2308
+ def validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2309
+ command = make_simple_command(:post, 'youtube/partner/v1/validator', options)
2310
+ command.request_representation = Google::Apis::YoutubePartnerV1::ValidateRequest::Representation
2311
+ command.request_object = validate_request_object
2312
+ command.response_representation = Google::Apis::YoutubePartnerV1::ValidateResponse::Representation
2313
+ command.response_class = Google::Apis::YoutubePartnerV1::ValidateResponse
2314
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2315
+ command.query['fields'] = fields unless fields.nil?
2316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2317
+ execute_or_queue_command(command, &block)
2318
+ end
2319
+
2320
+ # Validate a metadata file asynchronously.
2321
+ # @param [Google::Apis::YoutubePartnerV1::ValidateAsyncRequest] validate_async_request_object
2322
+ # @param [String] on_behalf_of_content_owner
2323
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2324
+ # user is acting on behalf of. This parameter supports users whose accounts are
2325
+ # associated with multiple content owners.
2326
+ # @param [String] fields
2327
+ # Selector specifying which fields to include in a partial response.
2328
+ # @param [String] quota_user
2329
+ # Available to use for quota purposes for server-side applications. Can be any
2330
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2331
+ # @param [Google::Apis::RequestOptions] options
2332
+ # Request-specific options
2333
+ #
2334
+ # @yield [result, err] Result & error if block supplied
2335
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateAsyncResponse] parsed result object
2336
+ # @yieldparam err [StandardError] error object if request failed
2337
+ #
2338
+ # @return [Google::Apis::YoutubePartnerV1::ValidateAsyncResponse]
2339
+ #
2340
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2341
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2342
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2343
+ def validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2344
+ command = make_simple_command(:post, 'youtube/partner/v1/validatorAsync', options)
2345
+ command.request_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncRequest::Representation
2346
+ command.request_object = validate_async_request_object
2347
+ command.response_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse::Representation
2348
+ command.response_class = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse
2349
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2350
+ command.query['fields'] = fields unless fields.nil?
2351
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2352
+ execute_or_queue_command(command, &block)
2353
+ end
2354
+
2355
+ # Get the asynchronous validation status.
2356
+ # @param [Google::Apis::YoutubePartnerV1::ValidateStatusRequest] validate_status_request_object
2357
+ # @param [String] on_behalf_of_content_owner
2358
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2359
+ # user is acting on behalf of. This parameter supports users whose accounts are
2360
+ # associated with multiple content owners.
2361
+ # @param [String] fields
2362
+ # Selector specifying which fields to include in a partial response.
2363
+ # @param [String] quota_user
2364
+ # Available to use for quota purposes for server-side applications. Can be any
2365
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2366
+ # @param [Google::Apis::RequestOptions] options
2367
+ # Request-specific options
2368
+ #
2369
+ # @yield [result, err] Result & error if block supplied
2370
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateStatusResponse] parsed result object
2371
+ # @yieldparam err [StandardError] error object if request failed
2372
+ #
2373
+ # @return [Google::Apis::YoutubePartnerV1::ValidateStatusResponse]
2374
+ #
2375
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2376
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2377
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2378
+ def validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2379
+ command = make_simple_command(:post, 'youtube/partner/v1/validatorAsyncStatus', options)
2380
+ command.request_representation = Google::Apis::YoutubePartnerV1::ValidateStatusRequest::Representation
2381
+ command.request_object = validate_status_request_object
2382
+ command.response_representation = Google::Apis::YoutubePartnerV1::ValidateStatusResponse::Representation
2383
+ command.response_class = Google::Apis::YoutubePartnerV1::ValidateStatusResponse
2384
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2385
+ command.query['fields'] = fields unless fields.nil?
2386
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2387
+ execute_or_queue_command(command, &block)
2388
+ end
2389
+
2390
+ # Retrieves advertising settings for the specified video.
2391
+ # @param [String] video_id
2392
+ # The *videoId* parameter specifies the YouTube video ID of the video for which
2393
+ # you are retrieving advertising settings.
2394
+ # @param [String] on_behalf_of_content_owner
2395
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2396
+ # user is acting on behalf of. This parameter supports users whose accounts are
2397
+ # associated with multiple content owners.
2398
+ # @param [String] fields
2399
+ # Selector specifying which fields to include in a partial response.
2400
+ # @param [String] quota_user
2401
+ # Available to use for quota purposes for server-side applications. Can be any
2402
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2403
+ # @param [Google::Apis::RequestOptions] options
2404
+ # Request-specific options
2405
+ #
2406
+ # @yield [result, err] Result & error if block supplied
2407
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object
2408
+ # @yieldparam err [StandardError] error object if request failed
2409
+ #
2410
+ # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption]
2411
+ #
2412
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2413
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2414
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2415
+ def get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2416
+ command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
2417
+ command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
2418
+ command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
2419
+ command.params['videoId'] = video_id unless video_id.nil?
2420
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2421
+ command.query['fields'] = fields unless fields.nil?
2422
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2423
+ execute_or_queue_command(command, &block)
2424
+ end
2425
+
2426
+ # Retrieves details about the types of allowed ads for a specified partner- or
2427
+ # user-uploaded video.
2428
+ # @param [String] video_id
2429
+ # The *videoId* parameter specifies the YouTube video ID of the video for which
2430
+ # you are retrieving advertising options.
2431
+ # @param [String] on_behalf_of_content_owner
2432
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2433
+ # user is acting on behalf of. This parameter supports users whose accounts are
2434
+ # associated with multiple content owners.
2435
+ # @param [String] fields
2436
+ # Selector specifying which fields to include in a partial response.
2437
+ # @param [String] quota_user
2438
+ # Available to use for quota purposes for server-side applications. Can be any
2439
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2440
+ # @param [Google::Apis::RequestOptions] options
2441
+ # Request-specific options
2442
+ #
2443
+ # @yield [result, err] Result & error if block supplied
2444
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse] parsed result object
2445
+ # @yieldparam err [StandardError] error object if request failed
2446
+ #
2447
+ # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse]
2448
+ #
2449
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2450
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2451
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2452
+ def get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2453
+ command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds', options)
2454
+ command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse::Representation
2455
+ command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse
2456
+ command.params['videoId'] = video_id unless video_id.nil?
2457
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2458
+ command.query['fields'] = fields unless fields.nil?
2459
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2460
+ execute_or_queue_command(command, &block)
2461
+ end
2462
+
2463
+ # Patches the advertising settings for the specified video.
2464
+ # @param [String] video_id
2465
+ # The *videoId* parameter specifies the YouTube video ID of the video for which
2466
+ # you are updating advertising settings.
2467
+ # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object
2468
+ # @param [String] on_behalf_of_content_owner
2469
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2470
+ # user is acting on behalf of. This parameter supports users whose accounts are
2471
+ # associated with multiple content owners.
2472
+ # @param [String] fields
2473
+ # Selector specifying which fields to include in a partial response.
2474
+ # @param [String] quota_user
2475
+ # Available to use for quota purposes for server-side applications. Can be any
2476
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2477
+ # @param [Google::Apis::RequestOptions] options
2478
+ # Request-specific options
2479
+ #
2480
+ # @yield [result, err] Result & error if block supplied
2481
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object
2482
+ # @yieldparam err [StandardError] error object if request failed
2483
+ #
2484
+ # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption]
2485
+ #
2486
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2487
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2488
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2489
+ def patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2490
+ command = make_simple_command(:patch, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
2491
+ command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
2492
+ command.request_object = video_advertising_option_object
2493
+ command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
2494
+ command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
2495
+ command.params['videoId'] = video_id unless video_id.nil?
2496
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2497
+ command.query['fields'] = fields unless fields.nil?
2498
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2499
+ execute_or_queue_command(command, &block)
2500
+ end
2501
+
2502
+ # Updates the advertising settings for the specified video.
2503
+ # @param [String] video_id
2504
+ # The *videoId* parameter specifies the YouTube video ID of the video for which
2505
+ # you are updating advertising settings.
2506
+ # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object
2507
+ # @param [String] on_behalf_of_content_owner
2508
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2509
+ # user is acting on behalf of. This parameter supports users whose accounts are
2510
+ # associated with multiple content owners.
2511
+ # @param [String] fields
2512
+ # Selector specifying which fields to include in a partial response.
2513
+ # @param [String] quota_user
2514
+ # Available to use for quota purposes for server-side applications. Can be any
2515
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2516
+ # @param [Google::Apis::RequestOptions] options
2517
+ # Request-specific options
2518
+ #
2519
+ # @yield [result, err] Result & error if block supplied
2520
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object
2521
+ # @yieldparam err [StandardError] error object if request failed
2522
+ #
2523
+ # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption]
2524
+ #
2525
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2526
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2527
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2528
+ def update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2529
+ command = make_simple_command(:put, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options)
2530
+ command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
2531
+ command.request_object = video_advertising_option_object
2532
+ command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation
2533
+ command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption
2534
+ command.params['videoId'] = video_id unless video_id.nil?
2535
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2536
+ command.query['fields'] = fields unless fields.nil?
2537
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2538
+ execute_or_queue_command(command, &block)
2539
+ end
2540
+
2541
+ # Removes a whitelisted channel for a content owner.
2542
+ # @param [String] id
2543
+ # The *id* parameter specifies the YouTube channel ID of the channel being
2544
+ # removed from whitelist.
2545
+ # @param [String] on_behalf_of_content_owner
2546
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2547
+ # user is acting on behalf of. This parameter supports users whose accounts are
2548
+ # associated with multiple content owners.
2549
+ # @param [String] fields
2550
+ # Selector specifying which fields to include in a partial response.
2551
+ # @param [String] quota_user
2552
+ # Available to use for quota purposes for server-side applications. Can be any
2553
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2554
+ # @param [Google::Apis::RequestOptions] options
2555
+ # Request-specific options
2556
+ #
2557
+ # @yield [result, err] Result & error if block supplied
2558
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object
2559
+ # @yieldparam err [StandardError] error object if request failed
2560
+ #
2561
+ # @return [Google::Apis::YoutubePartnerV1::Empty]
2562
+ #
2563
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2564
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2565
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2566
+ def delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2567
+ command = make_simple_command(:delete, 'youtube/partner/v1/whitelists/{id}', options)
2568
+ command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation
2569
+ command.response_class = Google::Apis::YoutubePartnerV1::Empty
2570
+ command.params['id'] = id unless id.nil?
2571
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2572
+ command.query['fields'] = fields unless fields.nil?
2573
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2574
+ execute_or_queue_command(command, &block)
2575
+ end
2576
+
2577
+ # Retrieves a specific whitelisted channel by ID.
2578
+ # @param [String] id
2579
+ # The *id* parameter specifies the YouTube channel ID of the whitelisted channel
2580
+ # being retrieved.
2581
+ # @param [String] on_behalf_of_content_owner
2582
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2583
+ # user is acting on behalf of. This parameter supports users whose accounts are
2584
+ # associated with multiple content owners.
2585
+ # @param [String] fields
2586
+ # Selector specifying which fields to include in a partial response.
2587
+ # @param [String] quota_user
2588
+ # Available to use for quota purposes for server-side applications. Can be any
2589
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2590
+ # @param [Google::Apis::RequestOptions] options
2591
+ # Request-specific options
2592
+ #
2593
+ # @yield [result, err] Result & error if block supplied
2594
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Whitelist] parsed result object
2595
+ # @yieldparam err [StandardError] error object if request failed
2596
+ #
2597
+ # @return [Google::Apis::YoutubePartnerV1::Whitelist]
2598
+ #
2599
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2600
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2601
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2602
+ def get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2603
+ command = make_simple_command(:get, 'youtube/partner/v1/whitelists/{id}', options)
2604
+ command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
2605
+ command.response_class = Google::Apis::YoutubePartnerV1::Whitelist
2606
+ command.params['id'] = id unless id.nil?
2607
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2608
+ command.query['fields'] = fields unless fields.nil?
2609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2610
+ execute_or_queue_command(command, &block)
2611
+ end
2612
+
2613
+ # Whitelist a YouTube channel for your content owner. Whitelisted channels are
2614
+ # channels that are not owned or managed by you, but you would like to whitelist
2615
+ # so that no claims from your assets are placed on videos uploaded to these
2616
+ # channels.
2617
+ # @param [Google::Apis::YoutubePartnerV1::Whitelist] whitelist_object
2618
+ # @param [String] on_behalf_of_content_owner
2619
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2620
+ # user is acting on behalf of. This parameter supports users whose accounts are
2621
+ # associated with multiple content owners.
2622
+ # @param [String] fields
2623
+ # Selector specifying which fields to include in a partial response.
2624
+ # @param [String] quota_user
2625
+ # Available to use for quota purposes for server-side applications. Can be any
2626
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2627
+ # @param [Google::Apis::RequestOptions] options
2628
+ # Request-specific options
2629
+ #
2630
+ # @yield [result, err] Result & error if block supplied
2631
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::Whitelist] parsed result object
2632
+ # @yieldparam err [StandardError] error object if request failed
2633
+ #
2634
+ # @return [Google::Apis::YoutubePartnerV1::Whitelist]
2635
+ #
2636
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2637
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2638
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2639
+ def insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
2640
+ command = make_simple_command(:post, 'youtube/partner/v1/whitelists', options)
2641
+ command.request_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
2642
+ command.request_object = whitelist_object
2643
+ command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation
2644
+ command.response_class = Google::Apis::YoutubePartnerV1::Whitelist
2645
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2646
+ command.query['fields'] = fields unless fields.nil?
2647
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2648
+ execute_or_queue_command(command, &block)
2649
+ end
2650
+
2651
+ # Retrieves a list of whitelisted channels for a content owner.
2652
+ # @param [String] id
2653
+ # The *id* parameter specifies a comma-separated list of YouTube channel IDs
2654
+ # that identify the whitelisted channels you want to retrieve.
2655
+ # @param [String] on_behalf_of_content_owner
2656
+ # The *onBehalfOfContentOwner* parameter identifies the content owner that the
2657
+ # user is acting on behalf of. This parameter supports users whose accounts are
2658
+ # associated with multiple content owners.
2659
+ # @param [String] page_token
2660
+ # The *pageToken* parameter specifies a token that identifies a particular page
2661
+ # of results to return. Set this parameter to the value of the nextPageToken
2662
+ # value from the previous API response to retrieve the next page of results.
2663
+ # @param [String] fields
2664
+ # Selector specifying which fields to include in a partial response.
2665
+ # @param [String] quota_user
2666
+ # Available to use for quota purposes for server-side applications. Can be any
2667
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2668
+ # @param [Google::Apis::RequestOptions] options
2669
+ # Request-specific options
2670
+ #
2671
+ # @yield [result, err] Result & error if block supplied
2672
+ # @yieldparam result [Google::Apis::YoutubePartnerV1::WhitelistListResponse] parsed result object
2673
+ # @yieldparam err [StandardError] error object if request failed
2674
+ #
2675
+ # @return [Google::Apis::YoutubePartnerV1::WhitelistListResponse]
2676
+ #
2677
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2678
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2679
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2680
+ def list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2681
+ command = make_simple_command(:get, 'youtube/partner/v1/whitelists', options)
2682
+ command.response_representation = Google::Apis::YoutubePartnerV1::WhitelistListResponse::Representation
2683
+ command.response_class = Google::Apis::YoutubePartnerV1::WhitelistListResponse
2684
+ command.query['id'] = id unless id.nil?
2685
+ command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2686
+ command.query['pageToken'] = page_token unless page_token.nil?
2687
+ command.query['fields'] = fields unless fields.nil?
2688
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2689
+ execute_or_queue_command(command, &block)
2690
+ end
2691
+
2692
+ protected
2693
+
2694
+ def apply_command_defaults(command)
2695
+ command.query['key'] = key unless key.nil?
2696
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2697
+ end
2698
+ end
2699
+ end
2700
+ end
2701
+ end