google-apis-displayvideo_v1 0.2.0 → 0.7.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/lib/google/apis/displayvideo_v1.rb +1 -1
- data/lib/google/apis/displayvideo_v1/classes.rb +326 -16
- data/lib/google/apis/displayvideo_v1/gem_version.rb +3 -3
- data/lib/google/apis/displayvideo_v1/representations.rb +141 -0
- data/lib/google/apis/displayvideo_v1/service.rb +519 -3
- metadata +5 -5
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DisplayvideoV1
|
18
18
|
# Version of the google-apis-displayvideo_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.7.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210318"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -298,6 +298,18 @@ module Google
|
|
298
298
|
include Google::Apis::Core::JsonObjectSupport
|
299
299
|
end
|
300
300
|
|
301
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
302
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
|
+
|
304
|
+
include Google::Apis::Core::JsonObjectSupport
|
305
|
+
end
|
306
|
+
|
307
|
+
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
308
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
309
|
+
|
310
|
+
include Google::Apis::Core::JsonObjectSupport
|
311
|
+
end
|
312
|
+
|
301
313
|
class BulkListLineItemAssignedTargetingOptionsResponse
|
302
314
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
315
|
|
@@ -694,6 +706,12 @@ module Google
|
|
694
706
|
include Google::Apis::Core::JsonObjectSupport
|
695
707
|
end
|
696
708
|
|
709
|
+
class GenerateDefaultLineItemRequest
|
710
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
711
|
+
|
712
|
+
include Google::Apis::Core::JsonObjectSupport
|
713
|
+
end
|
714
|
+
|
697
715
|
class GeoRegionAssignedTargetingOptionDetails
|
698
716
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
699
717
|
|
@@ -892,6 +910,12 @@ module Google
|
|
892
910
|
include Google::Apis::Core::JsonObjectSupport
|
893
911
|
end
|
894
912
|
|
913
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
914
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
915
|
+
|
916
|
+
include Google::Apis::Core::JsonObjectSupport
|
917
|
+
end
|
918
|
+
|
895
919
|
class ListCampaignsResponse
|
896
920
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
897
921
|
|
@@ -940,6 +964,12 @@ module Google
|
|
940
964
|
include Google::Apis::Core::JsonObjectSupport
|
941
965
|
end
|
942
966
|
|
967
|
+
class ListInsertionOrderAssignedTargetingOptionsResponse
|
968
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
|
+
|
970
|
+
include Google::Apis::Core::JsonObjectSupport
|
971
|
+
end
|
972
|
+
|
943
973
|
class ListInsertionOrdersResponse
|
944
974
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
945
975
|
|
@@ -1216,6 +1246,30 @@ module Google
|
|
1216
1246
|
include Google::Apis::Core::JsonObjectSupport
|
1217
1247
|
end
|
1218
1248
|
|
1249
|
+
class ReplaceNegativeKeywordsRequest
|
1250
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1251
|
+
|
1252
|
+
include Google::Apis::Core::JsonObjectSupport
|
1253
|
+
end
|
1254
|
+
|
1255
|
+
class ReplaceNegativeKeywordsResponse
|
1256
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1257
|
+
|
1258
|
+
include Google::Apis::Core::JsonObjectSupport
|
1259
|
+
end
|
1260
|
+
|
1261
|
+
class ReplaceSitesRequest
|
1262
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1263
|
+
|
1264
|
+
include Google::Apis::Core::JsonObjectSupport
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
class ReplaceSitesResponse
|
1268
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1269
|
+
|
1270
|
+
include Google::Apis::Core::JsonObjectSupport
|
1271
|
+
end
|
1272
|
+
|
1219
1273
|
class ReviewStatusInfo
|
1220
1274
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1221
1275
|
|
@@ -1516,6 +1570,7 @@ module Google
|
|
1516
1570
|
# @private
|
1517
1571
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1518
1572
|
property :app_id, as: 'appId'
|
1573
|
+
property :app_platform, as: 'appPlatform'
|
1519
1574
|
property :display_name, as: 'displayName'
|
1520
1575
|
property :negative, as: 'negative'
|
1521
1576
|
end
|
@@ -1901,6 +1956,24 @@ module Google
|
|
1901
1956
|
end
|
1902
1957
|
end
|
1903
1958
|
|
1959
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
1960
|
+
# @private
|
1961
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1962
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1963
|
+
|
1964
|
+
property :next_page_token, as: 'nextPageToken'
|
1965
|
+
end
|
1966
|
+
end
|
1967
|
+
|
1968
|
+
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
1969
|
+
# @private
|
1970
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1971
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1972
|
+
|
1973
|
+
property :next_page_token, as: 'nextPageToken'
|
1974
|
+
end
|
1975
|
+
end
|
1976
|
+
|
1904
1977
|
class BulkListLineItemAssignedTargetingOptionsResponse
|
1905
1978
|
# @private
|
1906
1979
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2046,6 +2119,7 @@ module Google
|
|
2046
2119
|
class ContentInstreamPositionAssignedTargetingOptionDetails
|
2047
2120
|
# @private
|
2048
2121
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2122
|
+
property :ad_type, as: 'adType'
|
2049
2123
|
property :content_instream_position, as: 'contentInstreamPosition'
|
2050
2124
|
property :targeting_option_id, as: 'targetingOptionId'
|
2051
2125
|
end
|
@@ -2061,6 +2135,7 @@ module Google
|
|
2061
2135
|
class ContentOutstreamPositionAssignedTargetingOptionDetails
|
2062
2136
|
# @private
|
2063
2137
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2138
|
+
property :ad_type, as: 'adType'
|
2064
2139
|
property :content_outstream_position, as: 'contentOutstreamPosition'
|
2065
2140
|
property :targeting_option_id, as: 'targetingOptionId'
|
2066
2141
|
end
|
@@ -2164,10 +2239,12 @@ module Google
|
|
2164
2239
|
property :js_tracker_url, as: 'jsTrackerUrl'
|
2165
2240
|
collection :line_item_ids, as: 'lineItemIds'
|
2166
2241
|
property :media_duration, as: 'mediaDuration'
|
2242
|
+
property :mp3_audio, as: 'mp3Audio'
|
2167
2243
|
property :name, as: 'name'
|
2168
2244
|
property :notes, as: 'notes'
|
2169
2245
|
property :oba_icon, as: 'obaIcon', class: Google::Apis::DisplayvideoV1::ObaIcon, decorator: Google::Apis::DisplayvideoV1::ObaIcon::Representation
|
2170
2246
|
|
2247
|
+
property :ogg_audio, as: 'oggAudio'
|
2171
2248
|
property :progress_offset, as: 'progressOffset', class: Google::Apis::DisplayvideoV1::AudioVideoOffset, decorator: Google::Apis::DisplayvideoV1::AudioVideoOffset::Representation
|
2172
2249
|
|
2173
2250
|
property :require_html5, as: 'requireHtml5'
|
@@ -2554,6 +2631,17 @@ module Google
|
|
2554
2631
|
end
|
2555
2632
|
end
|
2556
2633
|
|
2634
|
+
class GenerateDefaultLineItemRequest
|
2635
|
+
# @private
|
2636
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2637
|
+
property :display_name, as: 'displayName'
|
2638
|
+
property :insertion_order_id, :numeric_string => true, as: 'insertionOrderId'
|
2639
|
+
property :line_item_type, as: 'lineItemType'
|
2640
|
+
property :mobile_app, as: 'mobileApp', class: Google::Apis::DisplayvideoV1::MobileApp, decorator: Google::Apis::DisplayvideoV1::MobileApp::Representation
|
2641
|
+
|
2642
|
+
end
|
2643
|
+
end
|
2644
|
+
|
2557
2645
|
class GeoRegionAssignedTargetingOptionDetails
|
2558
2646
|
# @private
|
2559
2647
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2914,6 +3002,15 @@ module Google
|
|
2914
3002
|
end
|
2915
3003
|
end
|
2916
3004
|
|
3005
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
3006
|
+
# @private
|
3007
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3008
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
3009
|
+
|
3010
|
+
property :next_page_token, as: 'nextPageToken'
|
3011
|
+
end
|
3012
|
+
end
|
3013
|
+
|
2917
3014
|
class ListCampaignsResponse
|
2918
3015
|
# @private
|
2919
3016
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2986,6 +3083,15 @@ module Google
|
|
2986
3083
|
end
|
2987
3084
|
end
|
2988
3085
|
|
3086
|
+
class ListInsertionOrderAssignedTargetingOptionsResponse
|
3087
|
+
# @private
|
3088
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3089
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
3090
|
+
|
3091
|
+
property :next_page_token, as: 'nextPageToken'
|
3092
|
+
end
|
3093
|
+
end
|
3094
|
+
|
2989
3095
|
class ListInsertionOrdersResponse
|
2990
3096
|
# @private
|
2991
3097
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3223,6 +3329,7 @@ module Google
|
|
3223
3329
|
class OnScreenPositionAssignedTargetingOptionDetails
|
3224
3330
|
# @private
|
3225
3331
|
class Representation < Google::Apis::Core::JsonRepresentation
|
3332
|
+
property :ad_type, as: 'adType'
|
3226
3333
|
property :on_screen_position, as: 'onScreenPosition'
|
3227
3334
|
property :targeting_option_id, as: 'targetingOptionId'
|
3228
3335
|
end
|
@@ -3415,6 +3522,40 @@ module Google
|
|
3415
3522
|
end
|
3416
3523
|
end
|
3417
3524
|
|
3525
|
+
class ReplaceNegativeKeywordsRequest
|
3526
|
+
# @private
|
3527
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3528
|
+
collection :new_negative_keywords, as: 'newNegativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
3529
|
+
|
3530
|
+
end
|
3531
|
+
end
|
3532
|
+
|
3533
|
+
class ReplaceNegativeKeywordsResponse
|
3534
|
+
# @private
|
3535
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3536
|
+
collection :negative_keywords, as: 'negativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
3537
|
+
|
3538
|
+
end
|
3539
|
+
end
|
3540
|
+
|
3541
|
+
class ReplaceSitesRequest
|
3542
|
+
# @private
|
3543
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3544
|
+
property :advertiser_id, :numeric_string => true, as: 'advertiserId'
|
3545
|
+
collection :new_sites, as: 'newSites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation
|
3546
|
+
|
3547
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
3548
|
+
end
|
3549
|
+
end
|
3550
|
+
|
3551
|
+
class ReplaceSitesResponse
|
3552
|
+
# @private
|
3553
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3554
|
+
collection :sites, as: 'sites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation
|
3555
|
+
|
3556
|
+
end
|
3557
|
+
end
|
3558
|
+
|
3418
3559
|
class ReviewStatusInfo
|
3419
3560
|
# @private
|
3420
3561
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -421,6 +421,69 @@ module Google
|
|
421
421
|
execute_or_queue_command(command, &block)
|
422
422
|
end
|
423
423
|
|
424
|
+
# Lists assigned targeting options of a campaign across targeting types.
|
425
|
+
# @param [Fixnum] advertiser_id
|
426
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
427
|
+
# @param [Fixnum] campaign_id
|
428
|
+
# Required. The ID of the campaign to list assigned targeting options for.
|
429
|
+
# @param [String] filter
|
430
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
431
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
432
|
+
# be combined by the logical operator `OR` on the same field. * A restriction
|
433
|
+
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
434
|
+
# )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
|
435
|
+
# AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or
|
436
|
+
# TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
437
|
+
# targetingType="TARGETING_TYPE_GENDER"` * AssignedTargetingOptions with
|
438
|
+
# inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="
|
439
|
+
# NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this
|
440
|
+
# field should be no more than 500 characters.
|
441
|
+
# @param [String] order_by
|
442
|
+
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
443
|
+
# default) The default sorting order is ascending. To specify descending order
|
444
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
445
|
+
# targetingType desc`.
|
446
|
+
# @param [Fixnum] page_size
|
447
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
448
|
+
# unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
|
449
|
+
# an invalid value is specified.
|
450
|
+
# @param [String] page_token
|
451
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
452
|
+
# is the value of next_page_token returned from the previous call to `
|
453
|
+
# BulkListCampaignAssignedTargetingOptions` method. If not specified, the first
|
454
|
+
# page of results will be returned.
|
455
|
+
# @param [String] fields
|
456
|
+
# Selector specifying which fields to include in a partial response.
|
457
|
+
# @param [String] quota_user
|
458
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
459
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
460
|
+
# @param [Google::Apis::RequestOptions] options
|
461
|
+
# Request-specific options
|
462
|
+
#
|
463
|
+
# @yield [result, err] Result & error if block supplied
|
464
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse] parsed result object
|
465
|
+
# @yieldparam err [StandardError] error object if request failed
|
466
|
+
#
|
467
|
+
# @return [Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse]
|
468
|
+
#
|
469
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
470
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
471
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
472
|
+
def bulk_advertiser_campaign_list_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
473
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}:bulkListCampaignAssignedTargetingOptions', options)
|
474
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse::Representation
|
475
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse
|
476
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
477
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
478
|
+
command.query['filter'] = filter unless filter.nil?
|
479
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
480
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
481
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
482
|
+
command.query['fields'] = fields unless fields.nil?
|
483
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
484
|
+
execute_or_queue_command(command, &block)
|
485
|
+
end
|
486
|
+
|
424
487
|
# Creates a new campaign. Returns the newly created campaign if successful.
|
425
488
|
# @param [Fixnum] advertiser_id
|
426
489
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
@@ -626,6 +689,136 @@ module Google
|
|
626
689
|
execute_or_queue_command(command, &block)
|
627
690
|
end
|
628
691
|
|
692
|
+
# Gets a single targeting option assigned to a campaign.
|
693
|
+
# @param [Fixnum] advertiser_id
|
694
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
695
|
+
# @param [Fixnum] campaign_id
|
696
|
+
# Required. The ID of the campaign the assigned targeting option belongs to.
|
697
|
+
# @param [String] targeting_type
|
698
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
699
|
+
# targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
|
700
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
|
701
|
+
# TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
|
702
|
+
# TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
|
703
|
+
# TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
|
704
|
+
# * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
|
705
|
+
# TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
706
|
+
# TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
|
707
|
+
# TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
|
708
|
+
# TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
|
709
|
+
# * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
|
710
|
+
# TARGETING_TYPE_VIEWABILITY`
|
711
|
+
# @param [String] assigned_targeting_option_id
|
712
|
+
# Required. An identifier unique to the targeting type in this campaign that
|
713
|
+
# identifies the assigned targeting option being requested.
|
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::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
724
|
+
# @yieldparam err [StandardError] error object if request failed
|
725
|
+
#
|
726
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
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 get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
732
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
733
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
734
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
735
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
736
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
737
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
738
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.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
|
+
# Lists the targeting options assigned to a campaign for a specified targeting
|
745
|
+
# type.
|
746
|
+
# @param [Fixnum] advertiser_id
|
747
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
748
|
+
# @param [Fixnum] campaign_id
|
749
|
+
# Required. The ID of the campaign to list assigned targeting options for.
|
750
|
+
# @param [String] targeting_type
|
751
|
+
# Required. Identifies the type of assigned targeting options to list. Supported
|
752
|
+
# targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
|
753
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
|
754
|
+
# TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
|
755
|
+
# TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
|
756
|
+
# TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
|
757
|
+
# * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
|
758
|
+
# TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
759
|
+
# TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
|
760
|
+
# TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
|
761
|
+
# TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
|
762
|
+
# * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
|
763
|
+
# TARGETING_TYPE_VIEWABILITY`
|
764
|
+
# @param [String] filter
|
765
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
766
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
767
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
768
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
769
|
+
# fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
|
770
|
+
# AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
|
771
|
+
# assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
|
772
|
+
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
|
773
|
+
# OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
774
|
+
# more than 500 characters.
|
775
|
+
# @param [String] order_by
|
776
|
+
# Field by which to sort the list. Acceptable values are: * `
|
777
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
778
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
779
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
780
|
+
# @param [Fixnum] page_size
|
781
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
782
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
783
|
+
# specified.
|
784
|
+
# @param [String] page_token
|
785
|
+
# A token identifying a page of results the server should return. Typically,
|
786
|
+
# this is the value of next_page_token returned from the previous call to `
|
787
|
+
# ListCampaignAssignedTargetingOptions` method. If not specified, the first page
|
788
|
+
# of results will be returned.
|
789
|
+
# @param [String] fields
|
790
|
+
# Selector specifying which fields to include in a partial response.
|
791
|
+
# @param [String] quota_user
|
792
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
793
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
794
|
+
# @param [Google::Apis::RequestOptions] options
|
795
|
+
# Request-specific options
|
796
|
+
#
|
797
|
+
# @yield [result, err] Result & error if block supplied
|
798
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse] parsed result object
|
799
|
+
# @yieldparam err [StandardError] error object if request failed
|
800
|
+
#
|
801
|
+
# @return [Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse]
|
802
|
+
#
|
803
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
804
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
805
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
806
|
+
def list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
807
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
808
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse::Representation
|
809
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse
|
810
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
811
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
812
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
813
|
+
command.query['filter'] = filter unless filter.nil?
|
814
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
815
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
816
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
817
|
+
command.query['fields'] = fields unless fields.nil?
|
818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
819
|
+
execute_or_queue_command(command, &block)
|
820
|
+
end
|
821
|
+
|
629
822
|
# Creates a new channel. Returns the newly created channel if successful.
|
630
823
|
# @param [Fixnum] advertiser_id
|
631
824
|
# The ID of the advertiser that owns the created channel.
|
@@ -931,7 +1124,7 @@ module Google
|
|
931
1124
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
932
1125
|
# urlOrAppId desc`.
|
933
1126
|
# @param [Fixnum] page_size
|
934
|
-
# Requested page size. Must be between `1` and `
|
1127
|
+
# Requested page size. Must be between `1` and `10000`. If unspecified will
|
935
1128
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
936
1129
|
# specified.
|
937
1130
|
# @param [String] page_token
|
@@ -974,6 +1167,44 @@ module Google
|
|
974
1167
|
execute_or_queue_command(command, &block)
|
975
1168
|
end
|
976
1169
|
|
1170
|
+
# Replaces all of the sites under a single channel. The operation will replace
|
1171
|
+
# the sites under a channel with the sites provided in ReplaceSitesRequest.
|
1172
|
+
# new_sites.
|
1173
|
+
# @param [Fixnum] advertiser_id
|
1174
|
+
# The ID of the advertiser that owns the parent channel.
|
1175
|
+
# @param [Fixnum] channel_id
|
1176
|
+
# Required. The ID of the parent channel whose sites will be replaced.
|
1177
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceSitesRequest] replace_sites_request_object
|
1178
|
+
# @param [String] fields
|
1179
|
+
# Selector specifying which fields to include in a partial response.
|
1180
|
+
# @param [String] quota_user
|
1181
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1182
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1183
|
+
# @param [Google::Apis::RequestOptions] options
|
1184
|
+
# Request-specific options
|
1185
|
+
#
|
1186
|
+
# @yield [result, err] Result & error if block supplied
|
1187
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceSitesResponse] parsed result object
|
1188
|
+
# @yieldparam err [StandardError] error object if request failed
|
1189
|
+
#
|
1190
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceSitesResponse]
|
1191
|
+
#
|
1192
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1193
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1194
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1195
|
+
def replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1196
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
|
1197
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceSitesRequest::Representation
|
1198
|
+
command.request_object = replace_sites_request_object
|
1199
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceSitesResponse::Representation
|
1200
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceSitesResponse
|
1201
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1202
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
1203
|
+
command.query['fields'] = fields unless fields.nil?
|
1204
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1205
|
+
execute_or_queue_command(command, &block)
|
1206
|
+
end
|
1207
|
+
|
977
1208
|
# Creates a new creative. Returns the newly created creative if successful.
|
978
1209
|
# @param [Fixnum] advertiser_id
|
979
1210
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
@@ -1194,6 +1425,70 @@ module Google
|
|
1194
1425
|
execute_or_queue_command(command, &block)
|
1195
1426
|
end
|
1196
1427
|
|
1428
|
+
# Lists assigned targeting options of an insertion order across targeting types.
|
1429
|
+
# @param [Fixnum] advertiser_id
|
1430
|
+
# Required. The ID of the advertiser the insertion order belongs to.
|
1431
|
+
# @param [Fixnum] insertion_order_id
|
1432
|
+
# Required. The ID of the insertion order to list assigned targeting options for.
|
1433
|
+
# @param [String] filter
|
1434
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
1435
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
1436
|
+
# be combined by the logical operator `OR` on the same field. * A restriction
|
1437
|
+
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
1438
|
+
# )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
|
1439
|
+
# AssignedTargetingOptions of targeting type
|
1440
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
1441
|
+
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
1442
|
+
# TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of
|
1443
|
+
# NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR
|
1444
|
+
# inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
1445
|
+
# more than 500 characters.
|
1446
|
+
# @param [String] order_by
|
1447
|
+
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
1448
|
+
# default) The default sorting order is ascending. To specify descending order
|
1449
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
1450
|
+
# targetingType desc`.
|
1451
|
+
# @param [Fixnum] page_size
|
1452
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
1453
|
+
# unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
|
1454
|
+
# an invalid value is specified.
|
1455
|
+
# @param [String] page_token
|
1456
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
1457
|
+
# is the value of next_page_token returned from the previous call to `
|
1458
|
+
# BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the
|
1459
|
+
# first page of results will be returned.
|
1460
|
+
# @param [String] fields
|
1461
|
+
# Selector specifying which fields to include in a partial response.
|
1462
|
+
# @param [String] quota_user
|
1463
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1464
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1465
|
+
# @param [Google::Apis::RequestOptions] options
|
1466
|
+
# Request-specific options
|
1467
|
+
#
|
1468
|
+
# @yield [result, err] Result & error if block supplied
|
1469
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
|
1470
|
+
# @yieldparam err [StandardError] error object if request failed
|
1471
|
+
#
|
1472
|
+
# @return [Google::Apis::DisplayvideoV1::BulkListInsertionOrderAssignedTargetingOptionsResponse]
|
1473
|
+
#
|
1474
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1475
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1476
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1477
|
+
def bulk_advertiser_insertion_order_list_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1478
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:bulkListInsertionOrderAssignedTargetingOptions', options)
|
1479
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
|
1480
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkListInsertionOrderAssignedTargetingOptionsResponse
|
1481
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1482
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1483
|
+
command.query['filter'] = filter unless filter.nil?
|
1484
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1485
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1486
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1487
|
+
command.query['fields'] = fields unless fields.nil?
|
1488
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1489
|
+
execute_or_queue_command(command, &block)
|
1490
|
+
end
|
1491
|
+
|
1197
1492
|
# Creates a new insertion order. Returns the newly created insertion order if
|
1198
1493
|
# successful.
|
1199
1494
|
# @param [Fixnum] advertiser_id
|
@@ -1408,6 +1703,112 @@ module Google
|
|
1408
1703
|
execute_or_queue_command(command, &block)
|
1409
1704
|
end
|
1410
1705
|
|
1706
|
+
# Gets a single targeting option assigned to an insertion order.
|
1707
|
+
# @param [Fixnum] advertiser_id
|
1708
|
+
# Required. The ID of the advertiser the insertion order belongs to.
|
1709
|
+
# @param [Fixnum] insertion_order_id
|
1710
|
+
# Required. The ID of the insertion order the assigned targeting option belongs
|
1711
|
+
# to.
|
1712
|
+
# @param [String] targeting_type
|
1713
|
+
# Required. Identifies the type of this assigned targeting option.
|
1714
|
+
# @param [String] assigned_targeting_option_id
|
1715
|
+
# Required. An identifier unique to the targeting type in this insertion order
|
1716
|
+
# that identifies the assigned targeting option being requested.
|
1717
|
+
# @param [String] fields
|
1718
|
+
# Selector specifying which fields to include in a partial response.
|
1719
|
+
# @param [String] quota_user
|
1720
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1721
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1722
|
+
# @param [Google::Apis::RequestOptions] options
|
1723
|
+
# Request-specific options
|
1724
|
+
#
|
1725
|
+
# @yield [result, err] Result & error if block supplied
|
1726
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
1727
|
+
# @yieldparam err [StandardError] error object if request failed
|
1728
|
+
#
|
1729
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
1730
|
+
#
|
1731
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1732
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1733
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1734
|
+
def get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
1735
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
1736
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1737
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
1738
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1739
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1740
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1741
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
1742
|
+
command.query['fields'] = fields unless fields.nil?
|
1743
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1744
|
+
execute_or_queue_command(command, &block)
|
1745
|
+
end
|
1746
|
+
|
1747
|
+
# Lists the targeting options assigned to an insertion order.
|
1748
|
+
# @param [Fixnum] advertiser_id
|
1749
|
+
# Required. The ID of the advertiser the insertion order belongs to.
|
1750
|
+
# @param [Fixnum] insertion_order_id
|
1751
|
+
# Required. The ID of the insertion order to list assigned targeting options for.
|
1752
|
+
# @param [String] targeting_type
|
1753
|
+
# Required. Identifies the type of assigned targeting options to list.
|
1754
|
+
# @param [String] filter
|
1755
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
1756
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
1757
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
1758
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
1759
|
+
# fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
|
1760
|
+
# AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
|
1761
|
+
# assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
|
1762
|
+
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
|
1763
|
+
# OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
1764
|
+
# more than 500 characters.
|
1765
|
+
# @param [String] order_by
|
1766
|
+
# Field by which to sort the list. Acceptable values are: * `
|
1767
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
1768
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
1769
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
1770
|
+
# @param [Fixnum] page_size
|
1771
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
1772
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
1773
|
+
# specified.
|
1774
|
+
# @param [String] page_token
|
1775
|
+
# A token identifying a page of results the server should return. Typically,
|
1776
|
+
# this is the value of next_page_token returned from the previous call to `
|
1777
|
+
# ListInsertionOrderAssignedTargetingOptions` method. If not specified, the
|
1778
|
+
# first page of results will be returned.
|
1779
|
+
# @param [String] fields
|
1780
|
+
# Selector specifying which fields to include in a partial response.
|
1781
|
+
# @param [String] quota_user
|
1782
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1783
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1784
|
+
# @param [Google::Apis::RequestOptions] options
|
1785
|
+
# Request-specific options
|
1786
|
+
#
|
1787
|
+
# @yield [result, err] Result & error if block supplied
|
1788
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
|
1789
|
+
# @yieldparam err [StandardError] error object if request failed
|
1790
|
+
#
|
1791
|
+
# @return [Google::Apis::DisplayvideoV1::ListInsertionOrderAssignedTargetingOptionsResponse]
|
1792
|
+
#
|
1793
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1794
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1795
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1796
|
+
def list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1797
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
1798
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
|
1799
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInsertionOrderAssignedTargetingOptionsResponse
|
1800
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1801
|
+
command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
|
1802
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
1803
|
+
command.query['filter'] = filter unless filter.nil?
|
1804
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1805
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1806
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1807
|
+
command.query['fields'] = fields unless fields.nil?
|
1808
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1809
|
+
execute_or_queue_command(command, &block)
|
1810
|
+
end
|
1811
|
+
|
1411
1812
|
# Bulk edits targeting options under a single line item. The operation will
|
1412
1813
|
# delete the assigned targeting options provided in
|
1413
1814
|
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then
|
@@ -1580,6 +1981,43 @@ module Google
|
|
1580
1981
|
execute_or_queue_command(command, &block)
|
1581
1982
|
end
|
1582
1983
|
|
1984
|
+
# Creates a new line item with settings (including targeting) inherited from the
|
1985
|
+
# insertion order. Returns the newly created line item if successful. There are
|
1986
|
+
# default values based on the three fields: * The insertion order's
|
1987
|
+
# InsertionOrderType * The insertion order's InsertionOrderAutomationType * The
|
1988
|
+
# given line_item_type
|
1989
|
+
# @param [Fixnum] advertiser_id
|
1990
|
+
# Required. The ID of the advertiser this line item belongs to.
|
1991
|
+
# @param [Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest] generate_default_line_item_request_object
|
1992
|
+
# @param [String] fields
|
1993
|
+
# Selector specifying which fields to include in a partial response.
|
1994
|
+
# @param [String] quota_user
|
1995
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1996
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1997
|
+
# @param [Google::Apis::RequestOptions] options
|
1998
|
+
# Request-specific options
|
1999
|
+
#
|
2000
|
+
# @yield [result, err] Result & error if block supplied
|
2001
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
2002
|
+
# @yieldparam err [StandardError] error object if request failed
|
2003
|
+
#
|
2004
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
2005
|
+
#
|
2006
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2007
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2008
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2009
|
+
def generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2010
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems:generateDefault', options)
|
2011
|
+
command.request_representation = Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest::Representation
|
2012
|
+
command.request_object = generate_default_line_item_request_object
|
2013
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
2014
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
2015
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.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
|
+
|
1583
2021
|
# Gets a line item.
|
1584
2022
|
# @param [Fixnum] advertiser_id
|
1585
2023
|
# Required. The ID of the advertiser this line item belongs to.
|
@@ -2812,7 +3250,7 @@ module Google
|
|
2812
3250
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
2813
3251
|
# keywordValue desc`.
|
2814
3252
|
# @param [Fixnum] page_size
|
2815
|
-
# Requested page size. Must be between `1` and `
|
3253
|
+
# Requested page size. Must be between `1` and `1000`. If unspecified will
|
2816
3254
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
2817
3255
|
# specified.
|
2818
3256
|
# @param [String] page_token
|
@@ -2852,6 +3290,46 @@ module Google
|
|
2852
3290
|
execute_or_queue_command(command, &block)
|
2853
3291
|
end
|
2854
3292
|
|
3293
|
+
# Replaces all negative keywords in a single negative keyword list. The
|
3294
|
+
# operation will replace the keywords in a negative keywords with keywords
|
3295
|
+
# provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
|
3296
|
+
# @param [Fixnum] advertiser_id
|
3297
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
3298
|
+
# list belongs.
|
3299
|
+
# @param [Fixnum] negative_keyword_list_id
|
3300
|
+
# Required. The ID of the parent negative keyword list to which the negative
|
3301
|
+
# keywords belong.
|
3302
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest] replace_negative_keywords_request_object
|
3303
|
+
# @param [String] fields
|
3304
|
+
# Selector specifying which fields to include in a partial response.
|
3305
|
+
# @param [String] quota_user
|
3306
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3307
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3308
|
+
# @param [Google::Apis::RequestOptions] options
|
3309
|
+
# Request-specific options
|
3310
|
+
#
|
3311
|
+
# @yield [result, err] Result & error if block supplied
|
3312
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse] parsed result object
|
3313
|
+
# @yieldparam err [StandardError] error object if request failed
|
3314
|
+
#
|
3315
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse]
|
3316
|
+
#
|
3317
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3318
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3319
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3320
|
+
def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3321
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
|
3322
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest::Representation
|
3323
|
+
command.request_object = replace_negative_keywords_request_object
|
3324
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse::Representation
|
3325
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse
|
3326
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3327
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
3328
|
+
command.query['fields'] = fields unless fields.nil?
|
3329
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3330
|
+
execute_or_queue_command(command, &block)
|
3331
|
+
end
|
3332
|
+
|
2855
3333
|
# Assigns a targeting option to an advertiser. Returns the assigned targeting
|
2856
3334
|
# option if successful.
|
2857
3335
|
# @param [Fixnum] advertiser_id
|
@@ -4568,7 +5046,7 @@ module Google
|
|
4568
5046
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
4569
5047
|
# urlOrAppId desc`.
|
4570
5048
|
# @param [Fixnum] page_size
|
4571
|
-
# Requested page size. Must be between `1` and `
|
5049
|
+
# Requested page size. Must be between `1` and `10000`. If unspecified will
|
4572
5050
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
4573
5051
|
# specified.
|
4574
5052
|
# @param [String] page_token
|
@@ -4609,6 +5087,44 @@ module Google
|
|
4609
5087
|
execute_or_queue_command(command, &block)
|
4610
5088
|
end
|
4611
5089
|
|
5090
|
+
# Replaces all of the sites under a single channel. The operation will replace
|
5091
|
+
# the sites under a channel with the sites provided in ReplaceSitesRequest.
|
5092
|
+
# new_sites.
|
5093
|
+
# @param [Fixnum] partner_id
|
5094
|
+
# The ID of the partner that owns the parent channel.
|
5095
|
+
# @param [Fixnum] channel_id
|
5096
|
+
# Required. The ID of the parent channel whose sites will be replaced.
|
5097
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceSitesRequest] replace_sites_request_object
|
5098
|
+
# @param [String] fields
|
5099
|
+
# Selector specifying which fields to include in a partial response.
|
5100
|
+
# @param [String] quota_user
|
5101
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5102
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5103
|
+
# @param [Google::Apis::RequestOptions] options
|
5104
|
+
# Request-specific options
|
5105
|
+
#
|
5106
|
+
# @yield [result, err] Result & error if block supplied
|
5107
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceSitesResponse] parsed result object
|
5108
|
+
# @yieldparam err [StandardError] error object if request failed
|
5109
|
+
#
|
5110
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceSitesResponse]
|
5111
|
+
#
|
5112
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5113
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5114
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5115
|
+
def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5116
|
+
command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
|
5117
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceSitesRequest::Representation
|
5118
|
+
command.request_object = replace_sites_request_object
|
5119
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceSitesResponse::Representation
|
5120
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceSitesResponse
|
5121
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
5122
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
5123
|
+
command.query['fields'] = fields unless fields.nil?
|
5124
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5125
|
+
execute_or_queue_command(command, &block)
|
5126
|
+
end
|
5127
|
+
|
4612
5128
|
# Assigns a targeting option to a partner. Returns the assigned targeting option
|
4613
5129
|
# if successful.
|
4614
5130
|
# @param [Fixnum] partner_id
|