google-apis-displayvideo_v1 0.32.0 → 0.35.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.
@@ -724,6 +724,30 @@ module Google
|
|
724
724
|
include Google::Apis::Core::JsonObjectSupport
|
725
725
|
end
|
726
726
|
|
727
|
+
class EditGuaranteedOrderReadAccessorsRequest
|
728
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
729
|
+
|
730
|
+
include Google::Apis::Core::JsonObjectSupport
|
731
|
+
end
|
732
|
+
|
733
|
+
class EditGuaranteedOrderReadAccessorsResponse
|
734
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
735
|
+
|
736
|
+
include Google::Apis::Core::JsonObjectSupport
|
737
|
+
end
|
738
|
+
|
739
|
+
class EditInventorySourceReadWriteAccessorsRequest
|
740
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
741
|
+
|
742
|
+
include Google::Apis::Core::JsonObjectSupport
|
743
|
+
end
|
744
|
+
|
745
|
+
class EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate
|
746
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
747
|
+
|
748
|
+
include Google::Apis::Core::JsonObjectSupport
|
749
|
+
end
|
750
|
+
|
727
751
|
class Empty
|
728
752
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
729
753
|
|
@@ -874,6 +898,18 @@ module Google
|
|
874
898
|
include Google::Apis::Core::JsonObjectSupport
|
875
899
|
end
|
876
900
|
|
901
|
+
class GuaranteedOrder
|
902
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
903
|
+
|
904
|
+
include Google::Apis::Core::JsonObjectSupport
|
905
|
+
end
|
906
|
+
|
907
|
+
class GuaranteedOrderStatus
|
908
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
909
|
+
|
910
|
+
include Google::Apis::Core::JsonObjectSupport
|
911
|
+
end
|
912
|
+
|
877
913
|
class HouseholdIncomeAssignedTargetingOptionDetails
|
878
914
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
879
915
|
|
@@ -928,6 +964,24 @@ module Google
|
|
928
964
|
include Google::Apis::Core::JsonObjectSupport
|
929
965
|
end
|
930
966
|
|
967
|
+
class InventorySourceAccessors
|
968
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
|
+
|
970
|
+
include Google::Apis::Core::JsonObjectSupport
|
971
|
+
end
|
972
|
+
|
973
|
+
class InventorySourceAccessorsAdvertiserAccessors
|
974
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
975
|
+
|
976
|
+
include Google::Apis::Core::JsonObjectSupport
|
977
|
+
end
|
978
|
+
|
979
|
+
class InventorySourceAccessorsPartnerAccessor
|
980
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
981
|
+
|
982
|
+
include Google::Apis::Core::JsonObjectSupport
|
983
|
+
end
|
984
|
+
|
931
985
|
class InventorySourceAssignedTargetingOptionDetails
|
932
986
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
933
987
|
|
@@ -1096,6 +1150,12 @@ module Google
|
|
1096
1150
|
include Google::Apis::Core::JsonObjectSupport
|
1097
1151
|
end
|
1098
1152
|
|
1153
|
+
class ListGuaranteedOrdersResponse
|
1154
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1155
|
+
|
1156
|
+
include Google::Apis::Core::JsonObjectSupport
|
1157
|
+
end
|
1158
|
+
|
1099
1159
|
class ListInsertionOrderAssignedTargetingOptionsResponse
|
1100
1160
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1101
1161
|
|
@@ -2897,6 +2957,42 @@ module Google
|
|
2897
2957
|
end
|
2898
2958
|
end
|
2899
2959
|
|
2960
|
+
class EditGuaranteedOrderReadAccessorsRequest
|
2961
|
+
# @private
|
2962
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2963
|
+
collection :added_advertisers, as: 'addedAdvertisers'
|
2964
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
2965
|
+
property :read_access_inherited, as: 'readAccessInherited'
|
2966
|
+
collection :removed_advertisers, as: 'removedAdvertisers'
|
2967
|
+
end
|
2968
|
+
end
|
2969
|
+
|
2970
|
+
class EditGuaranteedOrderReadAccessorsResponse
|
2971
|
+
# @private
|
2972
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2973
|
+
property :read_access_inherited, as: 'readAccessInherited'
|
2974
|
+
collection :read_advertiser_ids, as: 'readAdvertiserIds'
|
2975
|
+
end
|
2976
|
+
end
|
2977
|
+
|
2978
|
+
class EditInventorySourceReadWriteAccessorsRequest
|
2979
|
+
# @private
|
2980
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2981
|
+
property :advertisers_update, as: 'advertisersUpdate', class: Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate, decorator: Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate::Representation
|
2982
|
+
|
2983
|
+
property :assign_partner, as: 'assignPartner'
|
2984
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
2985
|
+
end
|
2986
|
+
end
|
2987
|
+
|
2988
|
+
class EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate
|
2989
|
+
# @private
|
2990
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2991
|
+
collection :added_advertisers, as: 'addedAdvertisers'
|
2992
|
+
collection :removed_advertisers, as: 'removedAdvertisers'
|
2993
|
+
end
|
2994
|
+
end
|
2995
|
+
|
2900
2996
|
class Empty
|
2901
2997
|
# @private
|
2902
2998
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3125,6 +3221,36 @@ module Google
|
|
3125
3221
|
end
|
3126
3222
|
end
|
3127
3223
|
|
3224
|
+
class GuaranteedOrder
|
3225
|
+
# @private
|
3226
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3227
|
+
property :default_advertiser_id, :numeric_string => true, as: 'defaultAdvertiserId'
|
3228
|
+
property :default_campaign_id, :numeric_string => true, as: 'defaultCampaignId'
|
3229
|
+
property :display_name, as: 'displayName'
|
3230
|
+
property :exchange, as: 'exchange'
|
3231
|
+
property :guaranteed_order_id, as: 'guaranteedOrderId'
|
3232
|
+
property :legacy_guaranteed_order_id, as: 'legacyGuaranteedOrderId'
|
3233
|
+
property :name, as: 'name'
|
3234
|
+
property :publisher_name, as: 'publisherName'
|
3235
|
+
property :read_access_inherited, as: 'readAccessInherited'
|
3236
|
+
collection :read_advertiser_ids, as: 'readAdvertiserIds'
|
3237
|
+
property :read_write_advertiser_id, :numeric_string => true, as: 'readWriteAdvertiserId'
|
3238
|
+
property :read_write_partner_id, :numeric_string => true, as: 'readWritePartnerId'
|
3239
|
+
property :status, as: 'status', class: Google::Apis::DisplayvideoV1::GuaranteedOrderStatus, decorator: Google::Apis::DisplayvideoV1::GuaranteedOrderStatus::Representation
|
3240
|
+
|
3241
|
+
property :update_time, as: 'updateTime'
|
3242
|
+
end
|
3243
|
+
end
|
3244
|
+
|
3245
|
+
class GuaranteedOrderStatus
|
3246
|
+
# @private
|
3247
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3248
|
+
property :config_status, as: 'configStatus'
|
3249
|
+
property :entity_pause_reason, as: 'entityPauseReason'
|
3250
|
+
property :entity_status, as: 'entityStatus'
|
3251
|
+
end
|
3252
|
+
end
|
3253
|
+
|
3128
3254
|
class HouseholdIncomeAssignedTargetingOptionDetails
|
3129
3255
|
# @private
|
3130
3256
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3241,20 +3367,51 @@ module Google
|
|
3241
3367
|
property :delivery_method, as: 'deliveryMethod'
|
3242
3368
|
property :display_name, as: 'displayName'
|
3243
3369
|
property :exchange, as: 'exchange'
|
3370
|
+
property :guaranteed_order_id, as: 'guaranteedOrderId'
|
3244
3371
|
property :inventory_source_id, :numeric_string => true, as: 'inventorySourceId'
|
3372
|
+
property :inventory_source_product_type, as: 'inventorySourceProductType'
|
3245
3373
|
property :inventory_source_type, as: 'inventorySourceType'
|
3246
3374
|
property :name, as: 'name'
|
3247
3375
|
property :publisher_name, as: 'publisherName'
|
3248
3376
|
property :rate_details, as: 'rateDetails', class: Google::Apis::DisplayvideoV1::RateDetails, decorator: Google::Apis::DisplayvideoV1::RateDetails::Representation
|
3249
3377
|
|
3378
|
+
collection :read_advertiser_ids, as: 'readAdvertiserIds'
|
3379
|
+
collection :read_partner_ids, as: 'readPartnerIds'
|
3380
|
+
property :read_write_accessors, as: 'readWriteAccessors', class: Google::Apis::DisplayvideoV1::InventorySourceAccessors, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessors::Representation
|
3381
|
+
|
3250
3382
|
property :status, as: 'status', class: Google::Apis::DisplayvideoV1::InventorySourceStatus, decorator: Google::Apis::DisplayvideoV1::InventorySourceStatus::Representation
|
3251
3383
|
|
3384
|
+
property :sub_site_property_id, :numeric_string => true, as: 'subSitePropertyId'
|
3252
3385
|
property :time_range, as: 'timeRange', class: Google::Apis::DisplayvideoV1::TimeRange, decorator: Google::Apis::DisplayvideoV1::TimeRange::Representation
|
3253
3386
|
|
3254
3387
|
property :update_time, as: 'updateTime'
|
3255
3388
|
end
|
3256
3389
|
end
|
3257
3390
|
|
3391
|
+
class InventorySourceAccessors
|
3392
|
+
# @private
|
3393
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3394
|
+
property :advertisers, as: 'advertisers', class: Google::Apis::DisplayvideoV1::InventorySourceAccessorsAdvertiserAccessors, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessorsAdvertiserAccessors::Representation
|
3395
|
+
|
3396
|
+
property :partner, as: 'partner', class: Google::Apis::DisplayvideoV1::InventorySourceAccessorsPartnerAccessor, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessorsPartnerAccessor::Representation
|
3397
|
+
|
3398
|
+
end
|
3399
|
+
end
|
3400
|
+
|
3401
|
+
class InventorySourceAccessorsAdvertiserAccessors
|
3402
|
+
# @private
|
3403
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3404
|
+
collection :advertiser_ids, as: 'advertiserIds'
|
3405
|
+
end
|
3406
|
+
end
|
3407
|
+
|
3408
|
+
class InventorySourceAccessorsPartnerAccessor
|
3409
|
+
# @private
|
3410
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3411
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
3412
|
+
end
|
3413
|
+
end
|
3414
|
+
|
3258
3415
|
class InventorySourceAssignedTargetingOptionDetails
|
3259
3416
|
# @private
|
3260
3417
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3552,6 +3709,15 @@ module Google
|
|
3552
3709
|
end
|
3553
3710
|
end
|
3554
3711
|
|
3712
|
+
class ListGuaranteedOrdersResponse
|
3713
|
+
# @private
|
3714
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3715
|
+
collection :guaranteed_orders, as: 'guaranteedOrders', class: Google::Apis::DisplayvideoV1::GuaranteedOrder, decorator: Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
3716
|
+
|
3717
|
+
property :next_page_token, as: 'nextPageToken'
|
3718
|
+
end
|
3719
|
+
end
|
3720
|
+
|
3555
3721
|
class ListInsertionOrderAssignedTargetingOptionsResponse
|
3556
3722
|
# @private
|
3557
3723
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1324,31 +1324,33 @@ module Google
|
|
1324
1324
|
# operator` `value``. * The operator must be `EQUALS (=)` for the following
|
1325
1325
|
# fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `
|
1326
1326
|
# maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `
|
1327
|
-
# creativeId`
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
#
|
1332
|
-
# value is in the form of
|
1333
|
-
#
|
1334
|
-
#
|
1335
|
-
#
|
1336
|
-
#
|
1337
|
-
#
|
1338
|
-
#
|
1339
|
-
#
|
1340
|
-
#
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
# dimensions="
|
1344
|
-
#
|
1345
|
-
#
|
1327
|
+
# creativeId` * The operator must be `HAS (:)` for the following fields: - `
|
1328
|
+
# lineItemIds` * The operator must be `GREATER THAN OR EQUAL TO (>=)` or `LESS
|
1329
|
+
# THAN OR EQUAL TO (<=)` for the following fields: - `updateTime` (input in ISO
|
1330
|
+
# 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For `entityStatus`, `minDuration`, `
|
1331
|
+
# maxDuration`, `updateTime`, and `dynamic`, there may be at most one
|
1332
|
+
# restriction. * For `dimensions`, the value is in the form of `"`width`x`height`
|
1333
|
+
# "`. * For `exchangeReviewStatus`, the value is in the form of ``exchange`-`
|
1334
|
+
# reviewStatus``. * For `minDuration` and `maxDuration`, the value is in the
|
1335
|
+
# form of `"`duration`s"`. Only seconds are supported with millisecond
|
1336
|
+
# granularity. * For `updateTime`, a creative resource's field value reflects
|
1337
|
+
# the last time that a creative has been updated, which includes updates made by
|
1338
|
+
# the system (e.g. creative review updates). * There may be multiple `
|
1339
|
+
# lineItemIds` restrictions in order to search against multiple possible line
|
1340
|
+
# item IDs. * There may be multiple `creativeId` restrictions in order to search
|
1341
|
+
# against multiple possible creative IDs. Examples: * All native creatives: `
|
1342
|
+
# creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or
|
1343
|
+
# 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="
|
1344
|
+
# 300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by
|
1345
|
+
# AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="
|
1346
|
+
# true" AND minDuration="5.2s" AND (exchangeReviewStatus="
|
1346
1347
|
# EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="
|
1347
1348
|
# EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are
|
1348
1349
|
# associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (
|
1349
1350
|
# lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `
|
1350
|
-
# creativeId=1 OR creativeId=2`
|
1351
|
-
#
|
1351
|
+
# creativeId=1 OR creativeId=2` * All creatives with an update time greater than
|
1352
|
+
# or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
|
1353
|
+
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
1352
1354
|
# @param [String] order_by
|
1353
1355
|
# Field by which to sort the list. Acceptable values are: * `creativeId` (
|
1354
1356
|
# default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first,
|
@@ -4542,6 +4544,222 @@ module Google
|
|
4542
4544
|
execute_or_queue_command(command, &block)
|
4543
4545
|
end
|
4544
4546
|
|
4547
|
+
# Creates a new guaranteed order. Returns the newly created guaranteed order if
|
4548
|
+
# successful.
|
4549
|
+
# @param [Google::Apis::DisplayvideoV1::GuaranteedOrder] guaranteed_order_object
|
4550
|
+
# @param [Fixnum] advertiser_id
|
4551
|
+
# The ID of the advertiser that the request is being made within.
|
4552
|
+
# @param [Fixnum] partner_id
|
4553
|
+
# The ID of the partner that the request is being made within.
|
4554
|
+
# @param [String] fields
|
4555
|
+
# Selector specifying which fields to include in a partial response.
|
4556
|
+
# @param [String] quota_user
|
4557
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4558
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4559
|
+
# @param [Google::Apis::RequestOptions] options
|
4560
|
+
# Request-specific options
|
4561
|
+
#
|
4562
|
+
# @yield [result, err] Result & error if block supplied
|
4563
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
|
4564
|
+
# @yieldparam err [StandardError] error object if request failed
|
4565
|
+
#
|
4566
|
+
# @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
|
4567
|
+
#
|
4568
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4569
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4570
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4571
|
+
def create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4572
|
+
command = make_simple_command(:post, 'v1/guaranteedOrders', options)
|
4573
|
+
command.request_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
4574
|
+
command.request_object = guaranteed_order_object
|
4575
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
4576
|
+
command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
|
4577
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4578
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
4579
|
+
command.query['fields'] = fields unless fields.nil?
|
4580
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4581
|
+
execute_or_queue_command(command, &block)
|
4582
|
+
end
|
4583
|
+
|
4584
|
+
# Edits read advertisers of a guaranteed order.
|
4585
|
+
# @param [String] guaranteed_order_id
|
4586
|
+
# Required. The ID of the guaranteed order to edit. The ID is of the format ``
|
4587
|
+
# exchange`-`legacy_guaranteed_order_id``
|
4588
|
+
# @param [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsRequest] edit_guaranteed_order_read_accessors_request_object
|
4589
|
+
# @param [String] fields
|
4590
|
+
# Selector specifying which fields to include in a partial response.
|
4591
|
+
# @param [String] quota_user
|
4592
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4593
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4594
|
+
# @param [Google::Apis::RequestOptions] options
|
4595
|
+
# Request-specific options
|
4596
|
+
#
|
4597
|
+
# @yield [result, err] Result & error if block supplied
|
4598
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse] parsed result object
|
4599
|
+
# @yieldparam err [StandardError] error object if request failed
|
4600
|
+
#
|
4601
|
+
# @return [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse]
|
4602
|
+
#
|
4603
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4604
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4605
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4606
|
+
def edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4607
|
+
command = make_simple_command(:post, 'v1/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors', options)
|
4608
|
+
command.request_representation = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsRequest::Representation
|
4609
|
+
command.request_object = edit_guaranteed_order_read_accessors_request_object
|
4610
|
+
command.response_representation = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse::Representation
|
4611
|
+
command.response_class = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse
|
4612
|
+
command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
|
4613
|
+
command.query['fields'] = fields unless fields.nil?
|
4614
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4615
|
+
execute_or_queue_command(command, &block)
|
4616
|
+
end
|
4617
|
+
|
4618
|
+
# Gets a guaranteed order.
|
4619
|
+
# @param [String] guaranteed_order_id
|
4620
|
+
# Required. The ID of the guaranteed order to fetch. The ID is of the format ``
|
4621
|
+
# exchange`-`legacy_guaranteed_order_id``
|
4622
|
+
# @param [Fixnum] advertiser_id
|
4623
|
+
# The ID of the advertiser that has access to the guaranteed order.
|
4624
|
+
# @param [Fixnum] partner_id
|
4625
|
+
# The ID of the partner that has access to the guaranteed order.
|
4626
|
+
# @param [String] fields
|
4627
|
+
# Selector specifying which fields to include in a partial response.
|
4628
|
+
# @param [String] quota_user
|
4629
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4630
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4631
|
+
# @param [Google::Apis::RequestOptions] options
|
4632
|
+
# Request-specific options
|
4633
|
+
#
|
4634
|
+
# @yield [result, err] Result & error if block supplied
|
4635
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
|
4636
|
+
# @yieldparam err [StandardError] error object if request failed
|
4637
|
+
#
|
4638
|
+
# @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
|
4639
|
+
#
|
4640
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4641
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4642
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4643
|
+
def get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4644
|
+
command = make_simple_command(:get, 'v1/guaranteedOrders/{+guaranteedOrderId}', options)
|
4645
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
4646
|
+
command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
|
4647
|
+
command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
|
4648
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4649
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
4650
|
+
command.query['fields'] = fields unless fields.nil?
|
4651
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4652
|
+
execute_or_queue_command(command, &block)
|
4653
|
+
end
|
4654
|
+
|
4655
|
+
# Lists guaranteed orders that are accessible to the current user. The order is
|
4656
|
+
# defined by the order_by parameter. If a filter by entity_status is not
|
4657
|
+
# specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will
|
4658
|
+
# not be included in the results.
|
4659
|
+
# @param [Fixnum] advertiser_id
|
4660
|
+
# The ID of the advertiser that has access to the guaranteed order.
|
4661
|
+
# @param [String] filter
|
4662
|
+
# Allows filtering by guaranteed order properties. * Filter expressions are made
|
4663
|
+
# up of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
|
4664
|
+
# logical operators. A sequence of restrictions implicitly uses `AND`. * A
|
4665
|
+
# restriction has the form of ``field` `operator` `value``. * The operator must
|
4666
|
+
# be `EQUALS (=)`. * Supported fields: - `guaranteed_order_id` - `exchange` - `
|
4667
|
+
# display_name` - `status.entityStatus` Examples: * All active guaranteed orders:
|
4668
|
+
# `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to
|
4669
|
+
# Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER"
|
4670
|
+
# OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more
|
4671
|
+
# than 500 characters.
|
4672
|
+
# @param [String] order_by
|
4673
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
4674
|
+
# default) The default sorting order is ascending. To specify descending order
|
4675
|
+
# for a field, a suffix "desc" should be added to the field name. For example, `
|
4676
|
+
# displayName desc`.
|
4677
|
+
# @param [Fixnum] page_size
|
4678
|
+
# Requested page size. Must be between `1` and `100`. If unspecified or greater
|
4679
|
+
# than `100` will default to `100`.
|
4680
|
+
# @param [String] page_token
|
4681
|
+
# A token identifying a page of results the server should return. Typically,
|
4682
|
+
# this is the value of next_page_token returned from the previous call to `
|
4683
|
+
# ListGuaranteedOrders` method. If not specified, the first page of results will
|
4684
|
+
# be returned.
|
4685
|
+
# @param [Fixnum] partner_id
|
4686
|
+
# The ID of the partner that has access to the guaranteed order.
|
4687
|
+
# @param [String] fields
|
4688
|
+
# Selector specifying which fields to include in a partial response.
|
4689
|
+
# @param [String] quota_user
|
4690
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4691
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4692
|
+
# @param [Google::Apis::RequestOptions] options
|
4693
|
+
# Request-specific options
|
4694
|
+
#
|
4695
|
+
# @yield [result, err] Result & error if block supplied
|
4696
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse] parsed result object
|
4697
|
+
# @yieldparam err [StandardError] error object if request failed
|
4698
|
+
#
|
4699
|
+
# @return [Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse]
|
4700
|
+
#
|
4701
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4702
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4703
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4704
|
+
def list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4705
|
+
command = make_simple_command(:get, 'v1/guaranteedOrders', options)
|
4706
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse::Representation
|
4707
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse
|
4708
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4709
|
+
command.query['filter'] = filter unless filter.nil?
|
4710
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
4711
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4712
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4713
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
4714
|
+
command.query['fields'] = fields unless fields.nil?
|
4715
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4716
|
+
execute_or_queue_command(command, &block)
|
4717
|
+
end
|
4718
|
+
|
4719
|
+
# Updates an existing guaranteed order. Returns the updated guaranteed order if
|
4720
|
+
# successful.
|
4721
|
+
# @param [String] guaranteed_order_id
|
4722
|
+
# Output only. The unique identifier of the guaranteed order. The guaranteed
|
4723
|
+
# order IDs have the format ``exchange`-`legacy_guaranteed_order_id``.
|
4724
|
+
# @param [Google::Apis::DisplayvideoV1::GuaranteedOrder] guaranteed_order_object
|
4725
|
+
# @param [Fixnum] advertiser_id
|
4726
|
+
# The ID of the advertiser that the request is being made within.
|
4727
|
+
# @param [Fixnum] partner_id
|
4728
|
+
# The ID of the partner that the request is being made within.
|
4729
|
+
# @param [String] update_mask
|
4730
|
+
# Required. The mask to control which fields to update.
|
4731
|
+
# @param [String] fields
|
4732
|
+
# Selector specifying which fields to include in a partial response.
|
4733
|
+
# @param [String] quota_user
|
4734
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4735
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4736
|
+
# @param [Google::Apis::RequestOptions] options
|
4737
|
+
# Request-specific options
|
4738
|
+
#
|
4739
|
+
# @yield [result, err] Result & error if block supplied
|
4740
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
|
4741
|
+
# @yieldparam err [StandardError] error object if request failed
|
4742
|
+
#
|
4743
|
+
# @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
|
4744
|
+
#
|
4745
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4746
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4747
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4748
|
+
def patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4749
|
+
command = make_simple_command(:patch, 'v1/guaranteedOrders/{+guaranteedOrderId}', options)
|
4750
|
+
command.request_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
4751
|
+
command.request_object = guaranteed_order_object
|
4752
|
+
command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
|
4753
|
+
command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
|
4754
|
+
command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
|
4755
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4756
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
4757
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
4758
|
+
command.query['fields'] = fields unless fields.nil?
|
4759
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4760
|
+
execute_or_queue_command(command, &block)
|
4761
|
+
end
|
4762
|
+
|
4545
4763
|
# Creates a new inventory source group. Returns the newly created inventory
|
4546
4764
|
# source group if successful.
|
4547
4765
|
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
@@ -4957,6 +5175,77 @@ module Google
|
|
4957
5175
|
execute_or_queue_command(command, &block)
|
4958
5176
|
end
|
4959
5177
|
|
5178
|
+
# Creates a new inventory source. Returns the newly created inventory source if
|
5179
|
+
# successful.
|
5180
|
+
# @param [Google::Apis::DisplayvideoV1::InventorySource] inventory_source_object
|
5181
|
+
# @param [Fixnum] advertiser_id
|
5182
|
+
# The ID of the advertiser that the request is being made within.
|
5183
|
+
# @param [Fixnum] partner_id
|
5184
|
+
# The ID of the partner that the request is being made within.
|
5185
|
+
# @param [String] fields
|
5186
|
+
# Selector specifying which fields to include in a partial response.
|
5187
|
+
# @param [String] quota_user
|
5188
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5189
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5190
|
+
# @param [Google::Apis::RequestOptions] options
|
5191
|
+
# Request-specific options
|
5192
|
+
#
|
5193
|
+
# @yield [result, err] Result & error if block supplied
|
5194
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
|
5195
|
+
# @yieldparam err [StandardError] error object if request failed
|
5196
|
+
#
|
5197
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySource]
|
5198
|
+
#
|
5199
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5200
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5201
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5202
|
+
def create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5203
|
+
command = make_simple_command(:post, 'v1/inventorySources', options)
|
5204
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
5205
|
+
command.request_object = inventory_source_object
|
5206
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
5207
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySource
|
5208
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
5209
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
5210
|
+
command.query['fields'] = fields unless fields.nil?
|
5211
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5212
|
+
execute_or_queue_command(command, &block)
|
5213
|
+
end
|
5214
|
+
|
5215
|
+
# Edits read/write accessors of an inventory source. Returns the updated
|
5216
|
+
# read_write_accessors for the inventory source.
|
5217
|
+
# @param [Fixnum] inventory_source_id
|
5218
|
+
# Required. The ID of inventory source to update.
|
5219
|
+
# @param [Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequest] edit_inventory_source_read_write_accessors_request_object
|
5220
|
+
# @param [String] fields
|
5221
|
+
# Selector specifying which fields to include in a partial response.
|
5222
|
+
# @param [String] quota_user
|
5223
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5224
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5225
|
+
# @param [Google::Apis::RequestOptions] options
|
5226
|
+
# Request-specific options
|
5227
|
+
#
|
5228
|
+
# @yield [result, err] Result & error if block supplied
|
5229
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceAccessors] parsed result object
|
5230
|
+
# @yieldparam err [StandardError] error object if request failed
|
5231
|
+
#
|
5232
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySourceAccessors]
|
5233
|
+
#
|
5234
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5235
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5236
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5237
|
+
def edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5238
|
+
command = make_simple_command(:post, 'v1/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors', options)
|
5239
|
+
command.request_representation = Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequest::Representation
|
5240
|
+
command.request_object = edit_inventory_source_read_write_accessors_request_object
|
5241
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceAccessors::Representation
|
5242
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceAccessors
|
5243
|
+
command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
|
5244
|
+
command.query['fields'] = fields unless fields.nil?
|
5245
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5246
|
+
execute_or_queue_command(command, &block)
|
5247
|
+
end
|
5248
|
+
|
4960
5249
|
# Gets an inventory source.
|
4961
5250
|
# @param [Fixnum] inventory_source_id
|
4962
5251
|
# Required. The ID of the inventory source to fetch.
|
@@ -5056,6 +5345,49 @@ module Google
|
|
5056
5345
|
execute_or_queue_command(command, &block)
|
5057
5346
|
end
|
5058
5347
|
|
5348
|
+
# Updates an existing inventory source. Returns the updated inventory source if
|
5349
|
+
# successful.
|
5350
|
+
# @param [Fixnum] inventory_source_id
|
5351
|
+
# Output only. The unique ID of the inventory source. Assigned by the system.
|
5352
|
+
# @param [Google::Apis::DisplayvideoV1::InventorySource] inventory_source_object
|
5353
|
+
# @param [Fixnum] advertiser_id
|
5354
|
+
# The ID of the advertiser that the request is being made within.
|
5355
|
+
# @param [Fixnum] partner_id
|
5356
|
+
# The ID of the partner that the request is being made within.
|
5357
|
+
# @param [String] update_mask
|
5358
|
+
# Required. The mask to control which fields to update.
|
5359
|
+
# @param [String] fields
|
5360
|
+
# Selector specifying which fields to include in a partial response.
|
5361
|
+
# @param [String] quota_user
|
5362
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5363
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5364
|
+
# @param [Google::Apis::RequestOptions] options
|
5365
|
+
# Request-specific options
|
5366
|
+
#
|
5367
|
+
# @yield [result, err] Result & error if block supplied
|
5368
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
|
5369
|
+
# @yieldparam err [StandardError] error object if request failed
|
5370
|
+
#
|
5371
|
+
# @return [Google::Apis::DisplayvideoV1::InventorySource]
|
5372
|
+
#
|
5373
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5374
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5375
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5376
|
+
def patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5377
|
+
command = make_simple_command(:patch, 'v1/inventorySources/{+inventorySourceId}', options)
|
5378
|
+
command.request_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
5379
|
+
command.request_object = inventory_source_object
|
5380
|
+
command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
5381
|
+
command.response_class = Google::Apis::DisplayvideoV1::InventorySource
|
5382
|
+
command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
|
5383
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
5384
|
+
command.query['partnerId'] = partner_id unless partner_id.nil?
|
5385
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
5386
|
+
command.query['fields'] = fields unless fields.nil?
|
5387
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5388
|
+
execute_or_queue_command(command, &block)
|
5389
|
+
end
|
5390
|
+
|
5059
5391
|
# Downloads media. Download is supported on the URI `/download/`resource_name=**`
|
5060
5392
|
# ?alt=media.` **Note**: Download requests will not be successful without
|
5061
5393
|
# including `alt=media` query string.
|