google-apis-curationpartners_v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +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/curationpartners_v1/classes.rb +1689 -0
- data/lib/google/apis/curationpartners_v1/gem_version.rb +28 -0
- data/lib/google/apis/curationpartners_v1/representations.rb +773 -0
- data/lib/google/apis/curationpartners_v1/service.rb +852 -0
- data/lib/google/apis/curationpartners_v1.rb +38 -0
- data/lib/google-apis-curationpartners_v1.rb +15 -0
- metadata +79 -0
|
@@ -0,0 +1,852 @@
|
|
|
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 CurationpartnersV1
|
|
23
|
+
# Curation Partners API
|
|
24
|
+
#
|
|
25
|
+
# Curation partners API is an externally available HTTP API for curators to
|
|
26
|
+
# programmatically manage their data segments and curated packages used by ad
|
|
27
|
+
# agencies.
|
|
28
|
+
#
|
|
29
|
+
# @example
|
|
30
|
+
# require 'google/apis/curationpartners_v1'
|
|
31
|
+
#
|
|
32
|
+
# Curationpartners = Google::Apis::CurationpartnersV1 # Alias the module
|
|
33
|
+
# service = Curationpartners::CurationPartnersService.new
|
|
34
|
+
#
|
|
35
|
+
# @see https://developers.google.com/authorized-buyers/curation/apis/guides/curationpartners/overview
|
|
36
|
+
class CurationPartnersService < Google::Apis::Core::BaseService
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://curationpartners.$UNIVERSE_DOMAIN$/"
|
|
38
|
+
|
|
39
|
+
# @return [String]
|
|
40
|
+
# API key. Your API key identifies your project and provides you with API access,
|
|
41
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
42
|
+
attr_accessor :key
|
|
43
|
+
|
|
44
|
+
# @return [String]
|
|
45
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
46
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
47
|
+
attr_accessor :quota_user
|
|
48
|
+
|
|
49
|
+
def initialize
|
|
50
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
|
51
|
+
client_name: 'google-apis-curationpartners_v1',
|
|
52
|
+
client_version: Google::Apis::CurationpartnersV1::GEM_VERSION)
|
|
53
|
+
@batch_path = 'batch'
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Activates an existing curated package.
|
|
57
|
+
# @param [String] name
|
|
58
|
+
# Required. The name of the curated package to activate. Format: `curators/`
|
|
59
|
+
# accountId`/curatedPackages/`curatedPackageId``
|
|
60
|
+
# @param [Google::Apis::CurationpartnersV1::ActivateCuratedPackageRequest] activate_curated_package_request_object
|
|
61
|
+
# @param [String] fields
|
|
62
|
+
# Selector specifying which fields to include in a partial response.
|
|
63
|
+
# @param [String] quota_user
|
|
64
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
65
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
66
|
+
# @param [Google::Apis::RequestOptions] options
|
|
67
|
+
# Request-specific options
|
|
68
|
+
#
|
|
69
|
+
# @yield [result, err] Result & error if block supplied
|
|
70
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::CuratedPackage] parsed result object
|
|
71
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
72
|
+
#
|
|
73
|
+
# @return [Google::Apis::CurationpartnersV1::CuratedPackage]
|
|
74
|
+
#
|
|
75
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
76
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
77
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
78
|
+
def activate_curated_package(name, activate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
79
|
+
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
|
80
|
+
command.request_representation = Google::Apis::CurationpartnersV1::ActivateCuratedPackageRequest::Representation
|
|
81
|
+
command.request_object = activate_curated_package_request_object
|
|
82
|
+
command.response_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
83
|
+
command.response_class = Google::Apis::CurationpartnersV1::CuratedPackage
|
|
84
|
+
command.params['name'] = name unless name.nil?
|
|
85
|
+
command.query['fields'] = fields unless fields.nil?
|
|
86
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
87
|
+
execute_or_queue_command(command, &block)
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Creates a new curated package.
|
|
91
|
+
# @param [String] parent
|
|
92
|
+
# Required. The parent curator account where this curated package will be
|
|
93
|
+
# created. Format: `curators/`accountId``
|
|
94
|
+
# @param [Google::Apis::CurationpartnersV1::CuratedPackage] curated_package_object
|
|
95
|
+
# @param [String] fields
|
|
96
|
+
# Selector specifying which fields to include in a partial response.
|
|
97
|
+
# @param [String] quota_user
|
|
98
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
99
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
100
|
+
# @param [Google::Apis::RequestOptions] options
|
|
101
|
+
# Request-specific options
|
|
102
|
+
#
|
|
103
|
+
# @yield [result, err] Result & error if block supplied
|
|
104
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::CuratedPackage] parsed result object
|
|
105
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
106
|
+
#
|
|
107
|
+
# @return [Google::Apis::CurationpartnersV1::CuratedPackage]
|
|
108
|
+
#
|
|
109
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
110
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
111
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
112
|
+
def create_curator_curated_package(parent, curated_package_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
113
|
+
command = make_simple_command(:post, 'v1/{+parent}/curatedPackages', options)
|
|
114
|
+
command.request_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
115
|
+
command.request_object = curated_package_object
|
|
116
|
+
command.response_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
117
|
+
command.response_class = Google::Apis::CurationpartnersV1::CuratedPackage
|
|
118
|
+
command.params['parent'] = parent unless parent.nil?
|
|
119
|
+
command.query['fields'] = fields unless fields.nil?
|
|
120
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
121
|
+
execute_or_queue_command(command, &block)
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Deactivates an existing curated package.
|
|
125
|
+
# @param [String] name
|
|
126
|
+
# Required. The name of the curated package to deactivate. Format: `curators/`
|
|
127
|
+
# accountId`/curatedPackages/`curatedPackageId``
|
|
128
|
+
# @param [Google::Apis::CurationpartnersV1::DeactivateCuratedPackageRequest] deactivate_curated_package_request_object
|
|
129
|
+
# @param [String] fields
|
|
130
|
+
# Selector specifying which fields to include in a partial response.
|
|
131
|
+
# @param [String] quota_user
|
|
132
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
133
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
134
|
+
# @param [Google::Apis::RequestOptions] options
|
|
135
|
+
# Request-specific options
|
|
136
|
+
#
|
|
137
|
+
# @yield [result, err] Result & error if block supplied
|
|
138
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::CuratedPackage] parsed result object
|
|
139
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
140
|
+
#
|
|
141
|
+
# @return [Google::Apis::CurationpartnersV1::CuratedPackage]
|
|
142
|
+
#
|
|
143
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
144
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
145
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
146
|
+
def deactivate_curated_package(name, deactivate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
147
|
+
command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
|
|
148
|
+
command.request_representation = Google::Apis::CurationpartnersV1::DeactivateCuratedPackageRequest::Representation
|
|
149
|
+
command.request_object = deactivate_curated_package_request_object
|
|
150
|
+
command.response_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
151
|
+
command.response_class = Google::Apis::CurationpartnersV1::CuratedPackage
|
|
152
|
+
command.params['name'] = name unless name.nil?
|
|
153
|
+
command.query['fields'] = fields unless fields.nil?
|
|
154
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
155
|
+
execute_or_queue_command(command, &block)
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Gets a curated package given its resource name.
|
|
159
|
+
# @param [String] name
|
|
160
|
+
# Required. The name of the curated package to retrieve. Format: `curators/`
|
|
161
|
+
# accountId`/curatedPackages/`curatedPackageId``
|
|
162
|
+
# @param [String] fields
|
|
163
|
+
# Selector specifying which fields to include in a partial response.
|
|
164
|
+
# @param [String] quota_user
|
|
165
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
166
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
167
|
+
# @param [Google::Apis::RequestOptions] options
|
|
168
|
+
# Request-specific options
|
|
169
|
+
#
|
|
170
|
+
# @yield [result, err] Result & error if block supplied
|
|
171
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::CuratedPackage] parsed result object
|
|
172
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
173
|
+
#
|
|
174
|
+
# @return [Google::Apis::CurationpartnersV1::CuratedPackage]
|
|
175
|
+
#
|
|
176
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
177
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
178
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
179
|
+
def get_curator_curated_package(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
180
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
181
|
+
command.response_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
182
|
+
command.response_class = Google::Apis::CurationpartnersV1::CuratedPackage
|
|
183
|
+
command.params['name'] = name unless name.nil?
|
|
184
|
+
command.query['fields'] = fields unless fields.nil?
|
|
185
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
186
|
+
execute_or_queue_command(command, &block)
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# Lists curated packages owned by the specified curator.
|
|
190
|
+
# @param [String] parent
|
|
191
|
+
# Required. The parent curator account which owns this collection of curated
|
|
192
|
+
# packages. Format: `curators/`accountId``
|
|
193
|
+
# @param [String] filter
|
|
194
|
+
# Optional. Optional query string using the [Cloud API list filtering syntax](/
|
|
195
|
+
# authorized-buyers/apis/guides/list-filters). Supported columns for filtering
|
|
196
|
+
# are: * displayName * createTime * updateTime * state * feeCpm.currencyCode *
|
|
197
|
+
# feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units
|
|
198
|
+
# * floorPriceCpm.nanos
|
|
199
|
+
# @param [Fixnum] page_size
|
|
200
|
+
# Optional. Requested page size. The server may return fewer results than
|
|
201
|
+
# requested. Max allowed page size is 500. If unspecified, the server will
|
|
202
|
+
# default to 500.
|
|
203
|
+
# @param [String] page_token
|
|
204
|
+
# Optional. A page token, received from a previous `ListCuratedPackages` call.
|
|
205
|
+
# Provide this to retrieve the subsequent page.
|
|
206
|
+
# @param [String] fields
|
|
207
|
+
# Selector specifying which fields to include in a partial response.
|
|
208
|
+
# @param [String] quota_user
|
|
209
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
210
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
211
|
+
# @param [Google::Apis::RequestOptions] options
|
|
212
|
+
# Request-specific options
|
|
213
|
+
#
|
|
214
|
+
# @yield [result, err] Result & error if block supplied
|
|
215
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::ListCuratedPackagesResponse] parsed result object
|
|
216
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
217
|
+
#
|
|
218
|
+
# @return [Google::Apis::CurationpartnersV1::ListCuratedPackagesResponse]
|
|
219
|
+
#
|
|
220
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
221
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
222
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
223
|
+
def list_curator_curated_packages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
224
|
+
command = make_simple_command(:get, 'v1/{+parent}/curatedPackages', options)
|
|
225
|
+
command.response_representation = Google::Apis::CurationpartnersV1::ListCuratedPackagesResponse::Representation
|
|
226
|
+
command.response_class = Google::Apis::CurationpartnersV1::ListCuratedPackagesResponse
|
|
227
|
+
command.params['parent'] = parent unless parent.nil?
|
|
228
|
+
command.query['filter'] = filter unless filter.nil?
|
|
229
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
230
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
231
|
+
command.query['fields'] = fields unless fields.nil?
|
|
232
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
233
|
+
execute_or_queue_command(command, &block)
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Updates an existing curated package.
|
|
237
|
+
# @param [String] name
|
|
238
|
+
# Identifier. The unique resource name for the curated package. Format: `
|
|
239
|
+
# curators/`accountId`/curatedPackages/`curatedPackageId``
|
|
240
|
+
# @param [Google::Apis::CurationpartnersV1::CuratedPackage] curated_package_object
|
|
241
|
+
# @param [String] update_mask
|
|
242
|
+
# Optional. List of fields to be updated. If empty or unspecified, the service
|
|
243
|
+
# will update all fields populated in the update request excluding the output
|
|
244
|
+
# only fields and primitive fields with default value. Note that explicit field
|
|
245
|
+
# mask is required in order to reset a primitive field back to its default value,
|
|
246
|
+
# for example, false for boolean fields, 0 for integer fields. A special field
|
|
247
|
+
# mask consisting of a single path "*" can be used to indicate full replacement (
|
|
248
|
+
# the equivalent of PUT method), updatable fields unset or unspecified in the
|
|
249
|
+
# input will be cleared or set to default value. Output only fields will be
|
|
250
|
+
# ignored regardless of the value of updateMask.
|
|
251
|
+
# @param [String] fields
|
|
252
|
+
# Selector specifying which fields to include in a partial response.
|
|
253
|
+
# @param [String] quota_user
|
|
254
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
255
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
256
|
+
# @param [Google::Apis::RequestOptions] options
|
|
257
|
+
# Request-specific options
|
|
258
|
+
#
|
|
259
|
+
# @yield [result, err] Result & error if block supplied
|
|
260
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::CuratedPackage] parsed result object
|
|
261
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
262
|
+
#
|
|
263
|
+
# @return [Google::Apis::CurationpartnersV1::CuratedPackage]
|
|
264
|
+
#
|
|
265
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
266
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
267
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
268
|
+
def patch_curator_curated_package(name, curated_package_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
269
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
270
|
+
command.request_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
271
|
+
command.request_object = curated_package_object
|
|
272
|
+
command.response_representation = Google::Apis::CurationpartnersV1::CuratedPackage::Representation
|
|
273
|
+
command.response_class = Google::Apis::CurationpartnersV1::CuratedPackage
|
|
274
|
+
command.params['name'] = name unless name.nil?
|
|
275
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
276
|
+
command.query['fields'] = fields unless fields.nil?
|
|
277
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
278
|
+
execute_or_queue_command(command, &block)
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
# Activates a data segment.
|
|
282
|
+
# @param [String] name
|
|
283
|
+
# Required. Name of data segment to activate. Format: `curators/`accountId`/
|
|
284
|
+
# dataSegments/`curatorDataSegmentId``
|
|
285
|
+
# @param [Google::Apis::CurationpartnersV1::ActivateDataSegmentRequest] activate_data_segment_request_object
|
|
286
|
+
# @param [String] fields
|
|
287
|
+
# Selector specifying which fields to include in a partial response.
|
|
288
|
+
# @param [String] quota_user
|
|
289
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
290
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
291
|
+
# @param [Google::Apis::RequestOptions] options
|
|
292
|
+
# Request-specific options
|
|
293
|
+
#
|
|
294
|
+
# @yield [result, err] Result & error if block supplied
|
|
295
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::DataSegment] parsed result object
|
|
296
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
297
|
+
#
|
|
298
|
+
# @return [Google::Apis::CurationpartnersV1::DataSegment]
|
|
299
|
+
#
|
|
300
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
301
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
302
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
303
|
+
def activate_data_segment(name, activate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
304
|
+
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
|
305
|
+
command.request_representation = Google::Apis::CurationpartnersV1::ActivateDataSegmentRequest::Representation
|
|
306
|
+
command.request_object = activate_data_segment_request_object
|
|
307
|
+
command.response_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
308
|
+
command.response_class = Google::Apis::CurationpartnersV1::DataSegment
|
|
309
|
+
command.params['name'] = name unless name.nil?
|
|
310
|
+
command.query['fields'] = fields unless fields.nil?
|
|
311
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
312
|
+
execute_or_queue_command(command, &block)
|
|
313
|
+
end
|
|
314
|
+
|
|
315
|
+
# Creates a data segment owned by the listed curator. The data segment will be
|
|
316
|
+
# created in the `ACTIVE` state, meaning it will be immediately available for
|
|
317
|
+
# buyers to use in preferred deals, private auction deals, and auction packages.
|
|
318
|
+
# @param [String] parent
|
|
319
|
+
# Required. The parent resource where this data segment will be created. Format:
|
|
320
|
+
# `curators/`accountId``
|
|
321
|
+
# @param [Google::Apis::CurationpartnersV1::DataSegment] data_segment_object
|
|
322
|
+
# @param [String] fields
|
|
323
|
+
# Selector specifying which fields to include in a partial response.
|
|
324
|
+
# @param [String] quota_user
|
|
325
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
326
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
327
|
+
# @param [Google::Apis::RequestOptions] options
|
|
328
|
+
# Request-specific options
|
|
329
|
+
#
|
|
330
|
+
# @yield [result, err] Result & error if block supplied
|
|
331
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::DataSegment] parsed result object
|
|
332
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
333
|
+
#
|
|
334
|
+
# @return [Google::Apis::CurationpartnersV1::DataSegment]
|
|
335
|
+
#
|
|
336
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
337
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
338
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
339
|
+
def create_curator_data_segment(parent, data_segment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
340
|
+
command = make_simple_command(:post, 'v1/{+parent}/dataSegments', options)
|
|
341
|
+
command.request_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
342
|
+
command.request_object = data_segment_object
|
|
343
|
+
command.response_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
344
|
+
command.response_class = Google::Apis::CurationpartnersV1::DataSegment
|
|
345
|
+
command.params['parent'] = parent unless parent.nil?
|
|
346
|
+
command.query['fields'] = fields unless fields.nil?
|
|
347
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
348
|
+
execute_or_queue_command(command, &block)
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# Deactivates a data segment.
|
|
352
|
+
# @param [String] name
|
|
353
|
+
# Required. Name of data segment to deactivate. Format: `curators/`accountId`/
|
|
354
|
+
# dataSegments/`curatorDataSegmentId``
|
|
355
|
+
# @param [Google::Apis::CurationpartnersV1::DeactivateDataSegmentRequest] deactivate_data_segment_request_object
|
|
356
|
+
# @param [String] fields
|
|
357
|
+
# Selector specifying which fields to include in a partial response.
|
|
358
|
+
# @param [String] quota_user
|
|
359
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
360
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
361
|
+
# @param [Google::Apis::RequestOptions] options
|
|
362
|
+
# Request-specific options
|
|
363
|
+
#
|
|
364
|
+
# @yield [result, err] Result & error if block supplied
|
|
365
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::DataSegment] parsed result object
|
|
366
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
367
|
+
#
|
|
368
|
+
# @return [Google::Apis::CurationpartnersV1::DataSegment]
|
|
369
|
+
#
|
|
370
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
371
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
372
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
373
|
+
def deactivate_data_segment(name, deactivate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
374
|
+
command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
|
|
375
|
+
command.request_representation = Google::Apis::CurationpartnersV1::DeactivateDataSegmentRequest::Representation
|
|
376
|
+
command.request_object = deactivate_data_segment_request_object
|
|
377
|
+
command.response_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
378
|
+
command.response_class = Google::Apis::CurationpartnersV1::DataSegment
|
|
379
|
+
command.params['name'] = name unless name.nil?
|
|
380
|
+
command.query['fields'] = fields unless fields.nil?
|
|
381
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
382
|
+
execute_or_queue_command(command, &block)
|
|
383
|
+
end
|
|
384
|
+
|
|
385
|
+
# Gets a data segment given its name.
|
|
386
|
+
# @param [String] name
|
|
387
|
+
# Required. Name of data segment to get. Format: `curators/`accountId`/
|
|
388
|
+
# dataSegments/`curatorDataSegmentId``
|
|
389
|
+
# @param [String] fields
|
|
390
|
+
# Selector specifying which fields to include in a partial response.
|
|
391
|
+
# @param [String] quota_user
|
|
392
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
393
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
394
|
+
# @param [Google::Apis::RequestOptions] options
|
|
395
|
+
# Request-specific options
|
|
396
|
+
#
|
|
397
|
+
# @yield [result, err] Result & error if block supplied
|
|
398
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::DataSegment] parsed result object
|
|
399
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
400
|
+
#
|
|
401
|
+
# @return [Google::Apis::CurationpartnersV1::DataSegment]
|
|
402
|
+
#
|
|
403
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
404
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
405
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
406
|
+
def get_curator_data_segment(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
407
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
408
|
+
command.response_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
409
|
+
command.response_class = Google::Apis::CurationpartnersV1::DataSegment
|
|
410
|
+
command.params['name'] = name unless name.nil?
|
|
411
|
+
command.query['fields'] = fields unless fields.nil?
|
|
412
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
413
|
+
execute_or_queue_command(command, &block)
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
# List the data segments owned by a curator.
|
|
417
|
+
# @param [String] parent
|
|
418
|
+
# Required. Name of the parent curator that can access the data segment. Format:
|
|
419
|
+
# `curators/`accountId``
|
|
420
|
+
# @param [Fixnum] page_size
|
|
421
|
+
# Optional. Requested page size. The server may return fewer results than
|
|
422
|
+
# requested. Max allowed page size is 500. If unspecified, the server will
|
|
423
|
+
# default to 500.
|
|
424
|
+
# @param [String] page_token
|
|
425
|
+
# Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
|
|
426
|
+
# @param [String] fields
|
|
427
|
+
# Selector specifying which fields to include in a partial response.
|
|
428
|
+
# @param [String] quota_user
|
|
429
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
430
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
431
|
+
# @param [Google::Apis::RequestOptions] options
|
|
432
|
+
# Request-specific options
|
|
433
|
+
#
|
|
434
|
+
# @yield [result, err] Result & error if block supplied
|
|
435
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::ListDataSegmentsResponse] parsed result object
|
|
436
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
437
|
+
#
|
|
438
|
+
# @return [Google::Apis::CurationpartnersV1::ListDataSegmentsResponse]
|
|
439
|
+
#
|
|
440
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
441
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
442
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
443
|
+
def list_curator_data_segments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
444
|
+
command = make_simple_command(:get, 'v1/{+parent}/dataSegments', options)
|
|
445
|
+
command.response_representation = Google::Apis::CurationpartnersV1::ListDataSegmentsResponse::Representation
|
|
446
|
+
command.response_class = Google::Apis::CurationpartnersV1::ListDataSegmentsResponse
|
|
447
|
+
command.params['parent'] = parent unless parent.nil?
|
|
448
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
449
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
450
|
+
command.query['fields'] = fields unless fields.nil?
|
|
451
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
452
|
+
execute_or_queue_command(command, &block)
|
|
453
|
+
end
|
|
454
|
+
|
|
455
|
+
# Updates a data segment.
|
|
456
|
+
# @param [String] name
|
|
457
|
+
# Immutable. Identifier. The unique identifier for the data segment. Account ID
|
|
458
|
+
# corresponds to the account ID that created the segment. Format: `curators/`
|
|
459
|
+
# curatorAccountId`/dataSegments/`curatorDataSegmentId``
|
|
460
|
+
# @param [Google::Apis::CurationpartnersV1::DataSegment] data_segment_object
|
|
461
|
+
# @param [String] update_mask
|
|
462
|
+
# Optional. List of fields to be updated. If empty or unspecified, the service
|
|
463
|
+
# will update all fields populated in the update request excluding the output
|
|
464
|
+
# only fields and primitive fields with default value. Note that explicit field
|
|
465
|
+
# mask is required in order to reset a primitive field back to its default value,
|
|
466
|
+
# for example, false for boolean fields, 0 for integer fields. A special field
|
|
467
|
+
# mask consisting of a single path "*" can be used to indicate full replacement(
|
|
468
|
+
# the equivalent of PUT method), updatable fields unset or unspecified in the
|
|
469
|
+
# input will be cleared or set to default value. Output only fields will be
|
|
470
|
+
# ignored regardless of the value of updateMask.
|
|
471
|
+
# @param [String] fields
|
|
472
|
+
# Selector specifying which fields to include in a partial response.
|
|
473
|
+
# @param [String] quota_user
|
|
474
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
475
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
476
|
+
# @param [Google::Apis::RequestOptions] options
|
|
477
|
+
# Request-specific options
|
|
478
|
+
#
|
|
479
|
+
# @yield [result, err] Result & error if block supplied
|
|
480
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::DataSegment] parsed result object
|
|
481
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
482
|
+
#
|
|
483
|
+
# @return [Google::Apis::CurationpartnersV1::DataSegment]
|
|
484
|
+
#
|
|
485
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
486
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
487
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
488
|
+
def patch_curator_data_segment(name, data_segment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
489
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
490
|
+
command.request_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
491
|
+
command.request_object = data_segment_object
|
|
492
|
+
command.response_representation = Google::Apis::CurationpartnersV1::DataSegment::Representation
|
|
493
|
+
command.response_class = Google::Apis::CurationpartnersV1::DataSegment
|
|
494
|
+
command.params['name'] = name unless name.nil?
|
|
495
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
496
|
+
command.query['fields'] = fields unless fields.nil?
|
|
497
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
498
|
+
execute_or_queue_command(command, &block)
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Creates a `Report` object.
|
|
502
|
+
# @param [String] parent
|
|
503
|
+
# Required. The parent resource where this `Report` will be created. Format: `
|
|
504
|
+
# curators/`account_id``
|
|
505
|
+
# @param [Google::Apis::CurationpartnersV1::Report] report_object
|
|
506
|
+
# @param [String] fields
|
|
507
|
+
# Selector specifying which fields to include in a partial response.
|
|
508
|
+
# @param [String] quota_user
|
|
509
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
510
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
511
|
+
# @param [Google::Apis::RequestOptions] options
|
|
512
|
+
# Request-specific options
|
|
513
|
+
#
|
|
514
|
+
# @yield [result, err] Result & error if block supplied
|
|
515
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Report] parsed result object
|
|
516
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
517
|
+
#
|
|
518
|
+
# @return [Google::Apis::CurationpartnersV1::Report]
|
|
519
|
+
#
|
|
520
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
521
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
522
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
523
|
+
def create_curator_report(parent, report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
524
|
+
command = make_simple_command(:post, 'v1/{+parent}/reports', options)
|
|
525
|
+
command.request_representation = Google::Apis::CurationpartnersV1::Report::Representation
|
|
526
|
+
command.request_object = report_object
|
|
527
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Report::Representation
|
|
528
|
+
command.response_class = Google::Apis::CurationpartnersV1::Report
|
|
529
|
+
command.params['parent'] = parent unless parent.nil?
|
|
530
|
+
command.query['fields'] = fields unless fields.nil?
|
|
531
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
532
|
+
execute_or_queue_command(command, &block)
|
|
533
|
+
end
|
|
534
|
+
|
|
535
|
+
# Deletes a `Report` object.
|
|
536
|
+
# @param [String] name
|
|
537
|
+
# Required. Resource name of the report to delete. Format: `curators/`account_id`
|
|
538
|
+
# /reports/`report_id``
|
|
539
|
+
# @param [String] fields
|
|
540
|
+
# Selector specifying which fields to include in a partial response.
|
|
541
|
+
# @param [String] quota_user
|
|
542
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
543
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
544
|
+
# @param [Google::Apis::RequestOptions] options
|
|
545
|
+
# Request-specific options
|
|
546
|
+
#
|
|
547
|
+
# @yield [result, err] Result & error if block supplied
|
|
548
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Empty] parsed result object
|
|
549
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
550
|
+
#
|
|
551
|
+
# @return [Google::Apis::CurationpartnersV1::Empty]
|
|
552
|
+
#
|
|
553
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
554
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
555
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
556
|
+
def delete_curator_report(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
557
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
558
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Empty::Representation
|
|
559
|
+
command.response_class = Google::Apis::CurationpartnersV1::Empty
|
|
560
|
+
command.params['name'] = name unless name.nil?
|
|
561
|
+
command.query['fields'] = fields unless fields.nil?
|
|
562
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
563
|
+
execute_or_queue_command(command, &block)
|
|
564
|
+
end
|
|
565
|
+
|
|
566
|
+
# Retrieves a `Report` object.
|
|
567
|
+
# @param [String] name
|
|
568
|
+
# Required. The resource name of the report. Format: `curators/`account_id`/
|
|
569
|
+
# reports/`report_id``
|
|
570
|
+
# @param [String] fields
|
|
571
|
+
# Selector specifying which fields to include in a partial response.
|
|
572
|
+
# @param [String] quota_user
|
|
573
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
574
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
575
|
+
# @param [Google::Apis::RequestOptions] options
|
|
576
|
+
# Request-specific options
|
|
577
|
+
#
|
|
578
|
+
# @yield [result, err] Result & error if block supplied
|
|
579
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Report] parsed result object
|
|
580
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
581
|
+
#
|
|
582
|
+
# @return [Google::Apis::CurationpartnersV1::Report]
|
|
583
|
+
#
|
|
584
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
585
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
586
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
587
|
+
def get_curator_report(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
588
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
589
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Report::Representation
|
|
590
|
+
command.response_class = Google::Apis::CurationpartnersV1::Report
|
|
591
|
+
command.params['name'] = name unless name.nil?
|
|
592
|
+
command.query['fields'] = fields unless fields.nil?
|
|
593
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
594
|
+
execute_or_queue_command(command, &block)
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
# Lists `Report` objects.
|
|
598
|
+
# @param [String] parent
|
|
599
|
+
# Required. The parent, which owns this collection of reports. Format: `curators/
|
|
600
|
+
# `account_id``
|
|
601
|
+
# @param [String] filter
|
|
602
|
+
# Optional. Expression to filter the response. See syntax details at https://
|
|
603
|
+
# developers.google.com/ad-manager/api/beta/filters
|
|
604
|
+
# @param [String] order_by
|
|
605
|
+
# Optional. Expression to specify sorting order. See syntax details at https://
|
|
606
|
+
# developers.google.com/ad-manager/api/beta/filters#order
|
|
607
|
+
# @param [Fixnum] page_size
|
|
608
|
+
# Optional. The maximum number of `Reports` to return. The service may return
|
|
609
|
+
# fewer than this value. If unspecified, at most 50 `Reports` will be returned.
|
|
610
|
+
# The maximum value is 1000; values greater than 1000 will be coerced to 1000.
|
|
611
|
+
# @param [String] page_token
|
|
612
|
+
# Optional. A page token, received from a previous `ListReports` call. Provide
|
|
613
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
614
|
+
# provided to `ListReports` must match the call that provided the page token.
|
|
615
|
+
# @param [Fixnum] skip
|
|
616
|
+
# Optional. Number of individual resources to skip while paginating.
|
|
617
|
+
# @param [String] fields
|
|
618
|
+
# Selector specifying which fields to include in a partial response.
|
|
619
|
+
# @param [String] quota_user
|
|
620
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
621
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
622
|
+
# @param [Google::Apis::RequestOptions] options
|
|
623
|
+
# Request-specific options
|
|
624
|
+
#
|
|
625
|
+
# @yield [result, err] Result & error if block supplied
|
|
626
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::ListReportsResponse] parsed result object
|
|
627
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
628
|
+
#
|
|
629
|
+
# @return [Google::Apis::CurationpartnersV1::ListReportsResponse]
|
|
630
|
+
#
|
|
631
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
632
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
633
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
634
|
+
def list_curator_reports(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, skip: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
635
|
+
command = make_simple_command(:get, 'v1/{+parent}/reports', options)
|
|
636
|
+
command.response_representation = Google::Apis::CurationpartnersV1::ListReportsResponse::Representation
|
|
637
|
+
command.response_class = Google::Apis::CurationpartnersV1::ListReportsResponse
|
|
638
|
+
command.params['parent'] = parent unless parent.nil?
|
|
639
|
+
command.query['filter'] = filter unless filter.nil?
|
|
640
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
641
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
642
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
643
|
+
command.query['skip'] = skip unless skip.nil?
|
|
644
|
+
command.query['fields'] = fields unless fields.nil?
|
|
645
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
646
|
+
execute_or_queue_command(command, &block)
|
|
647
|
+
end
|
|
648
|
+
|
|
649
|
+
# Updates a `Report` object.
|
|
650
|
+
# @param [String] name
|
|
651
|
+
# Identifier. The resource name of the report. Report resource name have the
|
|
652
|
+
# form: `curators/`account_id`/reports/`report_id``
|
|
653
|
+
# @param [Google::Apis::CurationpartnersV1::Report] report_object
|
|
654
|
+
# @param [String] update_mask
|
|
655
|
+
# Optional. The list of fields to update.
|
|
656
|
+
# @param [String] fields
|
|
657
|
+
# Selector specifying which fields to include in a partial response.
|
|
658
|
+
# @param [String] quota_user
|
|
659
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
660
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
661
|
+
# @param [Google::Apis::RequestOptions] options
|
|
662
|
+
# Request-specific options
|
|
663
|
+
#
|
|
664
|
+
# @yield [result, err] Result & error if block supplied
|
|
665
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Report] parsed result object
|
|
666
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
667
|
+
#
|
|
668
|
+
# @return [Google::Apis::CurationpartnersV1::Report]
|
|
669
|
+
#
|
|
670
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
671
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
672
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
673
|
+
def patch_curator_report(name, report_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
674
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
675
|
+
command.request_representation = Google::Apis::CurationpartnersV1::Report::Representation
|
|
676
|
+
command.request_object = report_object
|
|
677
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Report::Representation
|
|
678
|
+
command.response_class = Google::Apis::CurationpartnersV1::Report
|
|
679
|
+
command.params['name'] = name unless name.nil?
|
|
680
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
681
|
+
command.query['fields'] = fields unless fields.nil?
|
|
682
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
683
|
+
execute_or_queue_command(command, &block)
|
|
684
|
+
end
|
|
685
|
+
|
|
686
|
+
# Initiates the execution of an existing report asynchronously. Users can get
|
|
687
|
+
# the report by polling this operation using `OperationsService.GetOperation`.
|
|
688
|
+
# Poll every 5 seconds initially, with an exponential backoff. Once a report is
|
|
689
|
+
# complete, the operation will contain a `RunReportResponse` in its response
|
|
690
|
+
# field containing a report_result that can be passed to the `
|
|
691
|
+
# FetchReportResultRows` method to retrieve the report data.
|
|
692
|
+
# @param [String] name
|
|
693
|
+
# Required. The report to run. Format: `curators/`account_id`/reports/`report_id`
|
|
694
|
+
# `
|
|
695
|
+
# @param [Google::Apis::CurationpartnersV1::RunReportRequest] run_report_request_object
|
|
696
|
+
# @param [String] fields
|
|
697
|
+
# Selector specifying which fields to include in a partial response.
|
|
698
|
+
# @param [String] quota_user
|
|
699
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
700
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
701
|
+
# @param [Google::Apis::RequestOptions] options
|
|
702
|
+
# Request-specific options
|
|
703
|
+
#
|
|
704
|
+
# @yield [result, err] Result & error if block supplied
|
|
705
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Operation] parsed result object
|
|
706
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
707
|
+
#
|
|
708
|
+
# @return [Google::Apis::CurationpartnersV1::Operation]
|
|
709
|
+
#
|
|
710
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
711
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
712
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
713
|
+
def run_report(name, run_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
714
|
+
command = make_simple_command(:post, 'v1/{+name}:run', options)
|
|
715
|
+
command.request_representation = Google::Apis::CurationpartnersV1::RunReportRequest::Representation
|
|
716
|
+
command.request_object = run_report_request_object
|
|
717
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Operation::Representation
|
|
718
|
+
command.response_class = Google::Apis::CurationpartnersV1::Operation
|
|
719
|
+
command.params['name'] = name unless name.nil?
|
|
720
|
+
command.query['fields'] = fields unless fields.nil?
|
|
721
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
722
|
+
execute_or_queue_command(command, &block)
|
|
723
|
+
end
|
|
724
|
+
|
|
725
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
726
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
727
|
+
# @param [String] name
|
|
728
|
+
# The name of the operation resource.
|
|
729
|
+
# @param [String] fields
|
|
730
|
+
# Selector specifying which fields to include in a partial response.
|
|
731
|
+
# @param [String] quota_user
|
|
732
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
733
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
734
|
+
# @param [Google::Apis::RequestOptions] options
|
|
735
|
+
# Request-specific options
|
|
736
|
+
#
|
|
737
|
+
# @yield [result, err] Result & error if block supplied
|
|
738
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::Operation] parsed result object
|
|
739
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
740
|
+
#
|
|
741
|
+
# @return [Google::Apis::CurationpartnersV1::Operation]
|
|
742
|
+
#
|
|
743
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
744
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
745
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
746
|
+
def get_curator_report_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
747
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
748
|
+
command.response_representation = Google::Apis::CurationpartnersV1::Operation::Representation
|
|
749
|
+
command.response_class = Google::Apis::CurationpartnersV1::Operation
|
|
750
|
+
command.params['name'] = name unless name.nil?
|
|
751
|
+
command.query['fields'] = fields unless fields.nil?
|
|
752
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
753
|
+
execute_or_queue_command(command, &block)
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
# Returns the result rows from a completed report. The caller must have
|
|
757
|
+
# previously called `RunReport` and waited for that operation to complete. The
|
|
758
|
+
# rows will be returned according to the order specified by the `sorts` member
|
|
759
|
+
# of the report definition.
|
|
760
|
+
# @param [String] name
|
|
761
|
+
# The report result being fetched. Format: `curators/`account_id`/reports/`
|
|
762
|
+
# report_id`/results/`report_result_id``
|
|
763
|
+
# @param [Fixnum] page_size
|
|
764
|
+
# Optional. The maximum number of rows to return. The service may return fewer
|
|
765
|
+
# than this value. If unspecified, at most 1,000 rows will be returned. The
|
|
766
|
+
# maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.
|
|
767
|
+
# @param [String] page_token
|
|
768
|
+
# Optional. A page token, received from a previous `FetchReportResultRows` call.
|
|
769
|
+
# Provide this to retrieve the second and subsequent batches of rows.
|
|
770
|
+
# @param [String] fields
|
|
771
|
+
# Selector specifying which fields to include in a partial response.
|
|
772
|
+
# @param [String] quota_user
|
|
773
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
774
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
775
|
+
# @param [Google::Apis::RequestOptions] options
|
|
776
|
+
# Request-specific options
|
|
777
|
+
#
|
|
778
|
+
# @yield [result, err] Result & error if block supplied
|
|
779
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::FetchReportResultRowsResponse] parsed result object
|
|
780
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
781
|
+
#
|
|
782
|
+
# @return [Google::Apis::CurationpartnersV1::FetchReportResultRowsResponse]
|
|
783
|
+
#
|
|
784
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
785
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
786
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
787
|
+
def fetch_curator_report_result_rows(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
788
|
+
command = make_simple_command(:get, 'v1/{+name}:fetchRows', options)
|
|
789
|
+
command.response_representation = Google::Apis::CurationpartnersV1::FetchReportResultRowsResponse::Representation
|
|
790
|
+
command.response_class = Google::Apis::CurationpartnersV1::FetchReportResultRowsResponse
|
|
791
|
+
command.params['name'] = name unless name.nil?
|
|
792
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
793
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
794
|
+
command.query['fields'] = fields unless fields.nil?
|
|
795
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
796
|
+
execute_or_queue_command(command, &block)
|
|
797
|
+
end
|
|
798
|
+
|
|
799
|
+
# Lists all media planner accounts that the caller has access to. For curators,
|
|
800
|
+
# this will return all media planners that have accepted curator terms. For
|
|
801
|
+
# other accounts, attempting to list media planners will return an error.
|
|
802
|
+
# @param [String] filter
|
|
803
|
+
# Optional query string using the [Cloud API list filtering syntax](/authorized-
|
|
804
|
+
# buyers/apis/guides/list-filters). Supported columns for filtering are: * `name`
|
|
805
|
+
# * `displayName` * `ancestorNames`
|
|
806
|
+
# @param [Fixnum] page_size
|
|
807
|
+
# The maximum number of media planners to return. If unspecified, at most 100
|
|
808
|
+
# media planners will be returned. The maximum value is 500; values above 500
|
|
809
|
+
# will be coerced to 500.
|
|
810
|
+
# @param [String] page_token
|
|
811
|
+
# Optional. A token identifying a page of results the server should return.This
|
|
812
|
+
# value is received from a previous `ListMediaPlanners` call in
|
|
813
|
+
# ListMediaPlannersResponse.nextPageToken.
|
|
814
|
+
# @param [String] fields
|
|
815
|
+
# Selector specifying which fields to include in a partial response.
|
|
816
|
+
# @param [String] quota_user
|
|
817
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
818
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
819
|
+
# @param [Google::Apis::RequestOptions] options
|
|
820
|
+
# Request-specific options
|
|
821
|
+
#
|
|
822
|
+
# @yield [result, err] Result & error if block supplied
|
|
823
|
+
# @yieldparam result [Google::Apis::CurationpartnersV1::ListMediaPlannersResponse] parsed result object
|
|
824
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
825
|
+
#
|
|
826
|
+
# @return [Google::Apis::CurationpartnersV1::ListMediaPlannersResponse]
|
|
827
|
+
#
|
|
828
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
829
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
830
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
831
|
+
def list_media_planners(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
832
|
+
command = make_simple_command(:get, 'v1/mediaPlanners', options)
|
|
833
|
+
command.response_representation = Google::Apis::CurationpartnersV1::ListMediaPlannersResponse::Representation
|
|
834
|
+
command.response_class = Google::Apis::CurationpartnersV1::ListMediaPlannersResponse
|
|
835
|
+
command.query['filter'] = filter unless filter.nil?
|
|
836
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
837
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
838
|
+
command.query['fields'] = fields unless fields.nil?
|
|
839
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
840
|
+
execute_or_queue_command(command, &block)
|
|
841
|
+
end
|
|
842
|
+
|
|
843
|
+
protected
|
|
844
|
+
|
|
845
|
+
def apply_command_defaults(command)
|
|
846
|
+
command.query['key'] = key unless key.nil?
|
|
847
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
848
|
+
end
|
|
849
|
+
end
|
|
850
|
+
end
|
|
851
|
+
end
|
|
852
|
+
end
|