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.
@@ -0,0 +1,412 @@
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 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AdsenseplatformV1
24
+
25
+ # Representation of an Account.
26
+ class Account
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Output only. Creation time of the account.
30
+ # Corresponds to the JSON property `createTime`
31
+ # @return [String]
32
+ attr_accessor :create_time
33
+
34
+ # Required. An opaque token that uniquely identifies the account among all the
35
+ # platform's accounts. This string may contain at most 64 non-whitespace ASCII
36
+ # characters, but otherwise has no predefined structure. However, it is expected
37
+ # to be a platform-specific identifier for the user creating the account, so
38
+ # that only a single account can be created for any given user. This field must
39
+ # not contain any information that is recognizable as personally identifiable
40
+ # information. e.g. it should not be an email address or login name. Once an
41
+ # account has been created, a second attempt to create an account using the same
42
+ # creation_request_id will result in an ALREADY_EXISTS error.
43
+ # Corresponds to the JSON property `creationRequestId`
44
+ # @return [String]
45
+ attr_accessor :creation_request_id
46
+
47
+ # Display name of this account.
48
+ # Corresponds to the JSON property `displayName`
49
+ # @return [String]
50
+ attr_accessor :display_name
51
+
52
+ # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/
53
+ # accounts/pub-[0-9]+
54
+ # Corresponds to the JSON property `name`
55
+ # @return [String]
56
+ attr_accessor :name
57
+
58
+ # Required. Input only. CLDR region code of the country/region of the address.
59
+ # Set this to country code of the child account if known, otherwise to your own
60
+ # country code.
61
+ # Corresponds to the JSON property `regionCode`
62
+ # @return [String]
63
+ attr_accessor :region_code
64
+
65
+ # Output only. Approval state of the account.
66
+ # Corresponds to the JSON property `state`
67
+ # @return [String]
68
+ attr_accessor :state
69
+
70
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
71
+ # time-zones).
72
+ # Corresponds to the JSON property `timeZone`
73
+ # @return [Google::Apis::AdsenseplatformV1::TimeZone]
74
+ attr_accessor :time_zone
75
+
76
+ def initialize(**args)
77
+ update!(**args)
78
+ end
79
+
80
+ # Update properties of this object
81
+ def update!(**args)
82
+ @create_time = args[:create_time] if args.key?(:create_time)
83
+ @creation_request_id = args[:creation_request_id] if args.key?(:creation_request_id)
84
+ @display_name = args[:display_name] if args.key?(:display_name)
85
+ @name = args[:name] if args.key?(:name)
86
+ @region_code = args[:region_code] if args.key?(:region_code)
87
+ @state = args[:state] if args.key?(:state)
88
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
89
+ end
90
+ end
91
+
92
+ # Address data.
93
+ class Address
94
+ include Google::Apis::Core::Hashable
95
+
96
+ # First line of address. Max length 64 bytes or 30 characters.
97
+ # Corresponds to the JSON property `address1`
98
+ # @return [String]
99
+ attr_accessor :address1
100
+
101
+ # Second line of address. Max length 64 bytes or 30 characters.
102
+ # Corresponds to the JSON property `address2`
103
+ # @return [String]
104
+ attr_accessor :address2
105
+
106
+ # City. Max length 60 bytes or 30 characters.
107
+ # Corresponds to the JSON property `city`
108
+ # @return [String]
109
+ attr_accessor :city
110
+
111
+ # Name of the company. Max length 255 bytes or 34 characters.
112
+ # Corresponds to the JSON property `company`
113
+ # @return [String]
114
+ attr_accessor :company
115
+
116
+ # Contact name of the company. Max length 128 bytes or 34 characters.
117
+ # Corresponds to the JSON property `contact`
118
+ # @return [String]
119
+ attr_accessor :contact
120
+
121
+ # Fax number with international code (i.e. +441234567890).
122
+ # Corresponds to the JSON property `fax`
123
+ # @return [String]
124
+ attr_accessor :fax
125
+
126
+ # Phone number with international code (i.e. +441234567890).
127
+ # Corresponds to the JSON property `phone`
128
+ # @return [String]
129
+ attr_accessor :phone
130
+
131
+ # Country/Region code. The region is specified as a CLDR region code (e.g. "US",
132
+ # "FR").
133
+ # Corresponds to the JSON property `regionCode`
134
+ # @return [String]
135
+ attr_accessor :region_code
136
+
137
+ # State. Max length 60 bytes or 30 characters.
138
+ # Corresponds to the JSON property `state`
139
+ # @return [String]
140
+ attr_accessor :state
141
+
142
+ # Zip/post code. Max length 10 bytes or 10 characters.
143
+ # Corresponds to the JSON property `zip`
144
+ # @return [String]
145
+ attr_accessor :zip
146
+
147
+ def initialize(**args)
148
+ update!(**args)
149
+ end
150
+
151
+ # Update properties of this object
152
+ def update!(**args)
153
+ @address1 = args[:address1] if args.key?(:address1)
154
+ @address2 = args[:address2] if args.key?(:address2)
155
+ @city = args[:city] if args.key?(:city)
156
+ @company = args[:company] if args.key?(:company)
157
+ @contact = args[:contact] if args.key?(:contact)
158
+ @fax = args[:fax] if args.key?(:fax)
159
+ @phone = args[:phone] if args.key?(:phone)
160
+ @region_code = args[:region_code] if args.key?(:region_code)
161
+ @state = args[:state] if args.key?(:state)
162
+ @zip = args[:zip] if args.key?(:zip)
163
+ end
164
+ end
165
+
166
+ # Request definition for the account close rpc.
167
+ class CloseAccountRequest
168
+ include Google::Apis::Core::Hashable
169
+
170
+ def initialize(**args)
171
+ update!(**args)
172
+ end
173
+
174
+ # Update properties of this object
175
+ def update!(**args)
176
+ end
177
+ end
178
+
179
+ # Response definition for the account close rpc.
180
+ class CloseAccountResponse
181
+ include Google::Apis::Core::Hashable
182
+
183
+ def initialize(**args)
184
+ update!(**args)
185
+ end
186
+
187
+ # Update properties of this object
188
+ def update!(**args)
189
+ end
190
+ end
191
+
192
+ # A generic empty message that you can re-use to avoid defining duplicated empty
193
+ # messages in your APIs. A typical example is to use it as the request or the
194
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
195
+ # protobuf.Empty) returns (google.protobuf.Empty); `
196
+ class Empty
197
+ include Google::Apis::Core::Hashable
198
+
199
+ def initialize(**args)
200
+ update!(**args)
201
+ end
202
+
203
+ # Update properties of this object
204
+ def update!(**args)
205
+ end
206
+ end
207
+
208
+ # A platform sub-account event to record spam signals.
209
+ class Event
210
+ include Google::Apis::Core::Hashable
211
+
212
+ # Private information for partner recorded events (PII).
213
+ # Corresponds to the JSON property `eventInfo`
214
+ # @return [Google::Apis::AdsenseplatformV1::EventInfo]
215
+ attr_accessor :event_info
216
+
217
+ # Required. Event timestamp.
218
+ # Corresponds to the JSON property `eventTime`
219
+ # @return [String]
220
+ attr_accessor :event_time
221
+
222
+ # Required. Event type.
223
+ # Corresponds to the JSON property `eventType`
224
+ # @return [String]
225
+ attr_accessor :event_type
226
+
227
+ def initialize(**args)
228
+ update!(**args)
229
+ end
230
+
231
+ # Update properties of this object
232
+ def update!(**args)
233
+ @event_info = args[:event_info] if args.key?(:event_info)
234
+ @event_time = args[:event_time] if args.key?(:event_time)
235
+ @event_type = args[:event_type] if args.key?(:event_type)
236
+ end
237
+ end
238
+
239
+ # Private information for partner recorded events (PII).
240
+ class EventInfo
241
+ include Google::Apis::Core::Hashable
242
+
243
+ # Address data.
244
+ # Corresponds to the JSON property `billingAddress`
245
+ # @return [Google::Apis::AdsenseplatformV1::Address]
246
+ attr_accessor :billing_address
247
+
248
+ # Required. The email address that is associated with the publisher when
249
+ # performing the event.
250
+ # Corresponds to the JSON property `email`
251
+ # @return [String]
252
+ attr_accessor :email
253
+
254
+ def initialize(**args)
255
+ update!(**args)
256
+ end
257
+
258
+ # Update properties of this object
259
+ def update!(**args)
260
+ @billing_address = args[:billing_address] if args.key?(:billing_address)
261
+ @email = args[:email] if args.key?(:email)
262
+ end
263
+ end
264
+
265
+ # Response definition for the list accounts rpc.
266
+ class ListAccountsResponse
267
+ include Google::Apis::Core::Hashable
268
+
269
+ # The Accounts returned in the list response. Represented by a partial view of
270
+ # the Account resource, populating `name` and `creation_request_id`.
271
+ # Corresponds to the JSON property `accounts`
272
+ # @return [Array<Google::Apis::AdsenseplatformV1::Account>]
273
+ attr_accessor :accounts
274
+
275
+ # Continuation token used to page through accounts. To retrieve the next page of
276
+ # the results, set the next request's "page_token" value to this.
277
+ # Corresponds to the JSON property `nextPageToken`
278
+ # @return [String]
279
+ attr_accessor :next_page_token
280
+
281
+ def initialize(**args)
282
+ update!(**args)
283
+ end
284
+
285
+ # Update properties of this object
286
+ def update!(**args)
287
+ @accounts = args[:accounts] if args.key?(:accounts)
288
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
289
+ end
290
+ end
291
+
292
+ # Response definition for the site list rpc.
293
+ class ListSitesResponse
294
+ include Google::Apis::Core::Hashable
295
+
296
+ # Continuation token used to page through sites. To retrieve the next page of
297
+ # the results, set the next request's "page_token" value to this.
298
+ # Corresponds to the JSON property `nextPageToken`
299
+ # @return [String]
300
+ attr_accessor :next_page_token
301
+
302
+ # The sites returned in this list response.
303
+ # Corresponds to the JSON property `sites`
304
+ # @return [Array<Google::Apis::AdsenseplatformV1::Site>]
305
+ attr_accessor :sites
306
+
307
+ def initialize(**args)
308
+ update!(**args)
309
+ end
310
+
311
+ # Update properties of this object
312
+ def update!(**args)
313
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
314
+ @sites = args[:sites] if args.key?(:sites)
315
+ end
316
+ end
317
+
318
+ # Response definition for the lookup account rpc.
319
+ class LookupAccountResponse
320
+ include Google::Apis::Core::Hashable
321
+
322
+ # The name of the Account Format: platforms/`platform`/accounts/`account_id`
323
+ # Corresponds to the JSON property `name`
324
+ # @return [String]
325
+ attr_accessor :name
326
+
327
+ def initialize(**args)
328
+ update!(**args)
329
+ end
330
+
331
+ # Update properties of this object
332
+ def update!(**args)
333
+ @name = args[:name] if args.key?(:name)
334
+ end
335
+ end
336
+
337
+ # Response definition for the site request review rpc.
338
+ class RequestSiteReviewResponse
339
+ include Google::Apis::Core::Hashable
340
+
341
+ def initialize(**args)
342
+ update!(**args)
343
+ end
344
+
345
+ # Update properties of this object
346
+ def update!(**args)
347
+ end
348
+ end
349
+
350
+ # Representation of a Site.
351
+ class Site
352
+ include Google::Apis::Core::Hashable
353
+
354
+ # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035]
355
+ # (https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](
356
+ # https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode
357
+ # characters.
358
+ # Corresponds to the JSON property `domain`
359
+ # @return [String]
360
+ attr_accessor :domain
361
+
362
+ # Output only. Resource name of a site. Format: platforms/`platform`/accounts/`
363
+ # account`/sites/`site`
364
+ # Corresponds to the JSON property `name`
365
+ # @return [String]
366
+ attr_accessor :name
367
+
368
+ # Output only. State of a site.
369
+ # Corresponds to the JSON property `state`
370
+ # @return [String]
371
+ attr_accessor :state
372
+
373
+ def initialize(**args)
374
+ update!(**args)
375
+ end
376
+
377
+ # Update properties of this object
378
+ def update!(**args)
379
+ @domain = args[:domain] if args.key?(:domain)
380
+ @name = args[:name] if args.key?(:name)
381
+ @state = args[:state] if args.key?(:state)
382
+ end
383
+ end
384
+
385
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
386
+ # time-zones).
387
+ class TimeZone
388
+ include Google::Apis::Core::Hashable
389
+
390
+ # IANA Time Zone Database time zone, e.g. "America/New_York".
391
+ # Corresponds to the JSON property `id`
392
+ # @return [String]
393
+ attr_accessor :id
394
+
395
+ # Optional. IANA Time Zone Database version number, e.g. "2019a".
396
+ # Corresponds to the JSON property `version`
397
+ # @return [String]
398
+ attr_accessor :version
399
+
400
+ def initialize(**args)
401
+ update!(**args)
402
+ end
403
+
404
+ # Update properties of this object
405
+ def update!(**args)
406
+ @id = args[:id] if args.key?(:id)
407
+ @version = args[:version] if args.key?(:version)
408
+ end
409
+ end
410
+ end
411
+ end
412
+ end
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module AdsenseplatformV1
18
+ # Version of the google-apis-adsenseplatform_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.15.0"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20240722"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,219 @@
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 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AdsenseplatformV1
24
+
25
+ class Account
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class Address
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class CloseAccountRequest
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class CloseAccountResponse
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class Empty
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class Event
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class EventInfo
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class ListAccountsResponse
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class ListSitesResponse
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class LookupAccountResponse
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class RequestSiteReviewResponse
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class Site
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class TimeZone
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class Account
104
+ # @private
105
+ class Representation < Google::Apis::Core::JsonRepresentation
106
+ property :create_time, as: 'createTime'
107
+ property :creation_request_id, as: 'creationRequestId'
108
+ property :display_name, as: 'displayName'
109
+ property :name, as: 'name'
110
+ property :region_code, as: 'regionCode'
111
+ property :state, as: 'state'
112
+ property :time_zone, as: 'timeZone', class: Google::Apis::AdsenseplatformV1::TimeZone, decorator: Google::Apis::AdsenseplatformV1::TimeZone::Representation
113
+
114
+ end
115
+ end
116
+
117
+ class Address
118
+ # @private
119
+ class Representation < Google::Apis::Core::JsonRepresentation
120
+ property :address1, as: 'address1'
121
+ property :address2, as: 'address2'
122
+ property :city, as: 'city'
123
+ property :company, as: 'company'
124
+ property :contact, as: 'contact'
125
+ property :fax, as: 'fax'
126
+ property :phone, as: 'phone'
127
+ property :region_code, as: 'regionCode'
128
+ property :state, as: 'state'
129
+ property :zip, as: 'zip'
130
+ end
131
+ end
132
+
133
+ class CloseAccountRequest
134
+ # @private
135
+ class Representation < Google::Apis::Core::JsonRepresentation
136
+ end
137
+ end
138
+
139
+ class CloseAccountResponse
140
+ # @private
141
+ class Representation < Google::Apis::Core::JsonRepresentation
142
+ end
143
+ end
144
+
145
+ class Empty
146
+ # @private
147
+ class Representation < Google::Apis::Core::JsonRepresentation
148
+ end
149
+ end
150
+
151
+ class Event
152
+ # @private
153
+ class Representation < Google::Apis::Core::JsonRepresentation
154
+ property :event_info, as: 'eventInfo', class: Google::Apis::AdsenseplatformV1::EventInfo, decorator: Google::Apis::AdsenseplatformV1::EventInfo::Representation
155
+
156
+ property :event_time, as: 'eventTime'
157
+ property :event_type, as: 'eventType'
158
+ end
159
+ end
160
+
161
+ class EventInfo
162
+ # @private
163
+ class Representation < Google::Apis::Core::JsonRepresentation
164
+ property :billing_address, as: 'billingAddress', class: Google::Apis::AdsenseplatformV1::Address, decorator: Google::Apis::AdsenseplatformV1::Address::Representation
165
+
166
+ property :email, as: 'email'
167
+ end
168
+ end
169
+
170
+ class ListAccountsResponse
171
+ # @private
172
+ class Representation < Google::Apis::Core::JsonRepresentation
173
+ collection :accounts, as: 'accounts', class: Google::Apis::AdsenseplatformV1::Account, decorator: Google::Apis::AdsenseplatformV1::Account::Representation
174
+
175
+ property :next_page_token, as: 'nextPageToken'
176
+ end
177
+ end
178
+
179
+ class ListSitesResponse
180
+ # @private
181
+ class Representation < Google::Apis::Core::JsonRepresentation
182
+ property :next_page_token, as: 'nextPageToken'
183
+ collection :sites, as: 'sites', class: Google::Apis::AdsenseplatformV1::Site, decorator: Google::Apis::AdsenseplatformV1::Site::Representation
184
+
185
+ end
186
+ end
187
+
188
+ class LookupAccountResponse
189
+ # @private
190
+ class Representation < Google::Apis::Core::JsonRepresentation
191
+ property :name, as: 'name'
192
+ end
193
+ end
194
+
195
+ class RequestSiteReviewResponse
196
+ # @private
197
+ class Representation < Google::Apis::Core::JsonRepresentation
198
+ end
199
+ end
200
+
201
+ class Site
202
+ # @private
203
+ class Representation < Google::Apis::Core::JsonRepresentation
204
+ property :domain, as: 'domain'
205
+ property :name, as: 'name'
206
+ property :state, as: 'state'
207
+ end
208
+ end
209
+
210
+ class TimeZone
211
+ # @private
212
+ class Representation < Google::Apis::Core::JsonRepresentation
213
+ property :id, as: 'id'
214
+ property :version, as: 'version'
215
+ end
216
+ end
217
+ end
218
+ end
219
+ end