google-apis-displayvideo_v2 0.8.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -3806,6 +3806,373 @@ module Google
|
|
3806
3806
|
execute_or_queue_command(command, &block)
|
3807
3807
|
end
|
3808
3808
|
|
3809
|
+
# Gets a YouTube ad group ad.
|
3810
|
+
# @param [Fixnum] advertiser_id
|
3811
|
+
# Required. The ID of the advertiser this ad group ad belongs to.
|
3812
|
+
# @param [Fixnum] youtube_ad_group_ad_id
|
3813
|
+
# Required. The ID of the ad group ad to fetch.
|
3814
|
+
# @param [String] fields
|
3815
|
+
# Selector specifying which fields to include in a partial response.
|
3816
|
+
# @param [String] quota_user
|
3817
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3818
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3819
|
+
# @param [Google::Apis::RequestOptions] options
|
3820
|
+
# Request-specific options
|
3821
|
+
#
|
3822
|
+
# @yield [result, err] Result & error if block supplied
|
3823
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::YoutubeAdGroupAd] parsed result object
|
3824
|
+
# @yieldparam err [StandardError] error object if request failed
|
3825
|
+
#
|
3826
|
+
# @return [Google::Apis::DisplayvideoV2::YoutubeAdGroupAd]
|
3827
|
+
#
|
3828
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3829
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3830
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3831
|
+
def get_advertiser_youtube_ad_group_ad(advertiser_id, youtube_ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
|
3832
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds/{+youtubeAdGroupAdId}', options)
|
3833
|
+
command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd::Representation
|
3834
|
+
command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd
|
3835
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3836
|
+
command.params['youtubeAdGroupAdId'] = youtube_ad_group_ad_id unless youtube_ad_group_ad_id.nil?
|
3837
|
+
command.query['fields'] = fields unless fields.nil?
|
3838
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3839
|
+
execute_or_queue_command(command, &block)
|
3840
|
+
end
|
3841
|
+
|
3842
|
+
# Lists YouTube ad group ads.
|
3843
|
+
# @param [Fixnum] advertiser_id
|
3844
|
+
# Required. The ID of the advertiser the ad groups belongs to.
|
3845
|
+
# @param [String] filter
|
3846
|
+
# Allows filtering by custom YouTube ad group ad fields. Supported syntax: *
|
3847
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
3848
|
+
# be combined by `AND` and `OR`. Only the restrictions for * the same field can
|
3849
|
+
# be combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A
|
3850
|
+
# restriction has the form of ``field` `operator` `value``. * The operator must
|
3851
|
+
# be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `
|
3852
|
+
# entityStatus` - `adGroupAdId` Examples: * All ad group ads under an ad group: `
|
3853
|
+
# adGroupId="1234"` and its * entityStatus is `ENTITY_STATUS_ACTIVE` or `
|
3854
|
+
# ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
3855
|
+
# ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should
|
3856
|
+
# be no more than 500 characters.
|
3857
|
+
# @param [String] order_by
|
3858
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
3859
|
+
# default) * `entityStatus` The default sorting order is ascending. To specify
|
3860
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
3861
|
+
# name. Example: `displayName desc`.
|
3862
|
+
# @param [Fixnum] page_size
|
3863
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
3864
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
3865
|
+
# specified.
|
3866
|
+
# @param [String] page_token
|
3867
|
+
# A token identifying a page of results the server should return. Typically,
|
3868
|
+
# this is the value of next_page_token returned from the previous call to `
|
3869
|
+
# ListYoutubeAdGroupAds` method. If not specified, the first page of results
|
3870
|
+
# will be returned.
|
3871
|
+
# @param [String] fields
|
3872
|
+
# Selector specifying which fields to include in a partial response.
|
3873
|
+
# @param [String] quota_user
|
3874
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3875
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3876
|
+
# @param [Google::Apis::RequestOptions] options
|
3877
|
+
# Request-specific options
|
3878
|
+
#
|
3879
|
+
# @yield [result, err] Result & error if block supplied
|
3880
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse] parsed result object
|
3881
|
+
# @yieldparam err [StandardError] error object if request failed
|
3882
|
+
#
|
3883
|
+
# @return [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse]
|
3884
|
+
#
|
3885
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3886
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3887
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3888
|
+
def list_advertiser_youtube_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3889
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds', options)
|
3890
|
+
command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse::Representation
|
3891
|
+
command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse
|
3892
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3893
|
+
command.query['filter'] = filter unless filter.nil?
|
3894
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3895
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3896
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3897
|
+
command.query['fields'] = fields unless fields.nil?
|
3898
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3899
|
+
execute_or_queue_command(command, &block)
|
3900
|
+
end
|
3901
|
+
|
3902
|
+
# Lists assigned targeting options for multiple YouTube ad groups across
|
3903
|
+
# targeting types.
|
3904
|
+
# @param [Fixnum] advertiser_id
|
3905
|
+
# Required. The ID of the advertiser the line items belongs to.
|
3906
|
+
# @param [String] filter
|
3907
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
3908
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
3909
|
+
# be combined by the logical operator `OR` on the same field. * A restriction
|
3910
|
+
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
3911
|
+
# )`. * Supported fields: - `targetingType` Examples: * AssignedTargetingOptions
|
3912
|
+
# of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or
|
3913
|
+
# TARGETING_TYPE_YOUTUBE_CHANNEL `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO"
|
3914
|
+
# OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field
|
3915
|
+
# should be no more than 500 characters.
|
3916
|
+
# @param [String] order_by
|
3917
|
+
# Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (
|
3918
|
+
# default) * `assignedTargetingOption.targetingType` The default sorting order
|
3919
|
+
# is ascending. To specify descending order for a field, a suffix "desc" should
|
3920
|
+
# be added to the field name. Example: `targetingType desc`.
|
3921
|
+
# @param [Fixnum] page_size
|
3922
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
3923
|
+
# unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if
|
3924
|
+
# an invalid value is specified.
|
3925
|
+
# @param [String] page_token
|
3926
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
3927
|
+
# is the value of next_page_token returned from the previous call to the `
|
3928
|
+
# BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first
|
3929
|
+
# page of results will be returned.
|
3930
|
+
# @param [Array<Fixnum>, Fixnum] youtube_ad_group_ids
|
3931
|
+
# Required. The IDs of the youtube ad groups to list assigned targeting options
|
3932
|
+
# for.
|
3933
|
+
# @param [String] fields
|
3934
|
+
# Selector specifying which fields to include in a partial response.
|
3935
|
+
# @param [String] quota_user
|
3936
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3937
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3938
|
+
# @param [Google::Apis::RequestOptions] options
|
3939
|
+
# Request-specific options
|
3940
|
+
#
|
3941
|
+
# @yield [result, err] Result & error if block supplied
|
3942
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse] parsed result object
|
3943
|
+
# @yieldparam err [StandardError] error object if request failed
|
3944
|
+
#
|
3945
|
+
# @return [Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse]
|
3946
|
+
#
|
3947
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3948
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3949
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3950
|
+
def bulk_advertiser_youtube_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, youtube_ad_group_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3951
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions', options)
|
3952
|
+
command.response_representation = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse::Representation
|
3953
|
+
command.response_class = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse
|
3954
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3955
|
+
command.query['filter'] = filter unless filter.nil?
|
3956
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3957
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3958
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3959
|
+
command.query['youtubeAdGroupIds'] = youtube_ad_group_ids unless youtube_ad_group_ids.nil?
|
3960
|
+
command.query['fields'] = fields unless fields.nil?
|
3961
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3962
|
+
execute_or_queue_command(command, &block)
|
3963
|
+
end
|
3964
|
+
|
3965
|
+
# Gets a YouTube ad group.
|
3966
|
+
# @param [Fixnum] advertiser_id
|
3967
|
+
# Required. The ID of the advertiser this ad group belongs to.
|
3968
|
+
# @param [Fixnum] youtube_ad_group_id
|
3969
|
+
# Required. The ID of the ad group to fetch.
|
3970
|
+
# @param [String] fields
|
3971
|
+
# Selector specifying which fields to include in a partial response.
|
3972
|
+
# @param [String] quota_user
|
3973
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3974
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3975
|
+
# @param [Google::Apis::RequestOptions] options
|
3976
|
+
# Request-specific options
|
3977
|
+
#
|
3978
|
+
# @yield [result, err] Result & error if block supplied
|
3979
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::YoutubeAdGroup] parsed result object
|
3980
|
+
# @yieldparam err [StandardError] error object if request failed
|
3981
|
+
#
|
3982
|
+
# @return [Google::Apis::DisplayvideoV2::YoutubeAdGroup]
|
3983
|
+
#
|
3984
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3985
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3986
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3987
|
+
def get_advertiser_youtube_ad_group(advertiser_id, youtube_ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
|
3988
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}', options)
|
3989
|
+
command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroup::Representation
|
3990
|
+
command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroup
|
3991
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3992
|
+
command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
|
3993
|
+
command.query['fields'] = fields unless fields.nil?
|
3994
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3995
|
+
execute_or_queue_command(command, &block)
|
3996
|
+
end
|
3997
|
+
|
3998
|
+
# Lists YouTube ad groups.
|
3999
|
+
# @param [Fixnum] advertiser_id
|
4000
|
+
# Required. The ID of the advertiser the ad groups belongs to.
|
4001
|
+
# @param [String] filter
|
4002
|
+
# Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter
|
4003
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
4004
|
+
# combined by `AND` and `OR`. Only the restrictions for * the same field can be
|
4005
|
+
# combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A
|
4006
|
+
# restriction has the form of ``field` `operator` `value``. * The operator must
|
4007
|
+
# be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `
|
4008
|
+
# entityStatus` - `lineItemId` - `adGroupFormat` Examples: * All ad groups under
|
4009
|
+
# an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `
|
4010
|
+
# ENTITY_STATUS_PAUSED` and `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad
|
4011
|
+
# groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
4012
|
+
# entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="
|
4013
|
+
# YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"` The length of this field
|
4014
|
+
# should be no more than 500 characters.
|
4015
|
+
# @param [String] order_by
|
4016
|
+
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
4017
|
+
# default) * `entityStatus` The default sorting order is ascending. To specify
|
4018
|
+
# descending order for a field, a suffix "desc" should be added to the field
|
4019
|
+
# name. Example: `displayName desc`.
|
4020
|
+
# @param [Fixnum] page_size
|
4021
|
+
# Requested page size. Must be between `1` and `200`. If unspecified will
|
4022
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
4023
|
+
# specified.
|
4024
|
+
# @param [String] page_token
|
4025
|
+
# A token identifying a page of results the server should return. Typically,
|
4026
|
+
# this is the value of next_page_token returned from the previous call to `
|
4027
|
+
# ListYoutubeAdGroups` method. If not specified, the first page of results will
|
4028
|
+
# be returned.
|
4029
|
+
# @param [String] fields
|
4030
|
+
# Selector specifying which fields to include in a partial response.
|
4031
|
+
# @param [String] quota_user
|
4032
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4033
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4034
|
+
# @param [Google::Apis::RequestOptions] options
|
4035
|
+
# Request-specific options
|
4036
|
+
#
|
4037
|
+
# @yield [result, err] Result & error if block supplied
|
4038
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse] parsed result object
|
4039
|
+
# @yieldparam err [StandardError] error object if request failed
|
4040
|
+
#
|
4041
|
+
# @return [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse]
|
4042
|
+
#
|
4043
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4044
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4045
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4046
|
+
def list_advertiser_youtube_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4047
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups', options)
|
4048
|
+
command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse::Representation
|
4049
|
+
command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse
|
4050
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4051
|
+
command.query['filter'] = filter unless filter.nil?
|
4052
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
4053
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4054
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4055
|
+
command.query['fields'] = fields unless fields.nil?
|
4056
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4057
|
+
execute_or_queue_command(command, &block)
|
4058
|
+
end
|
4059
|
+
|
4060
|
+
# Gets a single targeting option assigned to a YouTube ad group. Inherited
|
4061
|
+
# targeting is not included.
|
4062
|
+
# @param [Fixnum] advertiser_id
|
4063
|
+
# Required. The ID of the advertiser the ad group belongs to.
|
4064
|
+
# @param [Fixnum] youtube_ad_group_id
|
4065
|
+
# Required. The ID of the ad group the assigned targeting option belongs to.
|
4066
|
+
# @param [String] targeting_type
|
4067
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
4068
|
+
# targeting types include: * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_AGE_RANGE`
|
4069
|
+
# * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
4070
|
+
# TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_APP` *
|
4071
|
+
# `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_KEYWORD` * `
|
4072
|
+
# TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_SESSION_POSITION` * `
|
4073
|
+
# TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
|
4074
|
+
# @param [String] assigned_targeting_option_id
|
4075
|
+
# Required. An identifier unique to the targeting type in this line item that
|
4076
|
+
# identifies the assigned targeting option being requested.
|
4077
|
+
# @param [String] fields
|
4078
|
+
# Selector specifying which fields to include in a partial response.
|
4079
|
+
# @param [String] quota_user
|
4080
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4081
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4082
|
+
# @param [Google::Apis::RequestOptions] options
|
4083
|
+
# Request-specific options
|
4084
|
+
#
|
4085
|
+
# @yield [result, err] Result & error if block supplied
|
4086
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
|
4087
|
+
# @yieldparam err [StandardError] error object if request failed
|
4088
|
+
#
|
4089
|
+
# @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
|
4090
|
+
#
|
4091
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4092
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4093
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4094
|
+
def get_advertiser_youtube_ad_group_targeting_type_assigned_targeting_option(advertiser_id, youtube_ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
|
4095
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
4096
|
+
command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
|
4097
|
+
command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
|
4098
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4099
|
+
command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
|
4100
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
4101
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
4102
|
+
command.query['fields'] = fields unless fields.nil?
|
4103
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4104
|
+
execute_or_queue_command(command, &block)
|
4105
|
+
end
|
4106
|
+
|
4107
|
+
# Lists the targeting options assigned to a YouTube ad group. Inherited
|
4108
|
+
# targeting is not included.
|
4109
|
+
# @param [Fixnum] advertiser_id
|
4110
|
+
# Required. The ID of the advertiser the ad group belongs to.
|
4111
|
+
# @param [Fixnum] youtube_ad_group_id
|
4112
|
+
# Required. The ID of the ad group to list assigned targeting options for.
|
4113
|
+
# @param [String] targeting_type
|
4114
|
+
# Required. Identifies the type of assigned targeting options to list. Supported
|
4115
|
+
# targeting types include: * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_AGE_RANGE`
|
4116
|
+
# * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
4117
|
+
# TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_APP` *
|
4118
|
+
# `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_KEYWORD` * `
|
4119
|
+
# TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_SESSION_POSITION` * `
|
4120
|
+
# TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
|
4121
|
+
# @param [String] filter
|
4122
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
4123
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
4124
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
4125
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
4126
|
+
# fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOptions
|
4127
|
+
# with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"`
|
4128
|
+
# The length of this field should be no more than 500 characters.
|
4129
|
+
# @param [String] order_by
|
4130
|
+
# Field by which to sort the list. Acceptable values are: * `
|
4131
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
4132
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
4133
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
4134
|
+
# @param [Fixnum] page_size
|
4135
|
+
# Requested page size. Must be between `1` and `5000`. If unspecified will
|
4136
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
4137
|
+
# specified.
|
4138
|
+
# @param [String] page_token
|
4139
|
+
# A token identifying a page of results the server should return. Typically,
|
4140
|
+
# this is the value of next_page_token returned from the previous call to `
|
4141
|
+
# ListYoutubeAdGroupAssignedTargetingOptions` method. If not specified, the
|
4142
|
+
# first page of results will be returned.
|
4143
|
+
# @param [String] fields
|
4144
|
+
# Selector specifying which fields to include in a partial response.
|
4145
|
+
# @param [String] quota_user
|
4146
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4147
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4148
|
+
# @param [Google::Apis::RequestOptions] options
|
4149
|
+
# Request-specific options
|
4150
|
+
#
|
4151
|
+
# @yield [result, err] Result & error if block supplied
|
4152
|
+
# @yieldparam result [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse] parsed result object
|
4153
|
+
# @yieldparam err [StandardError] error object if request failed
|
4154
|
+
#
|
4155
|
+
# @return [Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse]
|
4156
|
+
#
|
4157
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4158
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4159
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4160
|
+
def list_advertiser_youtube_ad_group_targeting_type_assigned_targeting_options(advertiser_id, youtube_ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4161
|
+
command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
4162
|
+
command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse::Representation
|
4163
|
+
command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse
|
4164
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
4165
|
+
command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
|
4166
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
4167
|
+
command.query['filter'] = filter unless filter.nil?
|
4168
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
4169
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4170
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4171
|
+
command.query['fields'] = fields unless fields.nil?
|
4172
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4173
|
+
execute_or_queue_command(command, &block)
|
4174
|
+
end
|
4175
|
+
|
3809
4176
|
# Gets a combined audience.
|
3810
4177
|
# @param [Fixnum] combined_audience_id
|
3811
4178
|
# Required. The ID of the combined audience to fetch.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-displayvideo_v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-01-
|
11
|
+
date: 2023-01-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v2/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.10.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v2
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.
|
78
|
+
rubygems_version: 3.4.2
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Display & Video 360 API V2
|