google-apis-adsenseplatform_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/adsenseplatform_v1/classes.rb +412 -0
- data/lib/google/apis/adsenseplatform_v1/gem_version.rb +28 -0
- data/lib/google/apis/adsenseplatform_v1/representations.rb +219 -0
- data/lib/google/apis/adsenseplatform_v1/service.rb +438 -0
- data/lib/google/apis/adsenseplatform_v1.rb +39 -0
- data/lib/google-apis-adsenseplatform_v1.rb +15 -0
- metadata +82 -0
@@ -0,0 +1,438 @@
|
|
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 AdsenseplatformV1
|
23
|
+
# AdSense Platform API
|
24
|
+
#
|
25
|
+
#
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/adsenseplatform_v1'
|
29
|
+
#
|
30
|
+
# Adsenseplatform = Google::Apis::AdsenseplatformV1 # Alias the module
|
31
|
+
# service = Adsenseplatform::AdSensePlatformService.new
|
32
|
+
#
|
33
|
+
# @see https://developers.google.com/adsense/platforms/
|
34
|
+
class AdSensePlatformService < Google::Apis::Core::BaseService
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://adsenseplatform.$UNIVERSE_DOMAIN$/"
|
36
|
+
|
37
|
+
# @return [String]
|
38
|
+
# API key. Your API key identifies your project and provides you with API access,
|
39
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
40
|
+
attr_accessor :key
|
41
|
+
|
42
|
+
# @return [String]
|
43
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
44
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
45
|
+
attr_accessor :quota_user
|
46
|
+
|
47
|
+
def initialize
|
48
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
49
|
+
client_name: 'google-apis-adsenseplatform_v1',
|
50
|
+
client_version: Google::Apis::AdsenseplatformV1::GEM_VERSION)
|
51
|
+
@batch_path = 'batch'
|
52
|
+
end
|
53
|
+
|
54
|
+
# Closes a sub-account.
|
55
|
+
# @param [String] name
|
56
|
+
# Required. Account to close. Format: platforms/`platform`/accounts/`account_id`
|
57
|
+
# @param [Google::Apis::AdsenseplatformV1::CloseAccountRequest] close_account_request_object
|
58
|
+
# @param [String] fields
|
59
|
+
# Selector specifying which fields to include in a partial response.
|
60
|
+
# @param [String] quota_user
|
61
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
62
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
63
|
+
# @param [Google::Apis::RequestOptions] options
|
64
|
+
# Request-specific options
|
65
|
+
#
|
66
|
+
# @yield [result, err] Result & error if block supplied
|
67
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::CloseAccountResponse] parsed result object
|
68
|
+
# @yieldparam err [StandardError] error object if request failed
|
69
|
+
#
|
70
|
+
# @return [Google::Apis::AdsenseplatformV1::CloseAccountResponse]
|
71
|
+
#
|
72
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
73
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
74
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
75
|
+
def close_account(name, close_account_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
76
|
+
command = make_simple_command(:post, 'v1/{+name}:close', options)
|
77
|
+
command.request_representation = Google::Apis::AdsenseplatformV1::CloseAccountRequest::Representation
|
78
|
+
command.request_object = close_account_request_object
|
79
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::CloseAccountResponse::Representation
|
80
|
+
command.response_class = Google::Apis::AdsenseplatformV1::CloseAccountResponse
|
81
|
+
command.params['name'] = name unless name.nil?
|
82
|
+
command.query['fields'] = fields unless fields.nil?
|
83
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
84
|
+
execute_or_queue_command(command, &block)
|
85
|
+
end
|
86
|
+
|
87
|
+
# Creates a sub-account.
|
88
|
+
# @param [String] parent
|
89
|
+
# Required. Platform to create an account for. Format: platforms/`platform`
|
90
|
+
# @param [Google::Apis::AdsenseplatformV1::Account] account_object
|
91
|
+
# @param [String] fields
|
92
|
+
# Selector specifying which fields to include in a partial response.
|
93
|
+
# @param [String] quota_user
|
94
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
95
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
96
|
+
# @param [Google::Apis::RequestOptions] options
|
97
|
+
# Request-specific options
|
98
|
+
#
|
99
|
+
# @yield [result, err] Result & error if block supplied
|
100
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Account] parsed result object
|
101
|
+
# @yieldparam err [StandardError] error object if request failed
|
102
|
+
#
|
103
|
+
# @return [Google::Apis::AdsenseplatformV1::Account]
|
104
|
+
#
|
105
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
106
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
107
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
108
|
+
def create_platform_account(parent, account_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
109
|
+
command = make_simple_command(:post, 'v1/{+parent}/accounts', options)
|
110
|
+
command.request_representation = Google::Apis::AdsenseplatformV1::Account::Representation
|
111
|
+
command.request_object = account_object
|
112
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Account::Representation
|
113
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Account
|
114
|
+
command.params['parent'] = parent unless parent.nil?
|
115
|
+
command.query['fields'] = fields unless fields.nil?
|
116
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
117
|
+
execute_or_queue_command(command, &block)
|
118
|
+
end
|
119
|
+
|
120
|
+
# Gets information about the selected sub-account.
|
121
|
+
# @param [String] name
|
122
|
+
# Required. Account to get information about. Format: platforms/`platform`/
|
123
|
+
# accounts/`account_id`
|
124
|
+
# @param [String] fields
|
125
|
+
# Selector specifying which fields to include in a partial response.
|
126
|
+
# @param [String] quota_user
|
127
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
128
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
129
|
+
# @param [Google::Apis::RequestOptions] options
|
130
|
+
# Request-specific options
|
131
|
+
#
|
132
|
+
# @yield [result, err] Result & error if block supplied
|
133
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Account] parsed result object
|
134
|
+
# @yieldparam err [StandardError] error object if request failed
|
135
|
+
#
|
136
|
+
# @return [Google::Apis::AdsenseplatformV1::Account]
|
137
|
+
#
|
138
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
139
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
140
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
141
|
+
def get_platform_account(name, fields: nil, quota_user: nil, options: nil, &block)
|
142
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
143
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Account::Representation
|
144
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Account
|
145
|
+
command.params['name'] = name unless name.nil?
|
146
|
+
command.query['fields'] = fields unless fields.nil?
|
147
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
148
|
+
execute_or_queue_command(command, &block)
|
149
|
+
end
|
150
|
+
|
151
|
+
# Lists a partial view of sub-accounts for a specific parent account.
|
152
|
+
# @param [String] parent
|
153
|
+
# Required. Platform who parents the accounts. Format: platforms/`platform`
|
154
|
+
# @param [Fixnum] page_size
|
155
|
+
# Optional. The maximum number of accounts to include in the response, used for
|
156
|
+
# paging. If unspecified, at most 10000 accounts will be returned. The maximum
|
157
|
+
# value is 10000; values above 10000 will be coerced to 10000.
|
158
|
+
# @param [String] page_token
|
159
|
+
# Optional. A page token, received from a previous `ListAccounts` call. Provide
|
160
|
+
# this to retrieve the subsequent page.
|
161
|
+
# @param [String] fields
|
162
|
+
# Selector specifying which fields to include in a partial response.
|
163
|
+
# @param [String] quota_user
|
164
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
165
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
166
|
+
# @param [Google::Apis::RequestOptions] options
|
167
|
+
# Request-specific options
|
168
|
+
#
|
169
|
+
# @yield [result, err] Result & error if block supplied
|
170
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::ListAccountsResponse] parsed result object
|
171
|
+
# @yieldparam err [StandardError] error object if request failed
|
172
|
+
#
|
173
|
+
# @return [Google::Apis::AdsenseplatformV1::ListAccountsResponse]
|
174
|
+
#
|
175
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
176
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
177
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
178
|
+
def list_platform_accounts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
179
|
+
command = make_simple_command(:get, 'v1/{+parent}/accounts', options)
|
180
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::ListAccountsResponse::Representation
|
181
|
+
command.response_class = Google::Apis::AdsenseplatformV1::ListAccountsResponse
|
182
|
+
command.params['parent'] = parent unless parent.nil?
|
183
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
184
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
185
|
+
command.query['fields'] = fields unless fields.nil?
|
186
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
187
|
+
execute_or_queue_command(command, &block)
|
188
|
+
end
|
189
|
+
|
190
|
+
# Looks up information about a sub-account for a specified creation_request_id.
|
191
|
+
# If no account exists for the given creation_request_id, returns 404.
|
192
|
+
# @param [String] parent
|
193
|
+
# Required. Platform who parents the account. Format: platforms/`platform`
|
194
|
+
# @param [String] creation_request_id
|
195
|
+
# Optional. The creation_request_id provided when calling createAccount.
|
196
|
+
# @param [String] fields
|
197
|
+
# Selector specifying which fields to include in a partial response.
|
198
|
+
# @param [String] quota_user
|
199
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
200
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
201
|
+
# @param [Google::Apis::RequestOptions] options
|
202
|
+
# Request-specific options
|
203
|
+
#
|
204
|
+
# @yield [result, err] Result & error if block supplied
|
205
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::LookupAccountResponse] parsed result object
|
206
|
+
# @yieldparam err [StandardError] error object if request failed
|
207
|
+
#
|
208
|
+
# @return [Google::Apis::AdsenseplatformV1::LookupAccountResponse]
|
209
|
+
#
|
210
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
211
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
212
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
213
|
+
def lookup_platform_account(parent, creation_request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
214
|
+
command = make_simple_command(:get, 'v1/{+parent}/accounts:lookup', options)
|
215
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::LookupAccountResponse::Representation
|
216
|
+
command.response_class = Google::Apis::AdsenseplatformV1::LookupAccountResponse
|
217
|
+
command.params['parent'] = parent unless parent.nil?
|
218
|
+
command.query['creationRequestId'] = creation_request_id unless creation_request_id.nil?
|
219
|
+
command.query['fields'] = fields unless fields.nil?
|
220
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
221
|
+
execute_or_queue_command(command, &block)
|
222
|
+
end
|
223
|
+
|
224
|
+
# Creates an account event.
|
225
|
+
# @param [String] parent
|
226
|
+
# Required. Account to log events about. Format: platforms/`platform`/accounts/`
|
227
|
+
# account`
|
228
|
+
# @param [Google::Apis::AdsenseplatformV1::Event] event_object
|
229
|
+
# @param [String] fields
|
230
|
+
# Selector specifying which fields to include in a partial response.
|
231
|
+
# @param [String] quota_user
|
232
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
233
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
234
|
+
# @param [Google::Apis::RequestOptions] options
|
235
|
+
# Request-specific options
|
236
|
+
#
|
237
|
+
# @yield [result, err] Result & error if block supplied
|
238
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Event] parsed result object
|
239
|
+
# @yieldparam err [StandardError] error object if request failed
|
240
|
+
#
|
241
|
+
# @return [Google::Apis::AdsenseplatformV1::Event]
|
242
|
+
#
|
243
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
244
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
245
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
246
|
+
def create_platform_account_event(parent, event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
247
|
+
command = make_simple_command(:post, 'v1/{+parent}/events', options)
|
248
|
+
command.request_representation = Google::Apis::AdsenseplatformV1::Event::Representation
|
249
|
+
command.request_object = event_object
|
250
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Event::Representation
|
251
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Event
|
252
|
+
command.params['parent'] = parent unless parent.nil?
|
253
|
+
command.query['fields'] = fields unless fields.nil?
|
254
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
255
|
+
execute_or_queue_command(command, &block)
|
256
|
+
end
|
257
|
+
|
258
|
+
# Creates a site for a specified account.
|
259
|
+
# @param [String] parent
|
260
|
+
# Required. Account to create site. Format: platforms/`platform`/accounts/`
|
261
|
+
# account_id`
|
262
|
+
# @param [Google::Apis::AdsenseplatformV1::Site] site_object
|
263
|
+
# @param [String] fields
|
264
|
+
# Selector specifying which fields to include in a partial response.
|
265
|
+
# @param [String] quota_user
|
266
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
267
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
268
|
+
# @param [Google::Apis::RequestOptions] options
|
269
|
+
# Request-specific options
|
270
|
+
#
|
271
|
+
# @yield [result, err] Result & error if block supplied
|
272
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Site] parsed result object
|
273
|
+
# @yieldparam err [StandardError] error object if request failed
|
274
|
+
#
|
275
|
+
# @return [Google::Apis::AdsenseplatformV1::Site]
|
276
|
+
#
|
277
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
278
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
279
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
280
|
+
def create_platform_account_site(parent, site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
281
|
+
command = make_simple_command(:post, 'v1/{+parent}/sites', options)
|
282
|
+
command.request_representation = Google::Apis::AdsenseplatformV1::Site::Representation
|
283
|
+
command.request_object = site_object
|
284
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Site::Representation
|
285
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Site
|
286
|
+
command.params['parent'] = parent unless parent.nil?
|
287
|
+
command.query['fields'] = fields unless fields.nil?
|
288
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
289
|
+
execute_or_queue_command(command, &block)
|
290
|
+
end
|
291
|
+
|
292
|
+
# Deletes a site from a specified account.
|
293
|
+
# @param [String] name
|
294
|
+
# Required. The name of the site to delete. Format: platforms/`platform`/
|
295
|
+
# accounts/`account`/sites/`site`
|
296
|
+
# @param [String] fields
|
297
|
+
# Selector specifying which fields to include in a partial response.
|
298
|
+
# @param [String] quota_user
|
299
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
300
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
301
|
+
# @param [Google::Apis::RequestOptions] options
|
302
|
+
# Request-specific options
|
303
|
+
#
|
304
|
+
# @yield [result, err] Result & error if block supplied
|
305
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Empty] parsed result object
|
306
|
+
# @yieldparam err [StandardError] error object if request failed
|
307
|
+
#
|
308
|
+
# @return [Google::Apis::AdsenseplatformV1::Empty]
|
309
|
+
#
|
310
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
311
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
312
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
313
|
+
def delete_platform_account_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
314
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
315
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Empty::Representation
|
316
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Empty
|
317
|
+
command.params['name'] = name unless name.nil?
|
318
|
+
command.query['fields'] = fields unless fields.nil?
|
319
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
320
|
+
execute_or_queue_command(command, &block)
|
321
|
+
end
|
322
|
+
|
323
|
+
# Gets a site from a specified sub-account.
|
324
|
+
# @param [String] name
|
325
|
+
# Required. The name of the site to retrieve. Format: platforms/`platform`/
|
326
|
+
# accounts/`account`/sites/`site`
|
327
|
+
# @param [String] fields
|
328
|
+
# Selector specifying which fields to include in a partial response.
|
329
|
+
# @param [String] quota_user
|
330
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
331
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
332
|
+
# @param [Google::Apis::RequestOptions] options
|
333
|
+
# Request-specific options
|
334
|
+
#
|
335
|
+
# @yield [result, err] Result & error if block supplied
|
336
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::Site] parsed result object
|
337
|
+
# @yieldparam err [StandardError] error object if request failed
|
338
|
+
#
|
339
|
+
# @return [Google::Apis::AdsenseplatformV1::Site]
|
340
|
+
#
|
341
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
342
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
343
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
344
|
+
def get_platform_account_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
345
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
346
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::Site::Representation
|
347
|
+
command.response_class = Google::Apis::AdsenseplatformV1::Site
|
348
|
+
command.params['name'] = name unless name.nil?
|
349
|
+
command.query['fields'] = fields unless fields.nil?
|
350
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
351
|
+
execute_or_queue_command(command, &block)
|
352
|
+
end
|
353
|
+
|
354
|
+
# Lists sites for a specific account.
|
355
|
+
# @param [String] parent
|
356
|
+
# Required. The account which owns the sites. Format: platforms/`platform`/
|
357
|
+
# accounts/`account`
|
358
|
+
# @param [Fixnum] page_size
|
359
|
+
# The maximum number of sites to include in the response, used for paging. If
|
360
|
+
# unspecified, at most 10000 sites will be returned. The maximum value is 10000;
|
361
|
+
# values above 10000 will be coerced to 10000.
|
362
|
+
# @param [String] page_token
|
363
|
+
# A page token, received from a previous `ListSites` call. Provide this to
|
364
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
365
|
+
# to `ListSites` must match the call that provided the page token.
|
366
|
+
# @param [String] fields
|
367
|
+
# Selector specifying which fields to include in a partial response.
|
368
|
+
# @param [String] quota_user
|
369
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
370
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
371
|
+
# @param [Google::Apis::RequestOptions] options
|
372
|
+
# Request-specific options
|
373
|
+
#
|
374
|
+
# @yield [result, err] Result & error if block supplied
|
375
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::ListSitesResponse] parsed result object
|
376
|
+
# @yieldparam err [StandardError] error object if request failed
|
377
|
+
#
|
378
|
+
# @return [Google::Apis::AdsenseplatformV1::ListSitesResponse]
|
379
|
+
#
|
380
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
381
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
382
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
383
|
+
def list_platform_account_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
384
|
+
command = make_simple_command(:get, 'v1/{+parent}/sites', options)
|
385
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::ListSitesResponse::Representation
|
386
|
+
command.response_class = Google::Apis::AdsenseplatformV1::ListSitesResponse
|
387
|
+
command.params['parent'] = parent unless parent.nil?
|
388
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
389
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
390
|
+
command.query['fields'] = fields unless fields.nil?
|
391
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
392
|
+
execute_or_queue_command(command, &block)
|
393
|
+
end
|
394
|
+
|
395
|
+
# Requests the review of a site. The site should be in REQUIRES_REVIEW or
|
396
|
+
# NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://
|
397
|
+
# developers.google.com/adsense/platforms/direct/ad-tags) on your site before
|
398
|
+
# requesting a review.
|
399
|
+
# @param [String] name
|
400
|
+
# Required. The name of the site to submit for review. Format: platforms/`
|
401
|
+
# platform`/accounts/`account`/sites/`site`
|
402
|
+
# @param [String] fields
|
403
|
+
# Selector specifying which fields to include in a partial response.
|
404
|
+
# @param [String] quota_user
|
405
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
406
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
407
|
+
# @param [Google::Apis::RequestOptions] options
|
408
|
+
# Request-specific options
|
409
|
+
#
|
410
|
+
# @yield [result, err] Result & error if block supplied
|
411
|
+
# @yieldparam result [Google::Apis::AdsenseplatformV1::RequestSiteReviewResponse] parsed result object
|
412
|
+
# @yieldparam err [StandardError] error object if request failed
|
413
|
+
#
|
414
|
+
# @return [Google::Apis::AdsenseplatformV1::RequestSiteReviewResponse]
|
415
|
+
#
|
416
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
417
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
418
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
419
|
+
def request_platform_account_site_review(name, fields: nil, quota_user: nil, options: nil, &block)
|
420
|
+
command = make_simple_command(:post, 'v1/{+name}:requestReview', options)
|
421
|
+
command.response_representation = Google::Apis::AdsenseplatformV1::RequestSiteReviewResponse::Representation
|
422
|
+
command.response_class = Google::Apis::AdsenseplatformV1::RequestSiteReviewResponse
|
423
|
+
command.params['name'] = name unless name.nil?
|
424
|
+
command.query['fields'] = fields unless fields.nil?
|
425
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
426
|
+
execute_or_queue_command(command, &block)
|
427
|
+
end
|
428
|
+
|
429
|
+
protected
|
430
|
+
|
431
|
+
def apply_command_defaults(command)
|
432
|
+
command.query['key'] = key unless key.nil?
|
433
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
434
|
+
end
|
435
|
+
end
|
436
|
+
end
|
437
|
+
end
|
438
|
+
end
|
@@ -0,0 +1,39 @@
|
|
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/adsenseplatform_v1/service.rb'
|
16
|
+
require 'google/apis/adsenseplatform_v1/classes.rb'
|
17
|
+
require 'google/apis/adsenseplatform_v1/representations.rb'
|
18
|
+
require 'google/apis/adsenseplatform_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# AdSense Platform API
|
23
|
+
#
|
24
|
+
#
|
25
|
+
#
|
26
|
+
# @see https://developers.google.com/adsense/platforms/
|
27
|
+
module AdsenseplatformV1
|
28
|
+
# Version of the AdSense Platform API this client connects to.
|
29
|
+
# This is NOT the gem version.
|
30
|
+
VERSION = 'V1'
|
31
|
+
|
32
|
+
# View and manage your AdSense data
|
33
|
+
AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense'
|
34
|
+
|
35
|
+
# View your AdSense data
|
36
|
+
AUTH_ADSENSE_READONLY = 'https://www.googleapis.com/auth/adsense.readonly'
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,15 @@
|
|
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/adsenseplatform_v1"
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-apis-adsenseplatform_v1
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2024-07-25 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-apis-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.15.0
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 2.a
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 0.15.0
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 2.a
|
33
|
+
description: This is the simple REST client for AdSense Platform API V1. Simple REST
|
34
|
+
clients are Ruby client libraries that provide access to Google services via their
|
35
|
+
HTTP REST API endpoints. These libraries are generated and updated automatically
|
36
|
+
based on the discovery documents published by the service, and they handle most
|
37
|
+
concerns such as authentication, pagination, retry, timeouts, and logging. You can
|
38
|
+
use this client to access the AdSense Platform API, but note that some services
|
39
|
+
may provide a separate modern client that is easier to use.
|
40
|
+
email: googleapis-packages@google.com
|
41
|
+
executables: []
|
42
|
+
extensions: []
|
43
|
+
extra_rdoc_files: []
|
44
|
+
files:
|
45
|
+
- ".yardopts"
|
46
|
+
- CHANGELOG.md
|
47
|
+
- LICENSE.md
|
48
|
+
- OVERVIEW.md
|
49
|
+
- lib/google-apis-adsenseplatform_v1.rb
|
50
|
+
- lib/google/apis/adsenseplatform_v1.rb
|
51
|
+
- lib/google/apis/adsenseplatform_v1/classes.rb
|
52
|
+
- lib/google/apis/adsenseplatform_v1/gem_version.rb
|
53
|
+
- lib/google/apis/adsenseplatform_v1/representations.rb
|
54
|
+
- lib/google/apis/adsenseplatform_v1/service.rb
|
55
|
+
homepage: https://github.com/google/google-api-ruby-client
|
56
|
+
licenses:
|
57
|
+
- Apache-2.0
|
58
|
+
metadata:
|
59
|
+
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-adsenseplatform_v1/CHANGELOG.md
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-adsenseplatform_v1/v0.1.0
|
62
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-adsenseplatform_v1
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options: []
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: '2.7'
|
72
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
requirements: []
|
78
|
+
rubygems_version: 3.5.6
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: Simple REST client for AdSense Platform API V1
|
82
|
+
test_files: []
|