google-apis-displayvideo_v4 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -384,6 +384,201 @@ module Google
|
|
|
384
384
|
execute_or_queue_command(command, &block)
|
|
385
385
|
end
|
|
386
386
|
|
|
387
|
+
# BulkCreate video assets for Ad. Only supports youtube video assets for now.
|
|
388
|
+
# @param [Fixnum] advertiser_id
|
|
389
|
+
# Required. The ID of the advertiser this ad asset belongs to.
|
|
390
|
+
# @param [Google::Apis::DisplayvideoV4::BulkCreateAdAssetsRequest] bulk_create_ad_assets_request_object
|
|
391
|
+
# @param [String] fields
|
|
392
|
+
# Selector specifying which fields to include in a partial response.
|
|
393
|
+
# @param [String] quota_user
|
|
394
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
395
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
396
|
+
# @param [Google::Apis::RequestOptions] options
|
|
397
|
+
# Request-specific options
|
|
398
|
+
#
|
|
399
|
+
# @yield [result, err] Result & error if block supplied
|
|
400
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse] parsed result object
|
|
401
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
402
|
+
#
|
|
403
|
+
# @return [Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse]
|
|
404
|
+
#
|
|
405
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
406
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
407
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
408
|
+
def bulk_create_ad_assets(advertiser_id, bulk_create_ad_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
409
|
+
command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:bulkCreate', options)
|
|
410
|
+
command.request_representation = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsRequest::Representation
|
|
411
|
+
command.request_object = bulk_create_ad_assets_request_object
|
|
412
|
+
command.response_representation = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse::Representation
|
|
413
|
+
command.response_class = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse
|
|
414
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
415
|
+
command.query['fields'] = fields unless fields.nil?
|
|
416
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
417
|
+
execute_or_queue_command(command, &block)
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
# Create a video asset for Ad. Only supports youtube video assets for now.
|
|
421
|
+
# @param [Fixnum] advertiser_id
|
|
422
|
+
# Required. The ID of the advertiser this ad asset belongs to.
|
|
423
|
+
# @param [Google::Apis::DisplayvideoV4::CreateAdAssetRequest] create_ad_asset_request_object
|
|
424
|
+
# @param [String] fields
|
|
425
|
+
# Selector specifying which fields to include in a partial response.
|
|
426
|
+
# @param [String] quota_user
|
|
427
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
428
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
429
|
+
# @param [Google::Apis::RequestOptions] options
|
|
430
|
+
# Request-specific options
|
|
431
|
+
#
|
|
432
|
+
# @yield [result, err] Result & error if block supplied
|
|
433
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::AdAsset] parsed result object
|
|
434
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
435
|
+
#
|
|
436
|
+
# @return [Google::Apis::DisplayvideoV4::AdAsset]
|
|
437
|
+
#
|
|
438
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
439
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
440
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
441
|
+
def create_ad_asset(advertiser_id, create_ad_asset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
442
|
+
command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets', options)
|
|
443
|
+
command.request_representation = Google::Apis::DisplayvideoV4::CreateAdAssetRequest::Representation
|
|
444
|
+
command.request_object = create_ad_asset_request_object
|
|
445
|
+
command.response_representation = Google::Apis::DisplayvideoV4::AdAsset::Representation
|
|
446
|
+
command.response_class = Google::Apis::DisplayvideoV4::AdAsset
|
|
447
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
448
|
+
command.query['fields'] = fields unless fields.nil?
|
|
449
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
450
|
+
execute_or_queue_command(command, &block)
|
|
451
|
+
end
|
|
452
|
+
|
|
453
|
+
# Get an ad asset by ad asset ID. Only supports youtube video assets.
|
|
454
|
+
# @param [Fixnum] advertiser_id
|
|
455
|
+
# Required. The ID of the advertiser this ad asset belongs to.
|
|
456
|
+
# @param [Fixnum] ad_asset_id
|
|
457
|
+
# Required. The ID of the ad asset to fetch.
|
|
458
|
+
# @param [String] fields
|
|
459
|
+
# Selector specifying which fields to include in a partial response.
|
|
460
|
+
# @param [String] quota_user
|
|
461
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
462
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
463
|
+
# @param [Google::Apis::RequestOptions] options
|
|
464
|
+
# Request-specific options
|
|
465
|
+
#
|
|
466
|
+
# @yield [result, err] Result & error if block supplied
|
|
467
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::AdAsset] parsed result object
|
|
468
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
469
|
+
#
|
|
470
|
+
# @return [Google::Apis::DisplayvideoV4::AdAsset]
|
|
471
|
+
#
|
|
472
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
473
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
474
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
475
|
+
def get_advertiser_ad_asset(advertiser_id, ad_asset_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
476
|
+
command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}', options)
|
|
477
|
+
command.response_representation = Google::Apis::DisplayvideoV4::AdAsset::Representation
|
|
478
|
+
command.response_class = Google::Apis::DisplayvideoV4::AdAsset
|
|
479
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
480
|
+
command.params['adAssetId'] = ad_asset_id unless ad_asset_id.nil?
|
|
481
|
+
command.query['fields'] = fields unless fields.nil?
|
|
482
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
483
|
+
execute_or_queue_command(command, &block)
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
# List ad assets by advertiser ID. Only supports youtube video ad assets.
|
|
487
|
+
# @param [Fixnum] advertiser_id
|
|
488
|
+
# Required. The ID of the advertiser to list assets for.
|
|
489
|
+
# @param [String] filter
|
|
490
|
+
# Optional. Filter expression to restrict the ad assets to return. The supported
|
|
491
|
+
# fields are: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * `
|
|
492
|
+
# entityStatus=ENTITY_STATUS_ACTIVE`
|
|
493
|
+
# @param [String] order_by
|
|
494
|
+
# Optional. Field by which to sort the list. Acceptable values are: * `
|
|
495
|
+
# entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The
|
|
496
|
+
# default sorting order is ascending. To specify descending order for a field, a
|
|
497
|
+
# suffix "desc" should be added to the field name. Example: `assetId desc`.
|
|
498
|
+
# @param [Fixnum] page_size
|
|
499
|
+
# Optional. Requested page size. Must be between `1` and `5000`. If unspecified
|
|
500
|
+
# will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid
|
|
501
|
+
# value is specified.
|
|
502
|
+
# @param [String] page_token
|
|
503
|
+
# Optional. A token identifying a page of results the server should return.
|
|
504
|
+
# Typically, this is the value of next_page_token returned from the previous
|
|
505
|
+
# call to `ListAssets` method. If not specified, the first page of results will
|
|
506
|
+
# be returned.
|
|
507
|
+
# @param [String] fields
|
|
508
|
+
# Selector specifying which fields to include in a partial response.
|
|
509
|
+
# @param [String] quota_user
|
|
510
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
511
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
512
|
+
# @param [Google::Apis::RequestOptions] options
|
|
513
|
+
# Request-specific options
|
|
514
|
+
#
|
|
515
|
+
# @yield [result, err] Result & error if block supplied
|
|
516
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::ListAdAssetsResponse] parsed result object
|
|
517
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
518
|
+
#
|
|
519
|
+
# @return [Google::Apis::DisplayvideoV4::ListAdAssetsResponse]
|
|
520
|
+
#
|
|
521
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
522
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
523
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
524
|
+
def list_advertiser_ad_assets(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
525
|
+
command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adAssets', options)
|
|
526
|
+
command.response_representation = Google::Apis::DisplayvideoV4::ListAdAssetsResponse::Representation
|
|
527
|
+
command.response_class = Google::Apis::DisplayvideoV4::ListAdAssetsResponse
|
|
528
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
529
|
+
command.query['filter'] = filter unless filter.nil?
|
|
530
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
531
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
532
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
533
|
+
command.query['fields'] = fields unless fields.nil?
|
|
534
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
535
|
+
execute_or_queue_command(command, &block)
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
# Uploads an ad asset. Returns the ID of the newly uploaded ad asset if
|
|
539
|
+
# successful.
|
|
540
|
+
# @param [Fixnum] advertiser_id
|
|
541
|
+
# Required. The ID of the advertiser this ad asset belongs to.
|
|
542
|
+
# @param [Google::Apis::DisplayvideoV4::UploadAdAssetRequest] upload_ad_asset_request_object
|
|
543
|
+
# @param [String] fields
|
|
544
|
+
# Selector specifying which fields to include in a partial response.
|
|
545
|
+
# @param [String] quota_user
|
|
546
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
547
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
548
|
+
# @param [IO, String] upload_source
|
|
549
|
+
# IO stream or filename containing content to upload
|
|
550
|
+
# @param [String] content_type
|
|
551
|
+
# Content type of the uploaded content.
|
|
552
|
+
# @param [Google::Apis::RequestOptions] options
|
|
553
|
+
# Request-specific options
|
|
554
|
+
#
|
|
555
|
+
# @yield [result, err] Result & error if block supplied
|
|
556
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::UploadAdAssetResponse] parsed result object
|
|
557
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
558
|
+
#
|
|
559
|
+
# @return [Google::Apis::DisplayvideoV4::UploadAdAssetResponse]
|
|
560
|
+
#
|
|
561
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
562
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
563
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
564
|
+
def upload_ad_asset(advertiser_id, upload_ad_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
|
565
|
+
if upload_source.nil?
|
|
566
|
+
command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset', options)
|
|
567
|
+
else
|
|
568
|
+
command = make_upload_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset', options)
|
|
569
|
+
command.upload_source = upload_source
|
|
570
|
+
command.upload_content_type = content_type
|
|
571
|
+
end
|
|
572
|
+
command.request_representation = Google::Apis::DisplayvideoV4::UploadAdAssetRequest::Representation
|
|
573
|
+
command.request_object = upload_ad_asset_request_object
|
|
574
|
+
command.response_representation = Google::Apis::DisplayvideoV4::UploadAdAssetResponse::Representation
|
|
575
|
+
command.response_class = Google::Apis::DisplayvideoV4::UploadAdAssetResponse
|
|
576
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
577
|
+
command.query['fields'] = fields unless fields.nil?
|
|
578
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
579
|
+
execute_or_queue_command(command, &block)
|
|
580
|
+
end
|
|
581
|
+
|
|
387
582
|
# Gets an ad group ad.
|
|
388
583
|
# @param [Fixnum] advertiser_id
|
|
389
584
|
# Required. The ID of the advertiser this ad group ad belongs to.
|
|
@@ -757,6 +952,151 @@ module Google
|
|
|
757
952
|
execute_or_queue_command(command, &block)
|
|
758
953
|
end
|
|
759
954
|
|
|
955
|
+
# Creates a new association between an entity (line item or ad group) and a
|
|
956
|
+
# YouTube asset. Returns the newly created association if successful.
|
|
957
|
+
# @param [Fixnum] advertiser_id
|
|
958
|
+
# Required. The ID of the advertiser this request is for.
|
|
959
|
+
# @param [Fixnum] ad_group_id
|
|
960
|
+
# The unique ID of the ad group linked.
|
|
961
|
+
# @param [String] youtube_asset_type
|
|
962
|
+
# Required. The type of the linked YouTube asset in the association.
|
|
963
|
+
# @param [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation] youtube_asset_association_object
|
|
964
|
+
# @param [Fixnum] linked_entity_line_item_id
|
|
965
|
+
# The unique ID of the line item linked.
|
|
966
|
+
# @param [String] fields
|
|
967
|
+
# Selector specifying which fields to include in a partial response.
|
|
968
|
+
# @param [String] quota_user
|
|
969
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
970
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
971
|
+
# @param [Google::Apis::RequestOptions] options
|
|
972
|
+
# Request-specific options
|
|
973
|
+
#
|
|
974
|
+
# @yield [result, err] Result & error if block supplied
|
|
975
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation] parsed result object
|
|
976
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
977
|
+
#
|
|
978
|
+
# @return [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation]
|
|
979
|
+
#
|
|
980
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
981
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
982
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
983
|
+
def create_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
984
|
+
command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
|
|
985
|
+
command.request_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
|
|
986
|
+
command.request_object = youtube_asset_association_object
|
|
987
|
+
command.response_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
|
|
988
|
+
command.response_class = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation
|
|
989
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
990
|
+
command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
|
|
991
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
992
|
+
command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
|
|
993
|
+
command.query['fields'] = fields unless fields.nil?
|
|
994
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
995
|
+
execute_or_queue_command(command, &block)
|
|
996
|
+
end
|
|
997
|
+
|
|
998
|
+
# Deletes an existing association between an entity (line item or ad group) and
|
|
999
|
+
# a YouTube asset.
|
|
1000
|
+
# @param [Fixnum] advertiser_id
|
|
1001
|
+
# Required. The ID of the advertiser this request is for.
|
|
1002
|
+
# @param [Fixnum] ad_group_id
|
|
1003
|
+
# The unique ID of the ad group linked.
|
|
1004
|
+
# @param [String] youtube_asset_type
|
|
1005
|
+
# Required. The YouTube asset type this request is for.
|
|
1006
|
+
# @param [Fixnum] youtube_asset_association_id
|
|
1007
|
+
# Required. The ID of the YouTube asset in the association. For location
|
|
1008
|
+
# associations: This should be the ID of the asset set linked, or 0 if the
|
|
1009
|
+
# association stands for location asset is disabled. For affiliate location
|
|
1010
|
+
# associations: This should be the ID of the asset set linked, or 0 if the
|
|
1011
|
+
# association stands for affiliate location asset is disabled. For sitelink
|
|
1012
|
+
# associations: This should be the ID of the sitelink asset linked.
|
|
1013
|
+
# @param [Fixnum] linked_entity_line_item_id
|
|
1014
|
+
# The unique ID of the line item linked.
|
|
1015
|
+
# @param [String] fields
|
|
1016
|
+
# Selector specifying which fields to include in a partial response.
|
|
1017
|
+
# @param [String] quota_user
|
|
1018
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1019
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1020
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1021
|
+
# Request-specific options
|
|
1022
|
+
#
|
|
1023
|
+
# @yield [result, err] Result & error if block supplied
|
|
1024
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::Empty] parsed result object
|
|
1025
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1026
|
+
#
|
|
1027
|
+
# @return [Google::Apis::DisplayvideoV4::Empty]
|
|
1028
|
+
#
|
|
1029
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1030
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1031
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1032
|
+
def delete_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_id, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1033
|
+
command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}', options)
|
|
1034
|
+
command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
|
|
1035
|
+
command.response_class = Google::Apis::DisplayvideoV4::Empty
|
|
1036
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1037
|
+
command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
|
|
1038
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
1039
|
+
command.params['youtubeAssetAssociationId'] = youtube_asset_association_id unless youtube_asset_association_id.nil?
|
|
1040
|
+
command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
|
|
1041
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1042
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1043
|
+
execute_or_queue_command(command, &block)
|
|
1044
|
+
end
|
|
1045
|
+
|
|
1046
|
+
# Lists the YouTube asset associations for given resource.
|
|
1047
|
+
# @param [Fixnum] advertiser_id
|
|
1048
|
+
# Required. The ID of the advertiser this request is for.
|
|
1049
|
+
# @param [Fixnum] ad_group_id
|
|
1050
|
+
# The unique ID of the ad group linked.
|
|
1051
|
+
# @param [String] youtube_asset_type
|
|
1052
|
+
# Required. The type of YouTube asset in the association.
|
|
1053
|
+
# @param [Fixnum] linked_entity_line_item_id
|
|
1054
|
+
# The unique ID of the line item linked.
|
|
1055
|
+
# @param [String] order_by
|
|
1056
|
+
# Optional. Field by which to sort the list. The only acceptable values are: `
|
|
1057
|
+
# linkedYoutubeAsset.locationAssetFilter.assetSetId`, `linkedYoutubeAsset.
|
|
1058
|
+
# affiliateLocationAssetFilter.assetSetId`, `linkedYoutubeAsset.sitelinkAsset.
|
|
1059
|
+
# assetId` The default sorting order is ascending. To specify descending order
|
|
1060
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
1061
|
+
# linkedYoutubeAsset.sitelinkAsset.assetId desc`.
|
|
1062
|
+
# @param [Fixnum] page_size
|
|
1063
|
+
# Optional. Requested page size. Must be between `1` and `10000`. If unspecified
|
|
1064
|
+
# will default to `100`.
|
|
1065
|
+
# @param [String] page_token
|
|
1066
|
+
# Optional. A token identifying a page of results the server should return.
|
|
1067
|
+
# @param [String] fields
|
|
1068
|
+
# Selector specifying which fields to include in a partial response.
|
|
1069
|
+
# @param [String] quota_user
|
|
1070
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1071
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1072
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1073
|
+
# Request-specific options
|
|
1074
|
+
#
|
|
1075
|
+
# @yield [result, err] Result & error if block supplied
|
|
1076
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse] parsed result object
|
|
1077
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1078
|
+
#
|
|
1079
|
+
# @return [Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse]
|
|
1080
|
+
#
|
|
1081
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1082
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1083
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1084
|
+
def list_advertiser_ad_group_youtube_asset_type_youtube_asset_associations(advertiser_id, ad_group_id, youtube_asset_type, linked_entity_line_item_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1085
|
+
command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
|
|
1086
|
+
command.response_representation = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse::Representation
|
|
1087
|
+
command.response_class = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse
|
|
1088
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
1089
|
+
command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
|
|
1090
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
1091
|
+
command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
|
|
1092
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
1093
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1094
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1095
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1096
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1097
|
+
execute_or_queue_command(command, &block)
|
|
1098
|
+
end
|
|
1099
|
+
|
|
760
1100
|
# Uploads an asset. Returns the ID of the newly uploaded asset if successful.
|
|
761
1101
|
# The asset file size should be no more than 10 MB for images, 200 MB for ZIP
|
|
762
1102
|
# files, and 1 GB for videos. Must be used within the [multipart media upload
|
|
@@ -3213,6 +3553,151 @@ module Google
|
|
|
3213
3553
|
execute_or_queue_command(command, &block)
|
|
3214
3554
|
end
|
|
3215
3555
|
|
|
3556
|
+
# Creates a new association between an entity (line item or ad group) and a
|
|
3557
|
+
# YouTube asset. Returns the newly created association if successful.
|
|
3558
|
+
# @param [Fixnum] advertiser_id
|
|
3559
|
+
# Required. The ID of the advertiser this request is for.
|
|
3560
|
+
# @param [Fixnum] line_item_id
|
|
3561
|
+
# The unique ID of the line item linked.
|
|
3562
|
+
# @param [String] youtube_asset_type
|
|
3563
|
+
# Required. The type of the linked YouTube asset in the association.
|
|
3564
|
+
# @param [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation] youtube_asset_association_object
|
|
3565
|
+
# @param [Fixnum] linked_entity_ad_group_id
|
|
3566
|
+
# The unique ID of the ad group linked.
|
|
3567
|
+
# @param [String] fields
|
|
3568
|
+
# Selector specifying which fields to include in a partial response.
|
|
3569
|
+
# @param [String] quota_user
|
|
3570
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3571
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3572
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3573
|
+
# Request-specific options
|
|
3574
|
+
#
|
|
3575
|
+
# @yield [result, err] Result & error if block supplied
|
|
3576
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation] parsed result object
|
|
3577
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3578
|
+
#
|
|
3579
|
+
# @return [Google::Apis::DisplayvideoV4::YoutubeAssetAssociation]
|
|
3580
|
+
#
|
|
3581
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3582
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3583
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3584
|
+
def create_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3585
|
+
command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
|
|
3586
|
+
command.request_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
|
|
3587
|
+
command.request_object = youtube_asset_association_object
|
|
3588
|
+
command.response_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
|
|
3589
|
+
command.response_class = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation
|
|
3590
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3591
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
|
3592
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
3593
|
+
command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
|
|
3594
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3595
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3596
|
+
execute_or_queue_command(command, &block)
|
|
3597
|
+
end
|
|
3598
|
+
|
|
3599
|
+
# Deletes an existing association between an entity (line item or ad group) and
|
|
3600
|
+
# a YouTube asset.
|
|
3601
|
+
# @param [Fixnum] advertiser_id
|
|
3602
|
+
# Required. The ID of the advertiser this request is for.
|
|
3603
|
+
# @param [Fixnum] line_item_id
|
|
3604
|
+
# The unique ID of the line item linked.
|
|
3605
|
+
# @param [String] youtube_asset_type
|
|
3606
|
+
# Required. The YouTube asset type this request is for.
|
|
3607
|
+
# @param [Fixnum] youtube_asset_association_id
|
|
3608
|
+
# Required. The ID of the YouTube asset in the association. For location
|
|
3609
|
+
# associations: This should be the ID of the asset set linked, or 0 if the
|
|
3610
|
+
# association stands for location asset is disabled. For affiliate location
|
|
3611
|
+
# associations: This should be the ID of the asset set linked, or 0 if the
|
|
3612
|
+
# association stands for affiliate location asset is disabled. For sitelink
|
|
3613
|
+
# associations: This should be the ID of the sitelink asset linked.
|
|
3614
|
+
# @param [Fixnum] linked_entity_ad_group_id
|
|
3615
|
+
# The unique ID of the ad group linked.
|
|
3616
|
+
# @param [String] fields
|
|
3617
|
+
# Selector specifying which fields to include in a partial response.
|
|
3618
|
+
# @param [String] quota_user
|
|
3619
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3620
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3621
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3622
|
+
# Request-specific options
|
|
3623
|
+
#
|
|
3624
|
+
# @yield [result, err] Result & error if block supplied
|
|
3625
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::Empty] parsed result object
|
|
3626
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3627
|
+
#
|
|
3628
|
+
# @return [Google::Apis::DisplayvideoV4::Empty]
|
|
3629
|
+
#
|
|
3630
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3631
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3632
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3633
|
+
def delete_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_id, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3634
|
+
command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}', options)
|
|
3635
|
+
command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
|
|
3636
|
+
command.response_class = Google::Apis::DisplayvideoV4::Empty
|
|
3637
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3638
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
|
3639
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
3640
|
+
command.params['youtubeAssetAssociationId'] = youtube_asset_association_id unless youtube_asset_association_id.nil?
|
|
3641
|
+
command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
|
|
3642
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3643
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3644
|
+
execute_or_queue_command(command, &block)
|
|
3645
|
+
end
|
|
3646
|
+
|
|
3647
|
+
# Lists the YouTube asset associations for given resource.
|
|
3648
|
+
# @param [Fixnum] advertiser_id
|
|
3649
|
+
# Required. The ID of the advertiser this request is for.
|
|
3650
|
+
# @param [Fixnum] line_item_id
|
|
3651
|
+
# The unique ID of the line item linked.
|
|
3652
|
+
# @param [String] youtube_asset_type
|
|
3653
|
+
# Required. The type of YouTube asset in the association.
|
|
3654
|
+
# @param [Fixnum] linked_entity_ad_group_id
|
|
3655
|
+
# The unique ID of the ad group linked.
|
|
3656
|
+
# @param [String] order_by
|
|
3657
|
+
# Optional. Field by which to sort the list. The only acceptable values are: `
|
|
3658
|
+
# linkedYoutubeAsset.locationAssetFilter.assetSetId`, `linkedYoutubeAsset.
|
|
3659
|
+
# affiliateLocationAssetFilter.assetSetId`, `linkedYoutubeAsset.sitelinkAsset.
|
|
3660
|
+
# assetId` The default sorting order is ascending. To specify descending order
|
|
3661
|
+
# for a field, a suffix " desc" should be added to the field name. Example: `
|
|
3662
|
+
# linkedYoutubeAsset.sitelinkAsset.assetId desc`.
|
|
3663
|
+
# @param [Fixnum] page_size
|
|
3664
|
+
# Optional. Requested page size. Must be between `1` and `10000`. If unspecified
|
|
3665
|
+
# will default to `100`.
|
|
3666
|
+
# @param [String] page_token
|
|
3667
|
+
# Optional. A token identifying a page of results the server should return.
|
|
3668
|
+
# @param [String] fields
|
|
3669
|
+
# Selector specifying which fields to include in a partial response.
|
|
3670
|
+
# @param [String] quota_user
|
|
3671
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3672
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3673
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3674
|
+
# Request-specific options
|
|
3675
|
+
#
|
|
3676
|
+
# @yield [result, err] Result & error if block supplied
|
|
3677
|
+
# @yieldparam result [Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse] parsed result object
|
|
3678
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3679
|
+
#
|
|
3680
|
+
# @return [Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse]
|
|
3681
|
+
#
|
|
3682
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3683
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3684
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3685
|
+
def list_advertiser_line_item_youtube_asset_type_youtube_asset_associations(advertiser_id, line_item_id, youtube_asset_type, linked_entity_ad_group_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3686
|
+
command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
|
|
3687
|
+
command.response_representation = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse::Representation
|
|
3688
|
+
command.response_class = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse
|
|
3689
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
3690
|
+
command.params['lineItemId'] = line_item_id unless line_item_id.nil?
|
|
3691
|
+
command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
|
|
3692
|
+
command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
|
|
3693
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
3694
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3695
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3696
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3697
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3698
|
+
execute_or_queue_command(command, &block)
|
|
3699
|
+
end
|
|
3700
|
+
|
|
3216
3701
|
# Creates a new location list. Returns the newly created location list if
|
|
3217
3702
|
# successful.
|
|
3218
3703
|
# @param [Fixnum] advertiser_id
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-displayvideo_v4
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.13.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -57,7 +57,7 @@ licenses:
|
|
|
57
57
|
metadata:
|
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v4/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v4/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v4/v0.13.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v4
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|