google-apis-displayvideo_v1 0.4.0 → 0.9.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.
@@ -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.
|
@@ -1578,6 +1809,88 @@ module Google
|
|
1578
1809
|
execute_or_queue_command(command, &block)
|
1579
1810
|
end
|
1580
1811
|
|
1812
|
+
# List invoices for an advertiser.
|
1813
|
+
# @param [Fixnum] advertiser_id
|
1814
|
+
# Required. The ID of the advertiser to list invoices for.
|
1815
|
+
# @param [String] issue_month
|
1816
|
+
# Required. Month for which invoices are needed in the format YYYYMM.
|
1817
|
+
# @param [String] loi_sapin_invoice_type
|
1818
|
+
# Select type of invoice to query for Loi Sapin advertisers. Otherwise its
|
1819
|
+
# ignored.
|
1820
|
+
# @param [Fixnum] page_size
|
1821
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
1822
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
1823
|
+
# specified.
|
1824
|
+
# @param [String] page_token
|
1825
|
+
# A token identifying a page of results the server should return. Typically,
|
1826
|
+
# this is the value of [ListInvoicesResponse.next_page_token] returned from the
|
1827
|
+
# previous call to `ListInvoice` method. If not specified, the first page of
|
1828
|
+
# results will be returned.
|
1829
|
+
# @param [String] fields
|
1830
|
+
# Selector specifying which fields to include in a partial response.
|
1831
|
+
# @param [String] quota_user
|
1832
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1833
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1834
|
+
# @param [Google::Apis::RequestOptions] options
|
1835
|
+
# Request-specific options
|
1836
|
+
#
|
1837
|
+
# @yield [result, err] Result & error if block supplied
|
1838
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInvoicesResponse] parsed result object
|
1839
|
+
# @yieldparam err [StandardError] error object if request failed
|
1840
|
+
#
|
1841
|
+
# @return [Google::Apis::DisplayvideoV1::ListInvoicesResponse]
|
1842
|
+
#
|
1843
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1844
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1845
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1846
|
+
def list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1847
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/invoices', options)
|
1848
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListInvoicesResponse::Representation
|
1849
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListInvoicesResponse
|
1850
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1851
|
+
command.query['issueMonth'] = issue_month unless issue_month.nil?
|
1852
|
+
command.query['loiSapinInvoiceType'] = loi_sapin_invoice_type unless loi_sapin_invoice_type.nil?
|
1853
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1854
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1855
|
+
command.query['fields'] = fields unless fields.nil?
|
1856
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1857
|
+
execute_or_queue_command(command, &block)
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
# Lookup invoice currency for an advertiser.
|
1861
|
+
# @param [Fixnum] advertiser_id
|
1862
|
+
# Required. The ID of the advertiser to lookup currency for.
|
1863
|
+
# @param [String] invoice_month
|
1864
|
+
# Month for which currency is needed in the format YYYYMM. If not set Api would
|
1865
|
+
# return currency based on current settings.
|
1866
|
+
# @param [String] fields
|
1867
|
+
# Selector specifying which fields to include in a partial response.
|
1868
|
+
# @param [String] quota_user
|
1869
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1870
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1871
|
+
# @param [Google::Apis::RequestOptions] options
|
1872
|
+
# Request-specific options
|
1873
|
+
#
|
1874
|
+
# @yield [result, err] Result & error if block supplied
|
1875
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LookupInvoiceCurrencyResponse] parsed result object
|
1876
|
+
# @yieldparam err [StandardError] error object if request failed
|
1877
|
+
#
|
1878
|
+
# @return [Google::Apis::DisplayvideoV1::LookupInvoiceCurrencyResponse]
|
1879
|
+
#
|
1880
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1881
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1882
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1883
|
+
def lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1884
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency', options)
|
1885
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LookupInvoiceCurrencyResponse::Representation
|
1886
|
+
command.response_class = Google::Apis::DisplayvideoV1::LookupInvoiceCurrencyResponse
|
1887
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1888
|
+
command.query['invoiceMonth'] = invoice_month unless invoice_month.nil?
|
1889
|
+
command.query['fields'] = fields unless fields.nil?
|
1890
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1891
|
+
execute_or_queue_command(command, &block)
|
1892
|
+
end
|
1893
|
+
|
1581
1894
|
# Bulk edits targeting options under a single line item. The operation will
|
1582
1895
|
# delete the assigned targeting options provided in
|
1583
1896
|
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then
|
@@ -1750,6 +2063,43 @@ module Google
|
|
1750
2063
|
execute_or_queue_command(command, &block)
|
1751
2064
|
end
|
1752
2065
|
|
2066
|
+
# Creates a new line item with settings (including targeting) inherited from the
|
2067
|
+
# insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly
|
2068
|
+
# created line item if successful. There are default values based on the three
|
2069
|
+
# fields: * The insertion order's insertion_order_type * The insertion order's
|
2070
|
+
# automation_type * The given line_item_type
|
2071
|
+
# @param [Fixnum] advertiser_id
|
2072
|
+
# Required. The ID of the advertiser this line item belongs to.
|
2073
|
+
# @param [Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest] generate_default_line_item_request_object
|
2074
|
+
# @param [String] fields
|
2075
|
+
# Selector specifying which fields to include in a partial response.
|
2076
|
+
# @param [String] quota_user
|
2077
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2078
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2079
|
+
# @param [Google::Apis::RequestOptions] options
|
2080
|
+
# Request-specific options
|
2081
|
+
#
|
2082
|
+
# @yield [result, err] Result & error if block supplied
|
2083
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
2084
|
+
# @yieldparam err [StandardError] error object if request failed
|
2085
|
+
#
|
2086
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
2087
|
+
#
|
2088
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2089
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2090
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2091
|
+
def generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2092
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems:generateDefault', options)
|
2093
|
+
command.request_representation = Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest::Representation
|
2094
|
+
command.request_object = generate_default_line_item_request_object
|
2095
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
2096
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
2097
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2098
|
+
command.query['fields'] = fields unless fields.nil?
|
2099
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2100
|
+
execute_or_queue_command(command, &block)
|
2101
|
+
end
|
2102
|
+
|
1753
2103
|
# Gets a line item.
|
1754
2104
|
# @param [Fixnum] advertiser_id
|
1755
2105
|
# Required. The ID of the advertiser this line item belongs to.
|
@@ -1797,23 +2147,26 @@ module Google
|
|
1797
2147
|
# ). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)`
|
1798
2148
|
# or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must
|
1799
2149
|
# be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. *
|
1800
|
-
# Supported
|
2150
|
+
# Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `
|
1801
2151
|
# entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (
|
1802
2152
|
# input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `
|
1803
|
-
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ)
|
1804
|
-
#
|
1805
|
-
#
|
1806
|
-
#
|
1807
|
-
#
|
1808
|
-
#
|
1809
|
-
#
|
1810
|
-
#
|
1811
|
-
#
|
2153
|
+
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `
|
2154
|
+
# targetedChannelId` - `targetedNegativeKeywordListId` Examples: * All line
|
2155
|
+
# items under an insertion order: `insertionOrderId="1234"` * All `
|
2156
|
+
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `
|
2157
|
+
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=
|
2158
|
+
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND
|
2159
|
+
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight
|
2160
|
+
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All
|
2161
|
+
# line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
1812
2162
|
# warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less
|
1813
2163
|
# than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="
|
1814
2164
|
# 2020-11-04T18:54:47Z"` * All line items with an update time greater than or
|
1815
2165
|
# equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
|
1816
|
-
# 04T18:54:47Z"`
|
2166
|
+
# 04T18:54:47Z"` * All line items that are using both the specified channel and
|
2167
|
+
# specified negative keyword list in their targeting: `
|
2168
|
+
# targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of
|
2169
|
+
# this field should be no more than 500 characters.
|
1817
2170
|
# @param [String] order_by
|
1818
2171
|
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
1819
2172
|
# default) * "entityStatus" * “flight.dateRange.endDate” * "updateTime" The
|
@@ -2982,7 +3335,7 @@ module Google
|
|
2982
3335
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
2983
3336
|
# keywordValue desc`.
|
2984
3337
|
# @param [Fixnum] page_size
|
2985
|
-
# Requested page size. Must be between `1` and `
|
3338
|
+
# Requested page size. Must be between `1` and `1000`. If unspecified will
|
2986
3339
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
2987
3340
|
# specified.
|
2988
3341
|
# @param [String] page_token
|
@@ -3022,6 +3375,46 @@ module Google
|
|
3022
3375
|
execute_or_queue_command(command, &block)
|
3023
3376
|
end
|
3024
3377
|
|
3378
|
+
# Replaces all negative keywords in a single negative keyword list. The
|
3379
|
+
# operation will replace the keywords in a negative keyword list with keywords
|
3380
|
+
# provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
|
3381
|
+
# @param [Fixnum] advertiser_id
|
3382
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
3383
|
+
# list belongs.
|
3384
|
+
# @param [Fixnum] negative_keyword_list_id
|
3385
|
+
# Required. The ID of the parent negative keyword list to which the negative
|
3386
|
+
# keywords belong.
|
3387
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest] replace_negative_keywords_request_object
|
3388
|
+
# @param [String] fields
|
3389
|
+
# Selector specifying which fields to include in a partial response.
|
3390
|
+
# @param [String] quota_user
|
3391
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3392
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3393
|
+
# @param [Google::Apis::RequestOptions] options
|
3394
|
+
# Request-specific options
|
3395
|
+
#
|
3396
|
+
# @yield [result, err] Result & error if block supplied
|
3397
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse] parsed result object
|
3398
|
+
# @yieldparam err [StandardError] error object if request failed
|
3399
|
+
#
|
3400
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse]
|
3401
|
+
#
|
3402
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3403
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3404
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3405
|
+
def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3406
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
|
3407
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest::Representation
|
3408
|
+
command.request_object = replace_negative_keywords_request_object
|
3409
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse::Representation
|
3410
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse
|
3411
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3412
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
3413
|
+
command.query['fields'] = fields unless fields.nil?
|
3414
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3415
|
+
execute_or_queue_command(command, &block)
|
3416
|
+
end
|
3417
|
+
|
3025
3418
|
# Assigns a targeting option to an advertiser. Returns the assigned targeting
|
3026
3419
|
# option if successful.
|
3027
3420
|
# @param [Fixnum] advertiser_id
|
@@ -4738,7 +5131,7 @@ module Google
|
|
4738
5131
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
4739
5132
|
# urlOrAppId desc`.
|
4740
5133
|
# @param [Fixnum] page_size
|
4741
|
-
# Requested page size. Must be between `1` and `
|
5134
|
+
# Requested page size. Must be between `1` and `10000`. If unspecified will
|
4742
5135
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
4743
5136
|
# specified.
|
4744
5137
|
# @param [String] page_token
|
@@ -4779,6 +5172,44 @@ module Google
|
|
4779
5172
|
execute_or_queue_command(command, &block)
|
4780
5173
|
end
|
4781
5174
|
|
5175
|
+
# Replaces all of the sites under a single channel. The operation will replace
|
5176
|
+
# the sites under a channel with the sites provided in ReplaceSitesRequest.
|
5177
|
+
# new_sites.
|
5178
|
+
# @param [Fixnum] partner_id
|
5179
|
+
# The ID of the partner that owns the parent channel.
|
5180
|
+
# @param [Fixnum] channel_id
|
5181
|
+
# Required. The ID of the parent channel whose sites will be replaced.
|
5182
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceSitesRequest] replace_sites_request_object
|
5183
|
+
# @param [String] fields
|
5184
|
+
# Selector specifying which fields to include in a partial response.
|
5185
|
+
# @param [String] quota_user
|
5186
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5187
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5188
|
+
# @param [Google::Apis::RequestOptions] options
|
5189
|
+
# Request-specific options
|
5190
|
+
#
|
5191
|
+
# @yield [result, err] Result & error if block supplied
|
5192
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceSitesResponse] parsed result object
|
5193
|
+
# @yieldparam err [StandardError] error object if request failed
|
5194
|
+
#
|
5195
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceSitesResponse]
|
5196
|
+
#
|
5197
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5198
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5199
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5200
|
+
def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5201
|
+
command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
|
5202
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceSitesRequest::Representation
|
5203
|
+
command.request_object = replace_sites_request_object
|
5204
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceSitesResponse::Representation
|
5205
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceSitesResponse
|
5206
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
5207
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
5208
|
+
command.query['fields'] = fields unless fields.nil?
|
5209
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5210
|
+
execute_or_queue_command(command, &block)
|
5211
|
+
end
|
5212
|
+
|
4782
5213
|
# Assigns a targeting option to a partner. Returns the assigned targeting option
|
4783
5214
|
# if successful.
|
4784
5215
|
# @param [Fixnum] partner_id
|