google-apis-authorizedbuyersmarketplace_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb +2234 -0
- data/lib/google/apis/authorizedbuyersmarketplace_v1/gem_version.rb +28 -0
- data/lib/google/apis/authorizedbuyersmarketplace_v1/representations.rb +1035 -0
- data/lib/google/apis/authorizedbuyersmarketplace_v1/service.rb +1524 -0
- data/lib/google/apis/authorizedbuyersmarketplace_v1.rb +37 -0
- data/lib/google-apis-authorizedbuyersmarketplace_v1.rb +15 -0
- metadata +82 -0
|
@@ -0,0 +1,1524 @@
|
|
|
1
|
+
# Copyright 2020 Google LLC
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
require 'google/apis/core/base_service'
|
|
16
|
+
require 'google/apis/core/json_representation'
|
|
17
|
+
require 'google/apis/core/hashable'
|
|
18
|
+
require 'google/apis/errors'
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Apis
|
|
22
|
+
module AuthorizedbuyersmarketplaceV1
|
|
23
|
+
# Authorized Buyers Marketplace API
|
|
24
|
+
#
|
|
25
|
+
# The Authorized Buyers Marketplace API allows buyers programmatically discover
|
|
26
|
+
# inventory; propose, retrieve and negotiate deals with publishers.
|
|
27
|
+
#
|
|
28
|
+
# @example
|
|
29
|
+
# require 'google/apis/authorizedbuyersmarketplace_v1'
|
|
30
|
+
#
|
|
31
|
+
# Authorizedbuyersmarketplace = Google::Apis::AuthorizedbuyersmarketplaceV1 # Alias the module
|
|
32
|
+
# service = Authorizedbuyersmarketplace::AuthorizedBuyersMarketplaceService.new
|
|
33
|
+
#
|
|
34
|
+
# @see https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/
|
|
35
|
+
class AuthorizedBuyersMarketplaceService < Google::Apis::Core::BaseService
|
|
36
|
+
# @return [String]
|
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
39
|
+
attr_accessor :key
|
|
40
|
+
|
|
41
|
+
# @return [String]
|
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
44
|
+
attr_accessor :quota_user
|
|
45
|
+
|
|
46
|
+
def initialize
|
|
47
|
+
super('https://authorizedbuyersmarketplace.googleapis.com/', '',
|
|
48
|
+
client_name: 'google-apis-authorizedbuyersmarketplace_v1',
|
|
49
|
+
client_version: Google::Apis::AuthorizedbuyersmarketplaceV1::GEM_VERSION)
|
|
50
|
+
@batch_path = 'batch'
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Lists finalized deals. Use the URL path "/v1/buyers/`accountId`/finalizedDeals"
|
|
54
|
+
# to list finalized deals for the current buyer and its clients. Bidders can
|
|
55
|
+
# use the URL path "/v1/bidders/`accountId`/finalizedDeals" to list finalized
|
|
56
|
+
# deals for the bidder, its buyers and all their clients.
|
|
57
|
+
# @param [String] parent
|
|
58
|
+
# Required. The buyer to list the finalized deals for, in the format: `buyers/`
|
|
59
|
+
# accountId``. When used to list finalized deals for a bidder, its buyers and
|
|
60
|
+
# clients, in the format `bidders/`accountId``.
|
|
61
|
+
# @param [String] filter
|
|
62
|
+
# Optional query string using the [Cloud API list filtering syntax](https://
|
|
63
|
+
# developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported
|
|
64
|
+
# columns for filtering are: * deal.displayName * deal.dealType * deal.
|
|
65
|
+
# createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime *
|
|
66
|
+
# dealServingStatus
|
|
67
|
+
# @param [String] order_by
|
|
68
|
+
# An optional query string to sort finalized deals using the [Cloud API sorting
|
|
69
|
+
# syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
|
|
70
|
+
# If no sort order is specified, results will be returned in an arbitrary order.
|
|
71
|
+
# Supported columns for sorting are: * deal.displayName * deal.createTime * deal.
|
|
72
|
+
# updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.
|
|
73
|
+
# bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days *
|
|
74
|
+
# rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.
|
|
75
|
+
# mustBidRateCurrentMonth Example: 'deal.displayName, deal.updateTime desc'
|
|
76
|
+
# @param [Fixnum] page_size
|
|
77
|
+
# Requested page size. The server may return fewer results than requested. If
|
|
78
|
+
# requested more than 500, the server will return 500 results per page. If
|
|
79
|
+
# unspecified, the server will pick a default page size of 100.
|
|
80
|
+
# @param [String] page_token
|
|
81
|
+
# The page token as returned from ListFinalizedDealsResponse.
|
|
82
|
+
# @param [String] fields
|
|
83
|
+
# Selector specifying which fields to include in a partial response.
|
|
84
|
+
# @param [String] quota_user
|
|
85
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
86
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
87
|
+
# @param [Google::Apis::RequestOptions] options
|
|
88
|
+
# Request-specific options
|
|
89
|
+
#
|
|
90
|
+
# @yield [result, err] Result & error if block supplied
|
|
91
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse] parsed result object
|
|
92
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
93
|
+
#
|
|
94
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse]
|
|
95
|
+
#
|
|
96
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
97
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
98
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
99
|
+
def list_bidder_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
100
|
+
command = make_simple_command(:get, 'v1/{+parent}/finalizedDeals', options)
|
|
101
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse::Representation
|
|
102
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse
|
|
103
|
+
command.params['parent'] = parent unless parent.nil?
|
|
104
|
+
command.query['filter'] = filter unless filter.nil?
|
|
105
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
106
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
107
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
108
|
+
command.query['fields'] = fields unless fields.nil?
|
|
109
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
110
|
+
execute_or_queue_command(command, &block)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Gets an auction package given its name.
|
|
114
|
+
# @param [String] name
|
|
115
|
+
# Required. Name of auction package to get. Format: `buyers/`accountId`/
|
|
116
|
+
# auctionPackages/`auctionPackageId``
|
|
117
|
+
# @param [String] fields
|
|
118
|
+
# Selector specifying which fields to include in a partial response.
|
|
119
|
+
# @param [String] quota_user
|
|
120
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
121
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
122
|
+
# @param [Google::Apis::RequestOptions] options
|
|
123
|
+
# Request-specific options
|
|
124
|
+
#
|
|
125
|
+
# @yield [result, err] Result & error if block supplied
|
|
126
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage] parsed result object
|
|
127
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
128
|
+
#
|
|
129
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage]
|
|
130
|
+
#
|
|
131
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
132
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
133
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
134
|
+
def get_buyer_auction_package(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
135
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
136
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
|
|
137
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
|
|
138
|
+
command.params['name'] = name unless name.nil?
|
|
139
|
+
command.query['fields'] = fields unless fields.nil?
|
|
140
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
141
|
+
execute_or_queue_command(command, &block)
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# List the auction packages subscribed by a buyer and its clients.
|
|
145
|
+
# @param [String] parent
|
|
146
|
+
# Required. Name of the parent buyer that can access the auction package. Format:
|
|
147
|
+
# `buyers/`accountId``
|
|
148
|
+
# @param [Fixnum] page_size
|
|
149
|
+
# Requested page size. The server may return fewer results than requested. Max
|
|
150
|
+
# allowed page size is 500.
|
|
151
|
+
# @param [String] page_token
|
|
152
|
+
# The page token as returned. ListAuctionPackagesResponse.nextPageToken
|
|
153
|
+
# @param [String] fields
|
|
154
|
+
# Selector specifying which fields to include in a partial response.
|
|
155
|
+
# @param [String] quota_user
|
|
156
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
157
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
158
|
+
# @param [Google::Apis::RequestOptions] options
|
|
159
|
+
# Request-specific options
|
|
160
|
+
#
|
|
161
|
+
# @yield [result, err] Result & error if block supplied
|
|
162
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse] parsed result object
|
|
163
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
164
|
+
#
|
|
165
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse]
|
|
166
|
+
#
|
|
167
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
168
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
169
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
170
|
+
def list_buyer_auction_packages(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
171
|
+
command = make_simple_command(:get, 'v1/{+parent}/auctionPackages', options)
|
|
172
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse::Representation
|
|
173
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse
|
|
174
|
+
command.params['parent'] = parent unless parent.nil?
|
|
175
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
176
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
177
|
+
command.query['fields'] = fields unless fields.nil?
|
|
178
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
179
|
+
execute_or_queue_command(command, &block)
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# Subscribe to the auction package for the specified buyer. Once subscribed, the
|
|
183
|
+
# bidder will receive a call out for inventory matching the auction package
|
|
184
|
+
# targeting criteria with the auction package deal ID and the specified buyer.
|
|
185
|
+
# @param [String] name
|
|
186
|
+
# Required. Name of the auction package. Format: `buyers/`accountId`/
|
|
187
|
+
# auctionPackages/`auctionPackageId``
|
|
188
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeAuctionPackageRequest] subscribe_auction_package_request_object
|
|
189
|
+
# @param [String] fields
|
|
190
|
+
# Selector specifying which fields to include in a partial response.
|
|
191
|
+
# @param [String] quota_user
|
|
192
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
193
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
194
|
+
# @param [Google::Apis::RequestOptions] options
|
|
195
|
+
# Request-specific options
|
|
196
|
+
#
|
|
197
|
+
# @yield [result, err] Result & error if block supplied
|
|
198
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage] parsed result object
|
|
199
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
200
|
+
#
|
|
201
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage]
|
|
202
|
+
#
|
|
203
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
204
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
205
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
206
|
+
def subscribe_auction_package(name, subscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
207
|
+
command = make_simple_command(:post, 'v1/{+name}:subscribe', options)
|
|
208
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeAuctionPackageRequest::Representation
|
|
209
|
+
command.request_object = subscribe_auction_package_request_object
|
|
210
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
|
|
211
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
|
|
212
|
+
command.params['name'] = name unless name.nil?
|
|
213
|
+
command.query['fields'] = fields unless fields.nil?
|
|
214
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
215
|
+
execute_or_queue_command(command, &block)
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# Subscribe the specified clients of the buyer to the auction package. If a
|
|
219
|
+
# client in the list does not belong to the buyer, an error response will be
|
|
220
|
+
# returned, and all of the following clients in the list will not be subscribed.
|
|
221
|
+
# Subscribing an already subscribed client will have no effect.
|
|
222
|
+
# @param [String] auction_package
|
|
223
|
+
# Required. Name of the auction package. Format: `buyers/`accountId`/
|
|
224
|
+
# auctionPackages/`auctionPackageId``
|
|
225
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeClientsRequest] subscribe_clients_request_object
|
|
226
|
+
# @param [String] fields
|
|
227
|
+
# Selector specifying which fields to include in a partial response.
|
|
228
|
+
# @param [String] quota_user
|
|
229
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
230
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
231
|
+
# @param [Google::Apis::RequestOptions] options
|
|
232
|
+
# Request-specific options
|
|
233
|
+
#
|
|
234
|
+
# @yield [result, err] Result & error if block supplied
|
|
235
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage] parsed result object
|
|
236
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
237
|
+
#
|
|
238
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage]
|
|
239
|
+
#
|
|
240
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
241
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
242
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
243
|
+
def subscribe_auction_package_clients(auction_package, subscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
244
|
+
command = make_simple_command(:post, 'v1/{+auctionPackage}:subscribeClients', options)
|
|
245
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeClientsRequest::Representation
|
|
246
|
+
command.request_object = subscribe_clients_request_object
|
|
247
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
|
|
248
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
|
|
249
|
+
command.params['auctionPackage'] = auction_package unless auction_package.nil?
|
|
250
|
+
command.query['fields'] = fields unless fields.nil?
|
|
251
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
252
|
+
execute_or_queue_command(command, &block)
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Unsubscribe from the auction package for the specified buyer. Once
|
|
256
|
+
# unsubscribed, the bidder will no longer receive a call out for the auction
|
|
257
|
+
# package deal ID and the specified buyer.
|
|
258
|
+
# @param [String] name
|
|
259
|
+
# Required. Name of the auction package. Format: `buyers/`accountId`/
|
|
260
|
+
# auctionPackages/`auctionPackageId``
|
|
261
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeAuctionPackageRequest] unsubscribe_auction_package_request_object
|
|
262
|
+
# @param [String] fields
|
|
263
|
+
# Selector specifying which fields to include in a partial response.
|
|
264
|
+
# @param [String] quota_user
|
|
265
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
266
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
267
|
+
# @param [Google::Apis::RequestOptions] options
|
|
268
|
+
# Request-specific options
|
|
269
|
+
#
|
|
270
|
+
# @yield [result, err] Result & error if block supplied
|
|
271
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage] parsed result object
|
|
272
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
273
|
+
#
|
|
274
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage]
|
|
275
|
+
#
|
|
276
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
277
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
278
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
279
|
+
def unsubscribe_auction_package(name, unsubscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
280
|
+
command = make_simple_command(:post, 'v1/{+name}:unsubscribe', options)
|
|
281
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeAuctionPackageRequest::Representation
|
|
282
|
+
command.request_object = unsubscribe_auction_package_request_object
|
|
283
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
|
|
284
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
|
|
285
|
+
command.params['name'] = name unless name.nil?
|
|
286
|
+
command.query['fields'] = fields unless fields.nil?
|
|
287
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
288
|
+
execute_or_queue_command(command, &block)
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# Unsubscribe from the auction package for the specified clients of the buyer.
|
|
292
|
+
# Unsubscribing a client that is not subscribed will have no effect.
|
|
293
|
+
# @param [String] auction_package
|
|
294
|
+
# Required. Name of the auction package. Format: `buyers/`accountId`/
|
|
295
|
+
# auctionPackages/`auctionPackageId``
|
|
296
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeClientsRequest] unsubscribe_clients_request_object
|
|
297
|
+
# @param [String] fields
|
|
298
|
+
# Selector specifying which fields to include in a partial response.
|
|
299
|
+
# @param [String] quota_user
|
|
300
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
301
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
302
|
+
# @param [Google::Apis::RequestOptions] options
|
|
303
|
+
# Request-specific options
|
|
304
|
+
#
|
|
305
|
+
# @yield [result, err] Result & error if block supplied
|
|
306
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage] parsed result object
|
|
307
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
308
|
+
#
|
|
309
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage]
|
|
310
|
+
#
|
|
311
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
312
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
313
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
314
|
+
def unsubscribe_auction_package_clients(auction_package, unsubscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
315
|
+
command = make_simple_command(:post, 'v1/{+auctionPackage}:unsubscribeClients', options)
|
|
316
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeClientsRequest::Representation
|
|
317
|
+
command.request_object = unsubscribe_clients_request_object
|
|
318
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
|
|
319
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
|
|
320
|
+
command.params['auctionPackage'] = auction_package unless auction_package.nil?
|
|
321
|
+
command.query['fields'] = fields unless fields.nil?
|
|
322
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
323
|
+
execute_or_queue_command(command, &block)
|
|
324
|
+
end
|
|
325
|
+
|
|
326
|
+
# Activates an existing client. The state of the client will be updated to "
|
|
327
|
+
# ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
|
|
328
|
+
# @param [String] name
|
|
329
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId``
|
|
330
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientRequest] activate_client_request_object
|
|
331
|
+
# @param [String] fields
|
|
332
|
+
# Selector specifying which fields to include in a partial response.
|
|
333
|
+
# @param [String] quota_user
|
|
334
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
335
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
336
|
+
# @param [Google::Apis::RequestOptions] options
|
|
337
|
+
# Request-specific options
|
|
338
|
+
#
|
|
339
|
+
# @yield [result, err] Result & error if block supplied
|
|
340
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] parsed result object
|
|
341
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
342
|
+
#
|
|
343
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Client]
|
|
344
|
+
#
|
|
345
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
346
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
347
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
348
|
+
def activate_client(name, activate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
349
|
+
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
|
350
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientRequest::Representation
|
|
351
|
+
command.request_object = activate_client_request_object
|
|
352
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
353
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
|
|
354
|
+
command.params['name'] = name unless name.nil?
|
|
355
|
+
command.query['fields'] = fields unless fields.nil?
|
|
356
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
357
|
+
execute_or_queue_command(command, &block)
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
# Creates a new client.
|
|
361
|
+
# @param [String] parent
|
|
362
|
+
# Required. The name of the buyer. Format: `buyers/`accountId``
|
|
363
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] client_object
|
|
364
|
+
# @param [String] fields
|
|
365
|
+
# Selector specifying which fields to include in a partial response.
|
|
366
|
+
# @param [String] quota_user
|
|
367
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
368
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
369
|
+
# @param [Google::Apis::RequestOptions] options
|
|
370
|
+
# Request-specific options
|
|
371
|
+
#
|
|
372
|
+
# @yield [result, err] Result & error if block supplied
|
|
373
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] parsed result object
|
|
374
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
375
|
+
#
|
|
376
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Client]
|
|
377
|
+
#
|
|
378
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
379
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
380
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
381
|
+
def create_buyer_client(parent, client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
382
|
+
command = make_simple_command(:post, 'v1/{+parent}/clients', options)
|
|
383
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
384
|
+
command.request_object = client_object
|
|
385
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
386
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
|
|
387
|
+
command.params['parent'] = parent unless parent.nil?
|
|
388
|
+
command.query['fields'] = fields unless fields.nil?
|
|
389
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
390
|
+
execute_or_queue_command(command, &block)
|
|
391
|
+
end
|
|
392
|
+
|
|
393
|
+
# Deactivates an existing client. The state of the client will be updated to "
|
|
394
|
+
# INACTIVE". This method has no effect if the client is already in "INACTIVE"
|
|
395
|
+
# state.
|
|
396
|
+
# @param [String] name
|
|
397
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId``
|
|
398
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientRequest] deactivate_client_request_object
|
|
399
|
+
# @param [String] fields
|
|
400
|
+
# Selector specifying which fields to include in a partial response.
|
|
401
|
+
# @param [String] quota_user
|
|
402
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
403
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
404
|
+
# @param [Google::Apis::RequestOptions] options
|
|
405
|
+
# Request-specific options
|
|
406
|
+
#
|
|
407
|
+
# @yield [result, err] Result & error if block supplied
|
|
408
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] parsed result object
|
|
409
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
410
|
+
#
|
|
411
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Client]
|
|
412
|
+
#
|
|
413
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
414
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
415
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
416
|
+
def deactivate_client(name, deactivate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
417
|
+
command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
|
|
418
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientRequest::Representation
|
|
419
|
+
command.request_object = deactivate_client_request_object
|
|
420
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
421
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
|
|
422
|
+
command.params['name'] = name unless name.nil?
|
|
423
|
+
command.query['fields'] = fields unless fields.nil?
|
|
424
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
425
|
+
execute_or_queue_command(command, &block)
|
|
426
|
+
end
|
|
427
|
+
|
|
428
|
+
# Gets a client with a given resource name.
|
|
429
|
+
# @param [String] name
|
|
430
|
+
# Required. Format: `buyers/`accountId`/clients/`clientAccountId``
|
|
431
|
+
# @param [String] fields
|
|
432
|
+
# Selector specifying which fields to include in a partial response.
|
|
433
|
+
# @param [String] quota_user
|
|
434
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
435
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
436
|
+
# @param [Google::Apis::RequestOptions] options
|
|
437
|
+
# Request-specific options
|
|
438
|
+
#
|
|
439
|
+
# @yield [result, err] Result & error if block supplied
|
|
440
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] parsed result object
|
|
441
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
442
|
+
#
|
|
443
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Client]
|
|
444
|
+
#
|
|
445
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
446
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
447
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
448
|
+
def get_buyer_client(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
449
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
450
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
451
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
|
|
452
|
+
command.params['name'] = name unless name.nil?
|
|
453
|
+
command.query['fields'] = fields unless fields.nil?
|
|
454
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
455
|
+
execute_or_queue_command(command, &block)
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
# Lists all the clients for the current buyer.
|
|
459
|
+
# @param [String] parent
|
|
460
|
+
# Required. The name of the buyer. Format: `buyers/`accountId``
|
|
461
|
+
# @param [String] filter
|
|
462
|
+
# Query string using the [Filtering Syntax](https://developers.google.com/
|
|
463
|
+
# authorized-buyers/apis/guides/v2/list-filters) Supported fields for filtering
|
|
464
|
+
# are: * partnerClientId Use this field to filter the clients by the
|
|
465
|
+
# partnerClientId. For example, if the partnerClientId of the client is "1234",
|
|
466
|
+
# the value of this field should be `partnerClientId = "1234"`, in order to get
|
|
467
|
+
# only the client whose partnerClientId is "1234" in the response.
|
|
468
|
+
# @param [Fixnum] page_size
|
|
469
|
+
# Requested page size. If left blank, a default page size of 500 will be applied.
|
|
470
|
+
# @param [String] page_token
|
|
471
|
+
# A token identifying a page of results the server should return. Typically,
|
|
472
|
+
# this is the value of ListClientsResponse.nextPageToken returned from the
|
|
473
|
+
# previous call to the list method.
|
|
474
|
+
# @param [String] fields
|
|
475
|
+
# Selector specifying which fields to include in a partial response.
|
|
476
|
+
# @param [String] quota_user
|
|
477
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
478
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
479
|
+
# @param [Google::Apis::RequestOptions] options
|
|
480
|
+
# Request-specific options
|
|
481
|
+
#
|
|
482
|
+
# @yield [result, err] Result & error if block supplied
|
|
483
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse] parsed result object
|
|
484
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
485
|
+
#
|
|
486
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse]
|
|
487
|
+
#
|
|
488
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
489
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
490
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
491
|
+
def list_buyer_clients(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
492
|
+
command = make_simple_command(:get, 'v1/{+parent}/clients', options)
|
|
493
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse::Representation
|
|
494
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse
|
|
495
|
+
command.params['parent'] = parent unless parent.nil?
|
|
496
|
+
command.query['filter'] = filter unless filter.nil?
|
|
497
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
498
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
499
|
+
command.query['fields'] = fields unless fields.nil?
|
|
500
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
501
|
+
execute_or_queue_command(command, &block)
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
# Updates an existing client.
|
|
505
|
+
# @param [String] name
|
|
506
|
+
# Output only. The resource name of the client. Format: `buyers/`accountId`/
|
|
507
|
+
# clients/`clientAccountId``
|
|
508
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] client_object
|
|
509
|
+
# @param [String] update_mask
|
|
510
|
+
# List of fields to be updated. If empty or unspecified, the service will update
|
|
511
|
+
# all fields populated in the update request excluding the output only fields
|
|
512
|
+
# and primitive fields with default value. Note that explicit field mask is
|
|
513
|
+
# required in order to reset a primitive field back to its default value, e.g.
|
|
514
|
+
# false for boolean fields, 0 for integer fields. A special field mask
|
|
515
|
+
# consisting of a single path "*" can be used to indicate full replacement(the
|
|
516
|
+
# equivalent of PUT method), updatable fields unset or unspecified in the input
|
|
517
|
+
# will be cleared or set to default value. Output only fields will be ignored
|
|
518
|
+
# regardless of the value of updateMask.
|
|
519
|
+
# @param [String] fields
|
|
520
|
+
# Selector specifying which fields to include in a partial response.
|
|
521
|
+
# @param [String] quota_user
|
|
522
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
523
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
524
|
+
# @param [Google::Apis::RequestOptions] options
|
|
525
|
+
# Request-specific options
|
|
526
|
+
#
|
|
527
|
+
# @yield [result, err] Result & error if block supplied
|
|
528
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Client] parsed result object
|
|
529
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
530
|
+
#
|
|
531
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Client]
|
|
532
|
+
#
|
|
533
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
534
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
535
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
536
|
+
def patch_buyer_client(name, client_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
537
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
538
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
539
|
+
command.request_object = client_object
|
|
540
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
|
|
541
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
|
|
542
|
+
command.params['name'] = name unless name.nil?
|
|
543
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
544
|
+
command.query['fields'] = fields unless fields.nil?
|
|
545
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
546
|
+
execute_or_queue_command(command, &block)
|
|
547
|
+
end
|
|
548
|
+
|
|
549
|
+
# Activates an existing client user. The state of the client user will be
|
|
550
|
+
# updated from "INACTIVE" to "ACTIVE". This method has no effect if the client
|
|
551
|
+
# user is already in "ACTIVE" state. An error will be returned if the client
|
|
552
|
+
# user to activate is still in "INVITED" state.
|
|
553
|
+
# @param [String] name
|
|
554
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId`/
|
|
555
|
+
# clientUsers/`userId``
|
|
556
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientUserRequest] activate_client_user_request_object
|
|
557
|
+
# @param [String] fields
|
|
558
|
+
# Selector specifying which fields to include in a partial response.
|
|
559
|
+
# @param [String] quota_user
|
|
560
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
561
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
562
|
+
# @param [Google::Apis::RequestOptions] options
|
|
563
|
+
# Request-specific options
|
|
564
|
+
#
|
|
565
|
+
# @yield [result, err] Result & error if block supplied
|
|
566
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser] parsed result object
|
|
567
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
568
|
+
#
|
|
569
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser]
|
|
570
|
+
#
|
|
571
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
572
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
573
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
574
|
+
def activate_client_user(name, activate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
575
|
+
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
|
576
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientUserRequest::Representation
|
|
577
|
+
command.request_object = activate_client_user_request_object
|
|
578
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
|
|
579
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
|
|
580
|
+
command.params['name'] = name unless name.nil?
|
|
581
|
+
command.query['fields'] = fields unless fields.nil?
|
|
582
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
583
|
+
execute_or_queue_command(command, &block)
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# Creates a new client user in "INVITED" state. An email invitation will be sent
|
|
587
|
+
# to the new user, once accepted the user will become active.
|
|
588
|
+
# @param [String] parent
|
|
589
|
+
# Required. The name of the client. Format: `buyers/`accountId`/clients/`
|
|
590
|
+
# clientAccountId``
|
|
591
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser] client_user_object
|
|
592
|
+
# @param [String] fields
|
|
593
|
+
# Selector specifying which fields to include in a partial response.
|
|
594
|
+
# @param [String] quota_user
|
|
595
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
596
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
597
|
+
# @param [Google::Apis::RequestOptions] options
|
|
598
|
+
# Request-specific options
|
|
599
|
+
#
|
|
600
|
+
# @yield [result, err] Result & error if block supplied
|
|
601
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser] parsed result object
|
|
602
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
603
|
+
#
|
|
604
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser]
|
|
605
|
+
#
|
|
606
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
607
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
608
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
609
|
+
def create_buyer_client_user(parent, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
610
|
+
command = make_simple_command(:post, 'v1/{+parent}/users', options)
|
|
611
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
|
|
612
|
+
command.request_object = client_user_object
|
|
613
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
|
|
614
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
|
|
615
|
+
command.params['parent'] = parent unless parent.nil?
|
|
616
|
+
command.query['fields'] = fields unless fields.nil?
|
|
617
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
618
|
+
execute_or_queue_command(command, &block)
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# Deactivates an existing client user. The state of the client user will be
|
|
622
|
+
# updated from "ACTIVE" to "INACTIVE". This method has no effect if the client
|
|
623
|
+
# user is already in "INACTIVE" state. An error will be returned if the client
|
|
624
|
+
# user to deactivate is still in "INVITED" state.
|
|
625
|
+
# @param [String] name
|
|
626
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId`/
|
|
627
|
+
# clientUsers/`userId``
|
|
628
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientUserRequest] deactivate_client_user_request_object
|
|
629
|
+
# @param [String] fields
|
|
630
|
+
# Selector specifying which fields to include in a partial response.
|
|
631
|
+
# @param [String] quota_user
|
|
632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
634
|
+
# @param [Google::Apis::RequestOptions] options
|
|
635
|
+
# Request-specific options
|
|
636
|
+
#
|
|
637
|
+
# @yield [result, err] Result & error if block supplied
|
|
638
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser] parsed result object
|
|
639
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
640
|
+
#
|
|
641
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser]
|
|
642
|
+
#
|
|
643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
646
|
+
def deactivate_client_user(name, deactivate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
647
|
+
command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
|
|
648
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientUserRequest::Representation
|
|
649
|
+
command.request_object = deactivate_client_user_request_object
|
|
650
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
|
|
651
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
|
|
652
|
+
command.params['name'] = name unless name.nil?
|
|
653
|
+
command.query['fields'] = fields unless fields.nil?
|
|
654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
655
|
+
execute_or_queue_command(command, &block)
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
# Deletes an existing client user. The client user will lose access to the
|
|
659
|
+
# Authorized Buyers UI. Note that if a client user is deleted, the user's access
|
|
660
|
+
# to the UI can't be restored unless a new client user is created and activated.
|
|
661
|
+
# @param [String] name
|
|
662
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId`/
|
|
663
|
+
# clientUsers/`userId``
|
|
664
|
+
# @param [String] fields
|
|
665
|
+
# Selector specifying which fields to include in a partial response.
|
|
666
|
+
# @param [String] quota_user
|
|
667
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
668
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
669
|
+
# @param [Google::Apis::RequestOptions] options
|
|
670
|
+
# Request-specific options
|
|
671
|
+
#
|
|
672
|
+
# @yield [result, err] Result & error if block supplied
|
|
673
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Empty] parsed result object
|
|
674
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
675
|
+
#
|
|
676
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Empty]
|
|
677
|
+
#
|
|
678
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
679
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
680
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
681
|
+
def delete_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
682
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
683
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Empty::Representation
|
|
684
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Empty
|
|
685
|
+
command.params['name'] = name unless name.nil?
|
|
686
|
+
command.query['fields'] = fields unless fields.nil?
|
|
687
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
688
|
+
execute_or_queue_command(command, &block)
|
|
689
|
+
end
|
|
690
|
+
|
|
691
|
+
# Retrieves an existing client user.
|
|
692
|
+
# @param [String] name
|
|
693
|
+
# Required. Format: `buyers/`buyerAccountId`/clients/`clientAccountId`/
|
|
694
|
+
# clientUsers/`userId``
|
|
695
|
+
# @param [String] fields
|
|
696
|
+
# Selector specifying which fields to include in a partial response.
|
|
697
|
+
# @param [String] quota_user
|
|
698
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
699
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
700
|
+
# @param [Google::Apis::RequestOptions] options
|
|
701
|
+
# Request-specific options
|
|
702
|
+
#
|
|
703
|
+
# @yield [result, err] Result & error if block supplied
|
|
704
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser] parsed result object
|
|
705
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
706
|
+
#
|
|
707
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser]
|
|
708
|
+
#
|
|
709
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
710
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
711
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
712
|
+
def get_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
713
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
714
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
|
|
715
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
|
|
716
|
+
command.params['name'] = name unless name.nil?
|
|
717
|
+
command.query['fields'] = fields unless fields.nil?
|
|
718
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
719
|
+
execute_or_queue_command(command, &block)
|
|
720
|
+
end
|
|
721
|
+
|
|
722
|
+
# Lists all client users for a specified client.
|
|
723
|
+
# @param [String] parent
|
|
724
|
+
# Required. The name of the client. Format: `buyers/`buyerAccountId`/clients/`
|
|
725
|
+
# clientAccountId``
|
|
726
|
+
# @param [Fixnum] page_size
|
|
727
|
+
# Requested page size. If left blank, a default page size of 500 will be applied.
|
|
728
|
+
# @param [String] page_token
|
|
729
|
+
# A token identifying a page of results the server should return. Typically,
|
|
730
|
+
# this is the value of ListClientUsersResponse.nextPageToken returned from the
|
|
731
|
+
# previous call to the list method.
|
|
732
|
+
# @param [String] fields
|
|
733
|
+
# Selector specifying which fields to include in a partial response.
|
|
734
|
+
# @param [String] quota_user
|
|
735
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
736
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
737
|
+
# @param [Google::Apis::RequestOptions] options
|
|
738
|
+
# Request-specific options
|
|
739
|
+
#
|
|
740
|
+
# @yield [result, err] Result & error if block supplied
|
|
741
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse] parsed result object
|
|
742
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
743
|
+
#
|
|
744
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse]
|
|
745
|
+
#
|
|
746
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
747
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
748
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
749
|
+
def list_buyer_client_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
750
|
+
command = make_simple_command(:get, 'v1/{+parent}/users', options)
|
|
751
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse::Representation
|
|
752
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse
|
|
753
|
+
command.params['parent'] = parent unless parent.nil?
|
|
754
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
755
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
756
|
+
command.query['fields'] = fields unless fields.nil?
|
|
757
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
758
|
+
execute_or_queue_command(command, &block)
|
|
759
|
+
end
|
|
760
|
+
|
|
761
|
+
# Add creative to be used in the bidding process for a finalized deal. For
|
|
762
|
+
# programmatic guaranteed deals, it's recommended that you associate at least
|
|
763
|
+
# one approved creative with the deal before calling SetReadyToServe, to help
|
|
764
|
+
# reduce the number of bid responses filtered because they don't contain
|
|
765
|
+
# approved creatives. Creatives successfully added to a deal can be found in the
|
|
766
|
+
# Realtime-bidding Creatives API creative.deal_ids. This method only applies to
|
|
767
|
+
# programmatic guaranteed deals. Maximum number of 1000 creatives can be added
|
|
768
|
+
# to a finalized deal.
|
|
769
|
+
# @param [String] deal
|
|
770
|
+
# Required. Name of the finalized deal in the format of: `buyers/`accountId`/
|
|
771
|
+
# finalizedDeals/`dealId``
|
|
772
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::AddCreativeRequest] add_creative_request_object
|
|
773
|
+
# @param [String] fields
|
|
774
|
+
# Selector specifying which fields to include in a partial response.
|
|
775
|
+
# @param [String] quota_user
|
|
776
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
777
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
778
|
+
# @param [Google::Apis::RequestOptions] options
|
|
779
|
+
# Request-specific options
|
|
780
|
+
#
|
|
781
|
+
# @yield [result, err] Result & error if block supplied
|
|
782
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal] parsed result object
|
|
783
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
784
|
+
#
|
|
785
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal]
|
|
786
|
+
#
|
|
787
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
788
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
789
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
790
|
+
def add_finalized_deal_creative(deal, add_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
791
|
+
command = make_simple_command(:post, 'v1/{+deal}:addCreative', options)
|
|
792
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AddCreativeRequest::Representation
|
|
793
|
+
command.request_object = add_creative_request_object
|
|
794
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
|
|
795
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
|
|
796
|
+
command.params['deal'] = deal unless deal.nil?
|
|
797
|
+
command.query['fields'] = fields unless fields.nil?
|
|
798
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
799
|
+
execute_or_queue_command(command, &block)
|
|
800
|
+
end
|
|
801
|
+
|
|
802
|
+
# Gets a finalized deal given its name.
|
|
803
|
+
# @param [String] name
|
|
804
|
+
# Required. Format: `buyers/`accountId`/finalizedDeals/`dealId``
|
|
805
|
+
# @param [String] fields
|
|
806
|
+
# Selector specifying which fields to include in a partial response.
|
|
807
|
+
# @param [String] quota_user
|
|
808
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
809
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
810
|
+
# @param [Google::Apis::RequestOptions] options
|
|
811
|
+
# Request-specific options
|
|
812
|
+
#
|
|
813
|
+
# @yield [result, err] Result & error if block supplied
|
|
814
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal] parsed result object
|
|
815
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
816
|
+
#
|
|
817
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal]
|
|
818
|
+
#
|
|
819
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
820
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
821
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
822
|
+
def get_buyer_finalized_deal(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
823
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
824
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
|
|
825
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
|
|
826
|
+
command.params['name'] = name unless name.nil?
|
|
827
|
+
command.query['fields'] = fields unless fields.nil?
|
|
828
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
829
|
+
execute_or_queue_command(command, &block)
|
|
830
|
+
end
|
|
831
|
+
|
|
832
|
+
# Lists finalized deals. Use the URL path "/v1/buyers/`accountId`/finalizedDeals"
|
|
833
|
+
# to list finalized deals for the current buyer and its clients. Bidders can
|
|
834
|
+
# use the URL path "/v1/bidders/`accountId`/finalizedDeals" to list finalized
|
|
835
|
+
# deals for the bidder, its buyers and all their clients.
|
|
836
|
+
# @param [String] parent
|
|
837
|
+
# Required. The buyer to list the finalized deals for, in the format: `buyers/`
|
|
838
|
+
# accountId``. When used to list finalized deals for a bidder, its buyers and
|
|
839
|
+
# clients, in the format `bidders/`accountId``.
|
|
840
|
+
# @param [String] filter
|
|
841
|
+
# Optional query string using the [Cloud API list filtering syntax](https://
|
|
842
|
+
# developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported
|
|
843
|
+
# columns for filtering are: * deal.displayName * deal.dealType * deal.
|
|
844
|
+
# createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime *
|
|
845
|
+
# dealServingStatus
|
|
846
|
+
# @param [String] order_by
|
|
847
|
+
# An optional query string to sort finalized deals using the [Cloud API sorting
|
|
848
|
+
# syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
|
|
849
|
+
# If no sort order is specified, results will be returned in an arbitrary order.
|
|
850
|
+
# Supported columns for sorting are: * deal.displayName * deal.createTime * deal.
|
|
851
|
+
# updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.
|
|
852
|
+
# bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days *
|
|
853
|
+
# rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.
|
|
854
|
+
# mustBidRateCurrentMonth Example: 'deal.displayName, deal.updateTime desc'
|
|
855
|
+
# @param [Fixnum] page_size
|
|
856
|
+
# Requested page size. The server may return fewer results than requested. If
|
|
857
|
+
# requested more than 500, the server will return 500 results per page. If
|
|
858
|
+
# unspecified, the server will pick a default page size of 100.
|
|
859
|
+
# @param [String] page_token
|
|
860
|
+
# The page token as returned from ListFinalizedDealsResponse.
|
|
861
|
+
# @param [String] fields
|
|
862
|
+
# Selector specifying which fields to include in a partial response.
|
|
863
|
+
# @param [String] quota_user
|
|
864
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
865
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
866
|
+
# @param [Google::Apis::RequestOptions] options
|
|
867
|
+
# Request-specific options
|
|
868
|
+
#
|
|
869
|
+
# @yield [result, err] Result & error if block supplied
|
|
870
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse] parsed result object
|
|
871
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
872
|
+
#
|
|
873
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse]
|
|
874
|
+
#
|
|
875
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
876
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
877
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
878
|
+
def list_buyer_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
879
|
+
command = make_simple_command(:get, 'v1/{+parent}/finalizedDeals', options)
|
|
880
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse::Representation
|
|
881
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse
|
|
882
|
+
command.params['parent'] = parent unless parent.nil?
|
|
883
|
+
command.query['filter'] = filter unless filter.nil?
|
|
884
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
885
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
886
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
887
|
+
command.query['fields'] = fields unless fields.nil?
|
|
888
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
889
|
+
execute_or_queue_command(command, &block)
|
|
890
|
+
end
|
|
891
|
+
|
|
892
|
+
# Pauses serving of the given finalized deal. This call only pauses the serving
|
|
893
|
+
# status, and does not affect other fields of the finalized deal. Calling this
|
|
894
|
+
# method for an already paused deal has no effect. This method only applies to
|
|
895
|
+
# programmatic guaranteed deals.
|
|
896
|
+
# @param [String] name
|
|
897
|
+
# Required. Format: `buyers/`accountId`/finalizedDeals/`dealId``
|
|
898
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::PauseFinalizedDealRequest] pause_finalized_deal_request_object
|
|
899
|
+
# @param [String] fields
|
|
900
|
+
# Selector specifying which fields to include in a partial response.
|
|
901
|
+
# @param [String] quota_user
|
|
902
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
903
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
904
|
+
# @param [Google::Apis::RequestOptions] options
|
|
905
|
+
# Request-specific options
|
|
906
|
+
#
|
|
907
|
+
# @yield [result, err] Result & error if block supplied
|
|
908
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal] parsed result object
|
|
909
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
910
|
+
#
|
|
911
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal]
|
|
912
|
+
#
|
|
913
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
914
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
915
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
916
|
+
def pause_finalized_deal(name, pause_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
917
|
+
command = make_simple_command(:post, 'v1/{+name}:pause', options)
|
|
918
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::PauseFinalizedDealRequest::Representation
|
|
919
|
+
command.request_object = pause_finalized_deal_request_object
|
|
920
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
|
|
921
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
|
|
922
|
+
command.params['name'] = name unless name.nil?
|
|
923
|
+
command.query['fields'] = fields unless fields.nil?
|
|
924
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
925
|
+
execute_or_queue_command(command, &block)
|
|
926
|
+
end
|
|
927
|
+
|
|
928
|
+
# Resumes serving of the given finalized deal. Calling this method for an
|
|
929
|
+
# running deal has no effect. If a deal is initially paused by the seller,
|
|
930
|
+
# calling this method will not resume serving of the deal until the seller also
|
|
931
|
+
# resumes the deal. This method only applies to programmatic guaranteed deals.
|
|
932
|
+
# @param [String] name
|
|
933
|
+
# Required. Format: `buyers/`accountId`/finalizedDeals/`dealId``
|
|
934
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::ResumeFinalizedDealRequest] resume_finalized_deal_request_object
|
|
935
|
+
# @param [String] fields
|
|
936
|
+
# Selector specifying which fields to include in a partial response.
|
|
937
|
+
# @param [String] quota_user
|
|
938
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
939
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
940
|
+
# @param [Google::Apis::RequestOptions] options
|
|
941
|
+
# Request-specific options
|
|
942
|
+
#
|
|
943
|
+
# @yield [result, err] Result & error if block supplied
|
|
944
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal] parsed result object
|
|
945
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
946
|
+
#
|
|
947
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal]
|
|
948
|
+
#
|
|
949
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
950
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
951
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
952
|
+
def resume_finalized_deal(name, resume_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
953
|
+
command = make_simple_command(:post, 'v1/{+name}:resume', options)
|
|
954
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ResumeFinalizedDealRequest::Representation
|
|
955
|
+
command.request_object = resume_finalized_deal_request_object
|
|
956
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
|
|
957
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
|
|
958
|
+
command.params['name'] = name unless name.nil?
|
|
959
|
+
command.query['fields'] = fields unless fields.nil?
|
|
960
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
961
|
+
execute_or_queue_command(command, &block)
|
|
962
|
+
end
|
|
963
|
+
|
|
964
|
+
# Sets the given finalized deal as ready to serve. By default, deals are ready
|
|
965
|
+
# to serve as soon as they're finalized. A bidder can opt out of this feature by
|
|
966
|
+
# asking to be included in an allowlist. Once opted out, finalized deals
|
|
967
|
+
# belonging to the bidder and its child seats will not start serving until this
|
|
968
|
+
# method is called. This method is useful to the bidders who prefer to not
|
|
969
|
+
# receive bid requests before the creative is ready. This method only applies to
|
|
970
|
+
# programmatic guaranteed deals.
|
|
971
|
+
# @param [String] deal
|
|
972
|
+
# Required. Format: `buyers/`accountId`/finalizedDeals/`dealId``
|
|
973
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::SetReadyToServeRequest] set_ready_to_serve_request_object
|
|
974
|
+
# @param [String] fields
|
|
975
|
+
# Selector specifying which fields to include in a partial response.
|
|
976
|
+
# @param [String] quota_user
|
|
977
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
978
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
979
|
+
# @param [Google::Apis::RequestOptions] options
|
|
980
|
+
# Request-specific options
|
|
981
|
+
#
|
|
982
|
+
# @yield [result, err] Result & error if block supplied
|
|
983
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal] parsed result object
|
|
984
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
985
|
+
#
|
|
986
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal]
|
|
987
|
+
#
|
|
988
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
989
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
990
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
991
|
+
def set_finalized_deal_ready_to_serve(deal, set_ready_to_serve_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
992
|
+
command = make_simple_command(:post, 'v1/{+deal}:setReadyToServe', options)
|
|
993
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SetReadyToServeRequest::Representation
|
|
994
|
+
command.request_object = set_ready_to_serve_request_object
|
|
995
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
|
|
996
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
|
|
997
|
+
command.params['deal'] = deal unless deal.nil?
|
|
998
|
+
command.query['fields'] = fields unless fields.nil?
|
|
999
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1000
|
+
execute_or_queue_command(command, &block)
|
|
1001
|
+
end
|
|
1002
|
+
|
|
1003
|
+
# Accepts the proposal at the given revision number. If the revision number in
|
|
1004
|
+
# the request is behind the latest from the server, an error message will be
|
|
1005
|
+
# returned. This call updates the Proposal.state from `
|
|
1006
|
+
# BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the
|
|
1007
|
+
# Proposal.state is already `FINALIZED` and throws exception if the Proposal.
|
|
1008
|
+
# state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a
|
|
1009
|
+
# proposal means the buyer understands and accepts the Proposal.
|
|
1010
|
+
# terms_and_conditions proposed by the seller.
|
|
1011
|
+
# @param [String] name
|
|
1012
|
+
# Name of the proposal. Format: `buyers/`accountId`/proposals/`proposalId``
|
|
1013
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::AcceptProposalRequest] accept_proposal_request_object
|
|
1014
|
+
# @param [String] fields
|
|
1015
|
+
# Selector specifying which fields to include in a partial response.
|
|
1016
|
+
# @param [String] quota_user
|
|
1017
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1018
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1019
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1020
|
+
# Request-specific options
|
|
1021
|
+
#
|
|
1022
|
+
# @yield [result, err] Result & error if block supplied
|
|
1023
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1024
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1025
|
+
#
|
|
1026
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1027
|
+
#
|
|
1028
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1029
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1030
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1031
|
+
def accept_proposal(name, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1032
|
+
command = make_simple_command(:post, 'v1/{+name}:accept', options)
|
|
1033
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AcceptProposalRequest::Representation
|
|
1034
|
+
command.request_object = accept_proposal_request_object
|
|
1035
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1036
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1037
|
+
command.params['name'] = name unless name.nil?
|
|
1038
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1039
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1040
|
+
execute_or_queue_command(command, &block)
|
|
1041
|
+
end
|
|
1042
|
+
|
|
1043
|
+
# Creates a note for this proposal and sends to the seller.
|
|
1044
|
+
# @param [String] proposal
|
|
1045
|
+
# Name of the proposal. Format: `buyers/`accountId`/proposals/`proposalId``
|
|
1046
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::AddNoteRequest] add_note_request_object
|
|
1047
|
+
# @param [String] fields
|
|
1048
|
+
# Selector specifying which fields to include in a partial response.
|
|
1049
|
+
# @param [String] quota_user
|
|
1050
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1051
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1052
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1053
|
+
# Request-specific options
|
|
1054
|
+
#
|
|
1055
|
+
# @yield [result, err] Result & error if block supplied
|
|
1056
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1057
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1058
|
+
#
|
|
1059
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1060
|
+
#
|
|
1061
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1062
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1063
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1064
|
+
def add_proposal_note(proposal, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1065
|
+
command = make_simple_command(:post, 'v1/{+proposal}:addNote', options)
|
|
1066
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AddNoteRequest::Representation
|
|
1067
|
+
command.request_object = add_note_request_object
|
|
1068
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1069
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1070
|
+
command.params['proposal'] = proposal unless proposal.nil?
|
|
1071
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1072
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1073
|
+
execute_or_queue_command(command, &block)
|
|
1074
|
+
end
|
|
1075
|
+
|
|
1076
|
+
# Cancels an ongoing negotiation on a proposal. This does not cancel or end
|
|
1077
|
+
# serving for the deals if the proposal has been finalized. If the proposal has
|
|
1078
|
+
# not been finalized before, calling this method will set the Proposal.state to `
|
|
1079
|
+
# TERMINATED` and increment the Proposal.proposal_revision. If the proposal has
|
|
1080
|
+
# been finalized before and is under renegotiation now, calling this method will
|
|
1081
|
+
# reset the Proposal.state to `FINALIZED` and increment the Proposal.
|
|
1082
|
+
# proposal_revision. This method does not support private auction proposals
|
|
1083
|
+
# whose Proposal.deal_type is 'PRIVATE_AUCTION'.
|
|
1084
|
+
# @param [String] proposal
|
|
1085
|
+
# Name of the proposal. Format: `buyers/`accountId`/proposals/`proposalId``
|
|
1086
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::CancelNegotiationRequest] cancel_negotiation_request_object
|
|
1087
|
+
# @param [String] fields
|
|
1088
|
+
# Selector specifying which fields to include in a partial response.
|
|
1089
|
+
# @param [String] quota_user
|
|
1090
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1091
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1092
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1093
|
+
# Request-specific options
|
|
1094
|
+
#
|
|
1095
|
+
# @yield [result, err] Result & error if block supplied
|
|
1096
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1097
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1098
|
+
#
|
|
1099
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1100
|
+
#
|
|
1101
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1102
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1103
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1104
|
+
def cancel_proposal_negotiation(proposal, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1105
|
+
command = make_simple_command(:post, 'v1/{+proposal}:cancelNegotiation', options)
|
|
1106
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::CancelNegotiationRequest::Representation
|
|
1107
|
+
command.request_object = cancel_negotiation_request_object
|
|
1108
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1109
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1110
|
+
command.params['proposal'] = proposal unless proposal.nil?
|
|
1111
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1112
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1113
|
+
execute_or_queue_command(command, &block)
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1116
|
+
# Gets a proposal using its name. The proposal is returned at most recent
|
|
1117
|
+
# revision. revision.
|
|
1118
|
+
# @param [String] name
|
|
1119
|
+
# Required. Name of the proposal. Format: `buyers/`accountId`/proposals/`
|
|
1120
|
+
# proposalId``
|
|
1121
|
+
# @param [String] fields
|
|
1122
|
+
# Selector specifying which fields to include in a partial response.
|
|
1123
|
+
# @param [String] quota_user
|
|
1124
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1125
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1126
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1127
|
+
# Request-specific options
|
|
1128
|
+
#
|
|
1129
|
+
# @yield [result, err] Result & error if block supplied
|
|
1130
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1131
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1132
|
+
#
|
|
1133
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1134
|
+
#
|
|
1135
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1136
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1137
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1138
|
+
def get_buyer_proposal(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1139
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
1140
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1141
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1142
|
+
command.params['name'] = name unless name.nil?
|
|
1143
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1144
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1145
|
+
execute_or_queue_command(command, &block)
|
|
1146
|
+
end
|
|
1147
|
+
|
|
1148
|
+
# Lists proposals. A filter expression (list filter syntax) may be specified to
|
|
1149
|
+
# filter the results. This will not list finalized versions of proposals that
|
|
1150
|
+
# are being renegotiated; to retrieve these use the finalizedProposals resource.
|
|
1151
|
+
# @param [String] parent
|
|
1152
|
+
# Required. Parent that owns the collection of proposals Format: `buyers/`
|
|
1153
|
+
# accountId``
|
|
1154
|
+
# @param [String] filter
|
|
1155
|
+
# Optional query string using the [Cloud API list filtering syntax](https://
|
|
1156
|
+
# developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported
|
|
1157
|
+
# columns for filtering are: * displayName * dealType * updateTime * state
|
|
1158
|
+
# @param [Fixnum] page_size
|
|
1159
|
+
# Requested page size. The server may return fewer results than requested. If
|
|
1160
|
+
# unspecified, the server will put a size of 500.
|
|
1161
|
+
# @param [String] page_token
|
|
1162
|
+
# The page token as returned from ListProposalsResponse.
|
|
1163
|
+
# @param [String] fields
|
|
1164
|
+
# Selector specifying which fields to include in a partial response.
|
|
1165
|
+
# @param [String] quota_user
|
|
1166
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1167
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1168
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1169
|
+
# Request-specific options
|
|
1170
|
+
#
|
|
1171
|
+
# @yield [result, err] Result & error if block supplied
|
|
1172
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse] parsed result object
|
|
1173
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1174
|
+
#
|
|
1175
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse]
|
|
1176
|
+
#
|
|
1177
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1178
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1179
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1180
|
+
def list_buyer_proposals(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1181
|
+
command = make_simple_command(:get, 'v1/{+parent}/proposals', options)
|
|
1182
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse::Representation
|
|
1183
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse
|
|
1184
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1185
|
+
command.query['filter'] = filter unless filter.nil?
|
|
1186
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1187
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1188
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1190
|
+
execute_or_queue_command(command, &block)
|
|
1191
|
+
end
|
|
1192
|
+
|
|
1193
|
+
# Updates the proposal at the given revision number. If the revision number in
|
|
1194
|
+
# the request is behind the latest from the server, an error message will be
|
|
1195
|
+
# returned. See FieldMask for how to use FieldMask. Only fields specified in the
|
|
1196
|
+
# UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable'
|
|
1197
|
+
# or 'Output only' yet specified in the UpdateProposalRequest.update_mask will
|
|
1198
|
+
# be ignored and left unchanged. Updating a private auction proposal is not
|
|
1199
|
+
# allowed and will result in an error.
|
|
1200
|
+
# @param [String] name
|
|
1201
|
+
# Immutable. The name of the proposal serving as a unique identifier. Format:
|
|
1202
|
+
# buyers/`accountId`/proposals/`proposalId`
|
|
1203
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] proposal_object
|
|
1204
|
+
# @param [String] update_mask
|
|
1205
|
+
# List of fields to be updated. If empty or unspecified, the service will update
|
|
1206
|
+
# all fields populated in the update request excluding the output only fields
|
|
1207
|
+
# and primitive fields with default value. Note that explicit field mask is
|
|
1208
|
+
# required in order to reset a primitive field back to its default value, e.g.
|
|
1209
|
+
# false for boolean fields, 0 for integer fields. A special field mask
|
|
1210
|
+
# consisting of a single path "*" can be used to indicate full replacement(the
|
|
1211
|
+
# equivalent of PUT method), updatable fields unset or unspecified in the input
|
|
1212
|
+
# will be cleared or set to default value. Output only fields will be ignored
|
|
1213
|
+
# regardless of the value of updateMask.
|
|
1214
|
+
# @param [String] fields
|
|
1215
|
+
# Selector specifying which fields to include in a partial response.
|
|
1216
|
+
# @param [String] quota_user
|
|
1217
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1218
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1219
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1220
|
+
# Request-specific options
|
|
1221
|
+
#
|
|
1222
|
+
# @yield [result, err] Result & error if block supplied
|
|
1223
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1224
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1225
|
+
#
|
|
1226
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1227
|
+
#
|
|
1228
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1229
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1230
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1231
|
+
def patch_buyer_proposal(name, proposal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1232
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
1233
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1234
|
+
command.request_object = proposal_object
|
|
1235
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1236
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1237
|
+
command.params['name'] = name unless name.nil?
|
|
1238
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1239
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1240
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1241
|
+
execute_or_queue_command(command, &block)
|
|
1242
|
+
end
|
|
1243
|
+
|
|
1244
|
+
# Sends a request for proposal (RFP) to a publisher to initiate the negotiation
|
|
1245
|
+
# regarding certain inventory. In the RFP, buyers can specify the deal type,
|
|
1246
|
+
# deal terms, start and end dates, targeting, and a message to the publisher.
|
|
1247
|
+
# Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be
|
|
1248
|
+
# created and returned in the response. The publisher may review your request
|
|
1249
|
+
# and respond with detailed deals in the proposal.
|
|
1250
|
+
# @param [String] buyer
|
|
1251
|
+
# Required. The current buyer who is sending the RFP in the format: `buyers/`
|
|
1252
|
+
# accountId``.
|
|
1253
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::SendRfpRequest] send_rfp_request_object
|
|
1254
|
+
# @param [String] fields
|
|
1255
|
+
# Selector specifying which fields to include in a partial response.
|
|
1256
|
+
# @param [String] quota_user
|
|
1257
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1258
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1259
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1260
|
+
# Request-specific options
|
|
1261
|
+
#
|
|
1262
|
+
# @yield [result, err] Result & error if block supplied
|
|
1263
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal] parsed result object
|
|
1264
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1265
|
+
#
|
|
1266
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal]
|
|
1267
|
+
#
|
|
1268
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1269
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1270
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1271
|
+
def send_proposal_rfp(buyer, send_rfp_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1272
|
+
command = make_simple_command(:post, 'v1/{+buyer}/proposals:sendRfp', options)
|
|
1273
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SendRfpRequest::Representation
|
|
1274
|
+
command.request_object = send_rfp_request_object
|
|
1275
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
|
|
1276
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
|
|
1277
|
+
command.params['buyer'] = buyer unless buyer.nil?
|
|
1278
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1279
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1280
|
+
execute_or_queue_command(command, &block)
|
|
1281
|
+
end
|
|
1282
|
+
|
|
1283
|
+
# Batch updates multiple deals in the same proposal.
|
|
1284
|
+
# @param [String] parent
|
|
1285
|
+
# Required. The name of the proposal containing the deals to batch update.
|
|
1286
|
+
# Format: buyers/`accountId`/proposals/`proposalId`
|
|
1287
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsRequest] batch_update_deals_request_object
|
|
1288
|
+
# @param [String] fields
|
|
1289
|
+
# Selector specifying which fields to include in a partial response.
|
|
1290
|
+
# @param [String] quota_user
|
|
1291
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1292
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1293
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1294
|
+
# Request-specific options
|
|
1295
|
+
#
|
|
1296
|
+
# @yield [result, err] Result & error if block supplied
|
|
1297
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse] parsed result object
|
|
1298
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1299
|
+
#
|
|
1300
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse]
|
|
1301
|
+
#
|
|
1302
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1303
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1304
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1305
|
+
def batch_update_deals(parent, batch_update_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1306
|
+
command = make_simple_command(:post, 'v1/{+parent}/deals:batchUpdate', options)
|
|
1307
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsRequest::Representation
|
|
1308
|
+
command.request_object = batch_update_deals_request_object
|
|
1309
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse::Representation
|
|
1310
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse
|
|
1311
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1312
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1313
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1314
|
+
execute_or_queue_command(command, &block)
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
# Gets a deal given its name. The deal is returned at its head revision.
|
|
1318
|
+
# @param [String] name
|
|
1319
|
+
# Required. Format: buyers/`accountId`/proposals/`proposalId`/deals/`dealId`
|
|
1320
|
+
# @param [String] fields
|
|
1321
|
+
# Selector specifying which fields to include in a partial response.
|
|
1322
|
+
# @param [String] quota_user
|
|
1323
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1324
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1325
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1326
|
+
# Request-specific options
|
|
1327
|
+
#
|
|
1328
|
+
# @yield [result, err] Result & error if block supplied
|
|
1329
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Deal] parsed result object
|
|
1330
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1331
|
+
#
|
|
1332
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Deal]
|
|
1333
|
+
#
|
|
1334
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1335
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1336
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1337
|
+
def get_buyer_proposal_deal(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1338
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
1339
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
|
|
1340
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal
|
|
1341
|
+
command.params['name'] = name unless name.nil?
|
|
1342
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1343
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1344
|
+
execute_or_queue_command(command, &block)
|
|
1345
|
+
end
|
|
1346
|
+
|
|
1347
|
+
# Lists all deals in a proposal. To retrieve only the finalized revision deals
|
|
1348
|
+
# regardless if a deal is being renegotiated, see the FinalizedDeals resource.
|
|
1349
|
+
# @param [String] parent
|
|
1350
|
+
# Required. The name of the proposal containing the deals to retrieve. Format:
|
|
1351
|
+
# buyers/`accountId`/proposals/`proposalId`
|
|
1352
|
+
# @param [Fixnum] page_size
|
|
1353
|
+
# Requested page size. The server may return fewer results than requested. If
|
|
1354
|
+
# requested more than 500, the server will return 500 results per page. If
|
|
1355
|
+
# unspecified, the server will pick a default page size of 100.
|
|
1356
|
+
# @param [String] page_token
|
|
1357
|
+
# The page token as returned from ListDealsResponse.
|
|
1358
|
+
# @param [String] fields
|
|
1359
|
+
# Selector specifying which fields to include in a partial response.
|
|
1360
|
+
# @param [String] quota_user
|
|
1361
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1362
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1363
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1364
|
+
# Request-specific options
|
|
1365
|
+
#
|
|
1366
|
+
# @yield [result, err] Result & error if block supplied
|
|
1367
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse] parsed result object
|
|
1368
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1369
|
+
#
|
|
1370
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse]
|
|
1371
|
+
#
|
|
1372
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1373
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1374
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1375
|
+
def list_buyer_proposal_deals(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1376
|
+
command = make_simple_command(:get, 'v1/{+parent}/deals', options)
|
|
1377
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse::Representation
|
|
1378
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse
|
|
1379
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1380
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1381
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1382
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1383
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1384
|
+
execute_or_queue_command(command, &block)
|
|
1385
|
+
end
|
|
1386
|
+
|
|
1387
|
+
# Updates the given deal at the buyer known revision number. If the server
|
|
1388
|
+
# revision has advanced since the passed-in proposal.proposal_revision an
|
|
1389
|
+
# ABORTED error message will be returned. The revision number is incremented by
|
|
1390
|
+
# the server whenever the proposal or its constituent deals are updated. Note:
|
|
1391
|
+
# The revision number is kept at a proposal level. The buyer of the API is
|
|
1392
|
+
# expected to keep track of the revision number after the last update operation
|
|
1393
|
+
# and send it in as part of the next update request. This way, if there are
|
|
1394
|
+
# further changes on the server (e.g., seller making new updates), then the
|
|
1395
|
+
# server can detect conflicts and reject the proposed changes.
|
|
1396
|
+
# @param [String] name
|
|
1397
|
+
# Immutable. The unique identifier of the deal. Auto-generated by the server
|
|
1398
|
+
# when a deal is created. Format: buyers/`accountId`/proposals/`proposalId`/
|
|
1399
|
+
# deals/`dealId`
|
|
1400
|
+
# @param [Google::Apis::AuthorizedbuyersmarketplaceV1::Deal] deal_object
|
|
1401
|
+
# @param [String] update_mask
|
|
1402
|
+
# List of fields to be updated. If empty or unspecified, the service will update
|
|
1403
|
+
# all fields populated in the update request excluding the output only fields
|
|
1404
|
+
# and primitive fields with default value. Note that explicit field mask is
|
|
1405
|
+
# required in order to reset a primitive field back to its default value, e.g.
|
|
1406
|
+
# false for boolean fields, 0 for integer fields. A special field mask
|
|
1407
|
+
# consisting of a single path "*" can be used to indicate full replacement(the
|
|
1408
|
+
# equivalent of PUT method), updatable fields unset or unspecified in the input
|
|
1409
|
+
# will be cleared or set to default value. Output only fields will be ignored
|
|
1410
|
+
# regardless of the value of updateMask.
|
|
1411
|
+
# @param [String] fields
|
|
1412
|
+
# Selector specifying which fields to include in a partial response.
|
|
1413
|
+
# @param [String] quota_user
|
|
1414
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1415
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1416
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1417
|
+
# Request-specific options
|
|
1418
|
+
#
|
|
1419
|
+
# @yield [result, err] Result & error if block supplied
|
|
1420
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::Deal] parsed result object
|
|
1421
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1422
|
+
#
|
|
1423
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::Deal]
|
|
1424
|
+
#
|
|
1425
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1426
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1427
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1428
|
+
def patch_buyer_proposal_deal(name, deal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1429
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
1430
|
+
command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
|
|
1431
|
+
command.request_object = deal_object
|
|
1432
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
|
|
1433
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal
|
|
1434
|
+
command.params['name'] = name unless name.nil?
|
|
1435
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1436
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1437
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1438
|
+
execute_or_queue_command(command, &block)
|
|
1439
|
+
end
|
|
1440
|
+
|
|
1441
|
+
# Gets the requested publisher profile by name.
|
|
1442
|
+
# @param [String] name
|
|
1443
|
+
# Required. Name of the publisher profile. Format: `buyers/`buyerId`/
|
|
1444
|
+
# publisherProfiles/`publisherProfileId``
|
|
1445
|
+
# @param [String] fields
|
|
1446
|
+
# Selector specifying which fields to include in a partial response.
|
|
1447
|
+
# @param [String] quota_user
|
|
1448
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1449
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1450
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1451
|
+
# Request-specific options
|
|
1452
|
+
#
|
|
1453
|
+
# @yield [result, err] Result & error if block supplied
|
|
1454
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile] parsed result object
|
|
1455
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1456
|
+
#
|
|
1457
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile]
|
|
1458
|
+
#
|
|
1459
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1460
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1461
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1462
|
+
def get_buyer_publisher_profile(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1463
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
1464
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile::Representation
|
|
1465
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile
|
|
1466
|
+
command.params['name'] = name unless name.nil?
|
|
1467
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1468
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1469
|
+
execute_or_queue_command(command, &block)
|
|
1470
|
+
end
|
|
1471
|
+
|
|
1472
|
+
# Lists publisher profiles
|
|
1473
|
+
# @param [String] parent
|
|
1474
|
+
# Required. Parent that owns the collection of publisher profiles Format: `
|
|
1475
|
+
# buyers/`buyerId``
|
|
1476
|
+
# @param [String] filter
|
|
1477
|
+
# Optional query string using the [Cloud API list filtering] (https://developers.
|
|
1478
|
+
# google.com/authorized-buyers/apis/guides/v2/list-filters) syntax.
|
|
1479
|
+
# @param [Fixnum] page_size
|
|
1480
|
+
# Requested page size. The server may return fewer results than requested. If
|
|
1481
|
+
# requested more than 500, the server will return 500 results per page. If
|
|
1482
|
+
# unspecified, the server will pick a default page size of 100.
|
|
1483
|
+
# @param [String] page_token
|
|
1484
|
+
# The page token as returned from a previous ListPublisherProfilesResponse.
|
|
1485
|
+
# @param [String] fields
|
|
1486
|
+
# Selector specifying which fields to include in a partial response.
|
|
1487
|
+
# @param [String] quota_user
|
|
1488
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1489
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1490
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1491
|
+
# Request-specific options
|
|
1492
|
+
#
|
|
1493
|
+
# @yield [result, err] Result & error if block supplied
|
|
1494
|
+
# @yieldparam result [Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse] parsed result object
|
|
1495
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1496
|
+
#
|
|
1497
|
+
# @return [Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse]
|
|
1498
|
+
#
|
|
1499
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1500
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1501
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1502
|
+
def list_buyer_publisher_profiles(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1503
|
+
command = make_simple_command(:get, 'v1/{+parent}/publisherProfiles', options)
|
|
1504
|
+
command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse::Representation
|
|
1505
|
+
command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse
|
|
1506
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1507
|
+
command.query['filter'] = filter unless filter.nil?
|
|
1508
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1509
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1510
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1511
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1512
|
+
execute_or_queue_command(command, &block)
|
|
1513
|
+
end
|
|
1514
|
+
|
|
1515
|
+
protected
|
|
1516
|
+
|
|
1517
|
+
def apply_command_defaults(command)
|
|
1518
|
+
command.query['key'] = key unless key.nil?
|
|
1519
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1520
|
+
end
|
|
1521
|
+
end
|
|
1522
|
+
end
|
|
1523
|
+
end
|
|
1524
|
+
end
|