google-apis-marketingplatformadmin_v1alpha 0.6.0 → 0.7.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/marketingplatformadmin_v1alpha/classes.rb +327 -0
- data/lib/google/apis/marketingplatformadmin_v1alpha/gem_version.rb +3 -3
- data/lib/google/apis/marketingplatformadmin_v1alpha/representations.rb +158 -0
- data/lib/google/apis/marketingplatformadmin_v1alpha/service.rb +115 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6a6f89bbbb932fc3d414ec6ff402d0d37760937b2d6d2cef542a9bfc4c5c21fe
|
|
4
|
+
data.tar.gz: e3309fa545f0ee08881f9d305ee39430a0d0212fe65439734ff6a9cd042fa78b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: de0df1849f4a39adf7cc62b674511459021b9f2a051ebe97f796e6b5e54f3995e854b1ce42611ce4a7b69753d37df153a675d9e803b7ffd4118336665fb6704e
|
|
7
|
+
data.tar.gz: 20c9e5b1db721d74a3100c8002584472cd124aed5c9b6ef284ba0c47e9f9c153eca6f549f4bec3cc622d975c3d74bdcc9e0e5ae99a26c22c3973bb125a72e8c9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# Release history for google-apis-marketingplatformadmin_v1alpha
|
|
2
2
|
|
|
3
|
+
### v0.7.0 (2025-11-02)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20251029
|
|
6
|
+
* Regenerated using generator version 0.18.0
|
|
7
|
+
|
|
3
8
|
### v0.6.0 (2025-05-04)
|
|
4
9
|
|
|
5
10
|
* Regenerated using generator version 0.17.0
|
|
@@ -67,6 +67,129 @@ module Google
|
|
|
67
67
|
end
|
|
68
68
|
end
|
|
69
69
|
|
|
70
|
+
# Contains the bill amount.
|
|
71
|
+
class BillInfo
|
|
72
|
+
include Google::Apis::Core::Hashable
|
|
73
|
+
|
|
74
|
+
# Represents an amount of money with its currency type.
|
|
75
|
+
# Corresponds to the JSON property `baseFee`
|
|
76
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Money]
|
|
77
|
+
attr_accessor :base_fee
|
|
78
|
+
|
|
79
|
+
# Represents an amount of money with its currency type.
|
|
80
|
+
# Corresponds to the JSON property `eventFee`
|
|
81
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Money]
|
|
82
|
+
attr_accessor :event_fee
|
|
83
|
+
|
|
84
|
+
# Represents an amount of money with its currency type.
|
|
85
|
+
# Corresponds to the JSON property `priceProtectionCredit`
|
|
86
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Money]
|
|
87
|
+
attr_accessor :price_protection_credit
|
|
88
|
+
|
|
89
|
+
# Represents an amount of money with its currency type.
|
|
90
|
+
# Corresponds to the JSON property `total`
|
|
91
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Money]
|
|
92
|
+
attr_accessor :total
|
|
93
|
+
|
|
94
|
+
def initialize(**args)
|
|
95
|
+
update!(**args)
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Update properties of this object
|
|
99
|
+
def update!(**args)
|
|
100
|
+
@base_fee = args[:base_fee] if args.key?(:base_fee)
|
|
101
|
+
@event_fee = args[:event_fee] if args.key?(:event_fee)
|
|
102
|
+
@price_protection_credit = args[:price_protection_credit] if args.key?(:price_protection_credit)
|
|
103
|
+
@total = args[:total] if args.key?(:total)
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Contains the client data.
|
|
108
|
+
class ClientData
|
|
109
|
+
include Google::Apis::Core::Hashable
|
|
110
|
+
|
|
111
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
|
112
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
|
113
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
|
114
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
|
115
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
|
116
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
|
117
|
+
# example, a credit card expiration date). Related types: * google.type.
|
|
118
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
|
119
|
+
# Corresponds to the JSON property `endDate`
|
|
120
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Date]
|
|
121
|
+
attr_accessor :end_date
|
|
122
|
+
|
|
123
|
+
# A resource message representing a Google Marketing Platform organization.
|
|
124
|
+
# Corresponds to the JSON property `organization`
|
|
125
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Organization]
|
|
126
|
+
attr_accessor :organization
|
|
127
|
+
|
|
128
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
|
129
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
|
130
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
|
131
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
|
132
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
|
133
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
|
134
|
+
# example, a credit card expiration date). Related types: * google.type.
|
|
135
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
|
136
|
+
# Corresponds to the JSON property `startDate`
|
|
137
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::Date]
|
|
138
|
+
attr_accessor :start_date
|
|
139
|
+
|
|
140
|
+
def initialize(**args)
|
|
141
|
+
update!(**args)
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Update properties of this object
|
|
145
|
+
def update!(**args)
|
|
146
|
+
@end_date = args[:end_date] if args.key?(:end_date)
|
|
147
|
+
@organization = args[:organization] if args.key?(:organization)
|
|
148
|
+
@start_date = args[:start_date] if args.key?(:start_date)
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
|
153
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
|
154
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
|
155
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
|
156
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
|
157
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
|
158
|
+
# example, a credit card expiration date). Related types: * google.type.
|
|
159
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
|
160
|
+
class Date
|
|
161
|
+
include Google::Apis::Core::Hashable
|
|
162
|
+
|
|
163
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
|
164
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
|
165
|
+
# Corresponds to the JSON property `day`
|
|
166
|
+
# @return [Fixnum]
|
|
167
|
+
attr_accessor :day
|
|
168
|
+
|
|
169
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
|
170
|
+
# and day.
|
|
171
|
+
# Corresponds to the JSON property `month`
|
|
172
|
+
# @return [Fixnum]
|
|
173
|
+
attr_accessor :month
|
|
174
|
+
|
|
175
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
|
176
|
+
# year.
|
|
177
|
+
# Corresponds to the JSON property `year`
|
|
178
|
+
# @return [Fixnum]
|
|
179
|
+
attr_accessor :year
|
|
180
|
+
|
|
181
|
+
def initialize(**args)
|
|
182
|
+
update!(**args)
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# Update properties of this object
|
|
186
|
+
def update!(**args)
|
|
187
|
+
@day = args[:day] if args.key?(:day)
|
|
188
|
+
@month = args[:month] if args.key?(:month)
|
|
189
|
+
@year = args[:year] if args.key?(:year)
|
|
190
|
+
end
|
|
191
|
+
end
|
|
192
|
+
|
|
70
193
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
|
71
194
|
# messages in your APIs. A typical example is to use it as the request or the
|
|
72
195
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
|
@@ -83,6 +206,45 @@ module Google
|
|
|
83
206
|
end
|
|
84
207
|
end
|
|
85
208
|
|
|
209
|
+
# Request message for FindSalesPartnerManagedClients RPC.
|
|
210
|
+
class FindSalesPartnerManagedClientsRequest
|
|
211
|
+
include Google::Apis::Core::Hashable
|
|
212
|
+
|
|
213
|
+
# Optional. If set, only active and just ended clients will be returned.
|
|
214
|
+
# Corresponds to the JSON property `isActive`
|
|
215
|
+
# @return [Boolean]
|
|
216
|
+
attr_accessor :is_active
|
|
217
|
+
alias_method :is_active?, :is_active
|
|
218
|
+
|
|
219
|
+
def initialize(**args)
|
|
220
|
+
update!(**args)
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
# Update properties of this object
|
|
224
|
+
def update!(**args)
|
|
225
|
+
@is_active = args[:is_active] if args.key?(:is_active)
|
|
226
|
+
end
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
# Response message for FindSalesPartnerManagedClients RPC.
|
|
230
|
+
class FindSalesPartnerManagedClientsResponse
|
|
231
|
+
include Google::Apis::Core::Hashable
|
|
232
|
+
|
|
233
|
+
# The clients managed by the sales org.
|
|
234
|
+
# Corresponds to the JSON property `clientData`
|
|
235
|
+
# @return [Array<Google::Apis::MarketingplatformadminV1alpha::ClientData>]
|
|
236
|
+
attr_accessor :client_data
|
|
237
|
+
|
|
238
|
+
def initialize(**args)
|
|
239
|
+
update!(**args)
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Update properties of this object
|
|
243
|
+
def update!(**args)
|
|
244
|
+
@client_data = args[:client_data] if args.key?(:client_data)
|
|
245
|
+
end
|
|
246
|
+
end
|
|
247
|
+
|
|
86
248
|
# Response message for ListAnalyticsAccountLinks RPC.
|
|
87
249
|
class ListAnalyticsAccountLinksResponse
|
|
88
250
|
include Google::Apis::Core::Hashable
|
|
@@ -109,6 +271,69 @@ module Google
|
|
|
109
271
|
end
|
|
110
272
|
end
|
|
111
273
|
|
|
274
|
+
# Response message for ListOrganizations RPC.
|
|
275
|
+
class ListOrganizationsResponse
|
|
276
|
+
include Google::Apis::Core::Hashable
|
|
277
|
+
|
|
278
|
+
# A token, which can be sent as `page_token` to retrieve the next page. If this
|
|
279
|
+
# field is omitted, there are no subsequent pages.
|
|
280
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
281
|
+
# @return [String]
|
|
282
|
+
attr_accessor :next_page_token
|
|
283
|
+
|
|
284
|
+
# The Organization resource that the user has access to, which includes the org
|
|
285
|
+
# id and display name.
|
|
286
|
+
# Corresponds to the JSON property `organizations`
|
|
287
|
+
# @return [Array<Google::Apis::MarketingplatformadminV1alpha::Organization>]
|
|
288
|
+
attr_accessor :organizations
|
|
289
|
+
|
|
290
|
+
def initialize(**args)
|
|
291
|
+
update!(**args)
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Update properties of this object
|
|
295
|
+
def update!(**args)
|
|
296
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
297
|
+
@organizations = args[:organizations] if args.key?(:organizations)
|
|
298
|
+
end
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# Represents an amount of money with its currency type.
|
|
302
|
+
class Money
|
|
303
|
+
include Google::Apis::Core::Hashable
|
|
304
|
+
|
|
305
|
+
# The three-letter currency code defined in ISO 4217.
|
|
306
|
+
# Corresponds to the JSON property `currencyCode`
|
|
307
|
+
# @return [String]
|
|
308
|
+
attr_accessor :currency_code
|
|
309
|
+
|
|
310
|
+
# Number of nano (10^-9) units of the amount. The value must be between -999,999,
|
|
311
|
+
# 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be
|
|
312
|
+
# positive or zero. If `units` is zero, `nanos` can be positive, zero, or
|
|
313
|
+
# negative. If `units` is negative, `nanos` must be negative or zero. For
|
|
314
|
+
# example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
|
|
315
|
+
# Corresponds to the JSON property `nanos`
|
|
316
|
+
# @return [Fixnum]
|
|
317
|
+
attr_accessor :nanos
|
|
318
|
+
|
|
319
|
+
# The whole units of the amount. For example if `currencyCode` is `"USD"`, then
|
|
320
|
+
# 1 unit is one US dollar.
|
|
321
|
+
# Corresponds to the JSON property `units`
|
|
322
|
+
# @return [Fixnum]
|
|
323
|
+
attr_accessor :units
|
|
324
|
+
|
|
325
|
+
def initialize(**args)
|
|
326
|
+
update!(**args)
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
# Update properties of this object
|
|
330
|
+
def update!(**args)
|
|
331
|
+
@currency_code = args[:currency_code] if args.key?(:currency_code)
|
|
332
|
+
@nanos = args[:nanos] if args.key?(:nanos)
|
|
333
|
+
@units = args[:units] if args.key?(:units)
|
|
334
|
+
end
|
|
335
|
+
end
|
|
336
|
+
|
|
112
337
|
# A resource message representing a Google Marketing Platform organization.
|
|
113
338
|
class Organization
|
|
114
339
|
include Google::Apis::Core::Hashable
|
|
@@ -135,6 +360,108 @@ module Google
|
|
|
135
360
|
end
|
|
136
361
|
end
|
|
137
362
|
|
|
363
|
+
# Contains the count of events received by the property, along with metadata
|
|
364
|
+
# that influences the volume of `billable` events.
|
|
365
|
+
class PropertyUsage
|
|
366
|
+
include Google::Apis::Core::Hashable
|
|
367
|
+
|
|
368
|
+
# The ID of the property's parent account.
|
|
369
|
+
# Corresponds to the JSON property `accountId`
|
|
370
|
+
# @return [Fixnum]
|
|
371
|
+
attr_accessor :account_id
|
|
372
|
+
|
|
373
|
+
# The number of events for which the property is billed in the requested month.
|
|
374
|
+
# Corresponds to the JSON property `billableEventCount`
|
|
375
|
+
# @return [Fixnum]
|
|
376
|
+
attr_accessor :billable_event_count
|
|
377
|
+
|
|
378
|
+
# The display name of the property.
|
|
379
|
+
# Corresponds to the JSON property `displayName`
|
|
380
|
+
# @return [String]
|
|
381
|
+
attr_accessor :display_name
|
|
382
|
+
|
|
383
|
+
# The name of the Google Analytics Admin API property resource. Format:
|
|
384
|
+
# analyticsadmin.googleapis.com/properties/`property_id`
|
|
385
|
+
# Corresponds to the JSON property `property`
|
|
386
|
+
# @return [String]
|
|
387
|
+
attr_accessor :property
|
|
388
|
+
|
|
389
|
+
# The subtype of the analytics property. This affects the billable event count.
|
|
390
|
+
# Corresponds to the JSON property `propertyType`
|
|
391
|
+
# @return [String]
|
|
392
|
+
attr_accessor :property_type
|
|
393
|
+
|
|
394
|
+
# The service level of the property.
|
|
395
|
+
# Corresponds to the JSON property `serviceLevel`
|
|
396
|
+
# @return [String]
|
|
397
|
+
attr_accessor :service_level
|
|
398
|
+
|
|
399
|
+
# Total event count that the property received during the requested month.
|
|
400
|
+
# Corresponds to the JSON property `totalEventCount`
|
|
401
|
+
# @return [Fixnum]
|
|
402
|
+
attr_accessor :total_event_count
|
|
403
|
+
|
|
404
|
+
def initialize(**args)
|
|
405
|
+
update!(**args)
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
# Update properties of this object
|
|
409
|
+
def update!(**args)
|
|
410
|
+
@account_id = args[:account_id] if args.key?(:account_id)
|
|
411
|
+
@billable_event_count = args[:billable_event_count] if args.key?(:billable_event_count)
|
|
412
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
413
|
+
@property = args[:property] if args.key?(:property)
|
|
414
|
+
@property_type = args[:property_type] if args.key?(:property_type)
|
|
415
|
+
@service_level = args[:service_level] if args.key?(:service_level)
|
|
416
|
+
@total_event_count = args[:total_event_count] if args.key?(:total_event_count)
|
|
417
|
+
end
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
# Request message for ReportPropertyUsage RPC.
|
|
421
|
+
class ReportPropertyUsageRequest
|
|
422
|
+
include Google::Apis::Core::Hashable
|
|
423
|
+
|
|
424
|
+
# Required. The target month to list property usages. Format: YYYY-MM. For
|
|
425
|
+
# example, "2025-05"
|
|
426
|
+
# Corresponds to the JSON property `month`
|
|
427
|
+
# @return [String]
|
|
428
|
+
attr_accessor :month
|
|
429
|
+
|
|
430
|
+
def initialize(**args)
|
|
431
|
+
update!(**args)
|
|
432
|
+
end
|
|
433
|
+
|
|
434
|
+
# Update properties of this object
|
|
435
|
+
def update!(**args)
|
|
436
|
+
@month = args[:month] if args.key?(:month)
|
|
437
|
+
end
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
# Response message for ReportPropertyUsage RPC.
|
|
441
|
+
class ReportPropertyUsageResponse
|
|
442
|
+
include Google::Apis::Core::Hashable
|
|
443
|
+
|
|
444
|
+
# Contains the bill amount.
|
|
445
|
+
# Corresponds to the JSON property `billInfo`
|
|
446
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::BillInfo]
|
|
447
|
+
attr_accessor :bill_info
|
|
448
|
+
|
|
449
|
+
# Usage data for all properties in the specified organization and month.
|
|
450
|
+
# Corresponds to the JSON property `propertyUsages`
|
|
451
|
+
# @return [Array<Google::Apis::MarketingplatformadminV1alpha::PropertyUsage>]
|
|
452
|
+
attr_accessor :property_usages
|
|
453
|
+
|
|
454
|
+
def initialize(**args)
|
|
455
|
+
update!(**args)
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
# Update properties of this object
|
|
459
|
+
def update!(**args)
|
|
460
|
+
@bill_info = args[:bill_info] if args.key?(:bill_info)
|
|
461
|
+
@property_usages = args[:property_usages] if args.key?(:property_usages)
|
|
462
|
+
end
|
|
463
|
+
end
|
|
464
|
+
|
|
138
465
|
# Request message for SetPropertyServiceLevel RPC.
|
|
139
466
|
class SetPropertyServiceLevelRequest
|
|
140
467
|
include Google::Apis::Core::Hashable
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module MarketingplatformadminV1alpha
|
|
18
18
|
# Version of the google-apis-marketingplatformadmin_v1alpha gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.7.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
|
-
GENERATOR_VERSION = "0.
|
|
22
|
+
GENERATOR_VERSION = "0.18.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20251029"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -28,24 +28,84 @@ module Google
|
|
|
28
28
|
include Google::Apis::Core::JsonObjectSupport
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
+
class BillInfo
|
|
32
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
33
|
+
|
|
34
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
class ClientData
|
|
38
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
39
|
+
|
|
40
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
class Date
|
|
44
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
45
|
+
|
|
46
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
47
|
+
end
|
|
48
|
+
|
|
31
49
|
class Empty
|
|
32
50
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
33
51
|
|
|
34
52
|
include Google::Apis::Core::JsonObjectSupport
|
|
35
53
|
end
|
|
36
54
|
|
|
55
|
+
class FindSalesPartnerManagedClientsRequest
|
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
57
|
+
|
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
class FindSalesPartnerManagedClientsResponse
|
|
62
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
63
|
+
|
|
64
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
65
|
+
end
|
|
66
|
+
|
|
37
67
|
class ListAnalyticsAccountLinksResponse
|
|
38
68
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
39
69
|
|
|
40
70
|
include Google::Apis::Core::JsonObjectSupport
|
|
41
71
|
end
|
|
42
72
|
|
|
73
|
+
class ListOrganizationsResponse
|
|
74
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
75
|
+
|
|
76
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
class Money
|
|
80
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
81
|
+
|
|
82
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
83
|
+
end
|
|
84
|
+
|
|
43
85
|
class Organization
|
|
44
86
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
45
87
|
|
|
46
88
|
include Google::Apis::Core::JsonObjectSupport
|
|
47
89
|
end
|
|
48
90
|
|
|
91
|
+
class PropertyUsage
|
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
93
|
+
|
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
class ReportPropertyUsageRequest
|
|
98
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
99
|
+
|
|
100
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
class ReportPropertyUsageResponse
|
|
104
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
105
|
+
|
|
106
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
107
|
+
end
|
|
108
|
+
|
|
49
109
|
class SetPropertyServiceLevelRequest
|
|
50
110
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
51
111
|
|
|
@@ -68,12 +128,62 @@ module Google
|
|
|
68
128
|
end
|
|
69
129
|
end
|
|
70
130
|
|
|
131
|
+
class BillInfo
|
|
132
|
+
# @private
|
|
133
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
134
|
+
property :base_fee, as: 'baseFee', class: Google::Apis::MarketingplatformadminV1alpha::Money, decorator: Google::Apis::MarketingplatformadminV1alpha::Money::Representation
|
|
135
|
+
|
|
136
|
+
property :event_fee, as: 'eventFee', class: Google::Apis::MarketingplatformadminV1alpha::Money, decorator: Google::Apis::MarketingplatformadminV1alpha::Money::Representation
|
|
137
|
+
|
|
138
|
+
property :price_protection_credit, as: 'priceProtectionCredit', class: Google::Apis::MarketingplatformadminV1alpha::Money, decorator: Google::Apis::MarketingplatformadminV1alpha::Money::Representation
|
|
139
|
+
|
|
140
|
+
property :total, as: 'total', class: Google::Apis::MarketingplatformadminV1alpha::Money, decorator: Google::Apis::MarketingplatformadminV1alpha::Money::Representation
|
|
141
|
+
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
class ClientData
|
|
146
|
+
# @private
|
|
147
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
148
|
+
property :end_date, as: 'endDate', class: Google::Apis::MarketingplatformadminV1alpha::Date, decorator: Google::Apis::MarketingplatformadminV1alpha::Date::Representation
|
|
149
|
+
|
|
150
|
+
property :organization, as: 'organization', class: Google::Apis::MarketingplatformadminV1alpha::Organization, decorator: Google::Apis::MarketingplatformadminV1alpha::Organization::Representation
|
|
151
|
+
|
|
152
|
+
property :start_date, as: 'startDate', class: Google::Apis::MarketingplatformadminV1alpha::Date, decorator: Google::Apis::MarketingplatformadminV1alpha::Date::Representation
|
|
153
|
+
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
class Date
|
|
158
|
+
# @private
|
|
159
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
160
|
+
property :day, as: 'day'
|
|
161
|
+
property :month, as: 'month'
|
|
162
|
+
property :year, as: 'year'
|
|
163
|
+
end
|
|
164
|
+
end
|
|
165
|
+
|
|
71
166
|
class Empty
|
|
72
167
|
# @private
|
|
73
168
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
74
169
|
end
|
|
75
170
|
end
|
|
76
171
|
|
|
172
|
+
class FindSalesPartnerManagedClientsRequest
|
|
173
|
+
# @private
|
|
174
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
175
|
+
property :is_active, as: 'isActive'
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
class FindSalesPartnerManagedClientsResponse
|
|
180
|
+
# @private
|
|
181
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
182
|
+
collection :client_data, as: 'clientData', class: Google::Apis::MarketingplatformadminV1alpha::ClientData, decorator: Google::Apis::MarketingplatformadminV1alpha::ClientData::Representation
|
|
183
|
+
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
|
|
77
187
|
class ListAnalyticsAccountLinksResponse
|
|
78
188
|
# @private
|
|
79
189
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -83,6 +193,24 @@ module Google
|
|
|
83
193
|
end
|
|
84
194
|
end
|
|
85
195
|
|
|
196
|
+
class ListOrganizationsResponse
|
|
197
|
+
# @private
|
|
198
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
199
|
+
property :next_page_token, as: 'nextPageToken'
|
|
200
|
+
collection :organizations, as: 'organizations', class: Google::Apis::MarketingplatformadminV1alpha::Organization, decorator: Google::Apis::MarketingplatformadminV1alpha::Organization::Representation
|
|
201
|
+
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
class Money
|
|
206
|
+
# @private
|
|
207
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
208
|
+
property :currency_code, as: 'currencyCode'
|
|
209
|
+
property :nanos, as: 'nanos'
|
|
210
|
+
property :units, :numeric_string => true, as: 'units'
|
|
211
|
+
end
|
|
212
|
+
end
|
|
213
|
+
|
|
86
214
|
class Organization
|
|
87
215
|
# @private
|
|
88
216
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -91,6 +219,36 @@ module Google
|
|
|
91
219
|
end
|
|
92
220
|
end
|
|
93
221
|
|
|
222
|
+
class PropertyUsage
|
|
223
|
+
# @private
|
|
224
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
225
|
+
property :account_id, :numeric_string => true, as: 'accountId'
|
|
226
|
+
property :billable_event_count, :numeric_string => true, as: 'billableEventCount'
|
|
227
|
+
property :display_name, as: 'displayName'
|
|
228
|
+
property :property, as: 'property'
|
|
229
|
+
property :property_type, as: 'propertyType'
|
|
230
|
+
property :service_level, as: 'serviceLevel'
|
|
231
|
+
property :total_event_count, :numeric_string => true, as: 'totalEventCount'
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
class ReportPropertyUsageRequest
|
|
236
|
+
# @private
|
|
237
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
238
|
+
property :month, as: 'month'
|
|
239
|
+
end
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
class ReportPropertyUsageResponse
|
|
243
|
+
# @private
|
|
244
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
245
|
+
property :bill_info, as: 'billInfo', class: Google::Apis::MarketingplatformadminV1alpha::BillInfo, decorator: Google::Apis::MarketingplatformadminV1alpha::BillInfo::Representation
|
|
246
|
+
|
|
247
|
+
collection :property_usages, as: 'propertyUsages', class: Google::Apis::MarketingplatformadminV1alpha::PropertyUsage, decorator: Google::Apis::MarketingplatformadminV1alpha::PropertyUsage::Representation
|
|
248
|
+
|
|
249
|
+
end
|
|
250
|
+
end
|
|
251
|
+
|
|
94
252
|
class SetPropertyServiceLevelRequest
|
|
95
253
|
# @private
|
|
96
254
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -55,6 +55,42 @@ module Google
|
|
|
55
55
|
@batch_path = 'batch'
|
|
56
56
|
end
|
|
57
57
|
|
|
58
|
+
# Returns a list of clients managed by the sales partner organization. User
|
|
59
|
+
# needs to be an OrgAdmin/BillingAdmin on the sales partner organization in
|
|
60
|
+
# order to view the end clients.
|
|
61
|
+
# @param [String] organization
|
|
62
|
+
# Required. The name of the sales partner organization. Format: organizations/`
|
|
63
|
+
# org_id`
|
|
64
|
+
# @param [Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsRequest] find_sales_partner_managed_clients_request_object
|
|
65
|
+
# @param [String] fields
|
|
66
|
+
# Selector specifying which fields to include in a partial response.
|
|
67
|
+
# @param [String] quota_user
|
|
68
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
69
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
70
|
+
# @param [Google::Apis::RequestOptions] options
|
|
71
|
+
# Request-specific options
|
|
72
|
+
#
|
|
73
|
+
# @yield [result, err] Result & error if block supplied
|
|
74
|
+
# @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsResponse] parsed result object
|
|
75
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
76
|
+
#
|
|
77
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsResponse]
|
|
78
|
+
#
|
|
79
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
80
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
81
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
82
|
+
def find_organization_sales_partner_managed_clients(organization, find_sales_partner_managed_clients_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
83
|
+
command = make_simple_command(:post, 'v1alpha/{+organization}:findSalesPartnerManagedClients', options)
|
|
84
|
+
command.request_representation = Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsRequest::Representation
|
|
85
|
+
command.request_object = find_sales_partner_managed_clients_request_object
|
|
86
|
+
command.response_representation = Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsResponse::Representation
|
|
87
|
+
command.response_class = Google::Apis::MarketingplatformadminV1alpha::FindSalesPartnerManagedClientsResponse
|
|
88
|
+
command.params['organization'] = organization unless organization.nil?
|
|
89
|
+
command.query['fields'] = fields unless fields.nil?
|
|
90
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
91
|
+
execute_or_queue_command(command, &block)
|
|
92
|
+
end
|
|
93
|
+
|
|
58
94
|
# Lookup for a single organization.
|
|
59
95
|
# @param [String] name
|
|
60
96
|
# Required. The name of the Organization to retrieve. Format: organizations/`
|
|
@@ -86,6 +122,85 @@ module Google
|
|
|
86
122
|
execute_or_queue_command(command, &block)
|
|
87
123
|
end
|
|
88
124
|
|
|
125
|
+
# Returns a list of organizations that the user has access to.
|
|
126
|
+
# @param [Fixnum] page_size
|
|
127
|
+
# Optional. The maximum number of organizations to return in one call. The
|
|
128
|
+
# service may return fewer than this value. If unspecified, at most 50
|
|
129
|
+
# organizations will be returned. The maximum value is 1000; values above 1000
|
|
130
|
+
# will be coerced to 1000.
|
|
131
|
+
# @param [String] page_token
|
|
132
|
+
# Optional. A page token, received from a previous ListOrganizations call.
|
|
133
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
|
134
|
+
# parameters provided to `ListOrganizations` must match the call that provided
|
|
135
|
+
# the page token.
|
|
136
|
+
# @param [String] fields
|
|
137
|
+
# Selector specifying which fields to include in a partial response.
|
|
138
|
+
# @param [String] quota_user
|
|
139
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
140
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
141
|
+
# @param [Google::Apis::RequestOptions] options
|
|
142
|
+
# Request-specific options
|
|
143
|
+
#
|
|
144
|
+
# @yield [result, err] Result & error if block supplied
|
|
145
|
+
# @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::ListOrganizationsResponse] parsed result object
|
|
146
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
147
|
+
#
|
|
148
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::ListOrganizationsResponse]
|
|
149
|
+
#
|
|
150
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
151
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
152
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
153
|
+
def list_organizations(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
154
|
+
command = make_simple_command(:get, 'v1alpha/organizations', options)
|
|
155
|
+
command.response_representation = Google::Apis::MarketingplatformadminV1alpha::ListOrganizationsResponse::Representation
|
|
156
|
+
command.response_class = Google::Apis::MarketingplatformadminV1alpha::ListOrganizationsResponse
|
|
157
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
158
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
159
|
+
command.query['fields'] = fields unless fields.nil?
|
|
160
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
161
|
+
execute_or_queue_command(command, &block)
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Get the usage and billing data for properties within the organization for the
|
|
165
|
+
# specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin
|
|
166
|
+
# on the organization in order to view the billing and usage data. Per sales
|
|
167
|
+
# partner client org, user needs to be OrgAdmin/BillingAdmin on the sales
|
|
168
|
+
# partner org in order to view the billing and usage data, or OrgAdmin/
|
|
169
|
+
# BillingAdmin on the sales partner client org in order to view the usage data
|
|
170
|
+
# only.
|
|
171
|
+
# @param [String] organization
|
|
172
|
+
# Required. Specifies the organization whose property usage will be listed.
|
|
173
|
+
# Format: organizations/`org_id`
|
|
174
|
+
# @param [Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageRequest] report_property_usage_request_object
|
|
175
|
+
# @param [String] fields
|
|
176
|
+
# Selector specifying which fields to include in a partial response.
|
|
177
|
+
# @param [String] quota_user
|
|
178
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
179
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
180
|
+
# @param [Google::Apis::RequestOptions] options
|
|
181
|
+
# Request-specific options
|
|
182
|
+
#
|
|
183
|
+
# @yield [result, err] Result & error if block supplied
|
|
184
|
+
# @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageResponse] parsed result object
|
|
185
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
186
|
+
#
|
|
187
|
+
# @return [Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageResponse]
|
|
188
|
+
#
|
|
189
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
190
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
191
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
192
|
+
def report_organization_property_usage(organization, report_property_usage_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
193
|
+
command = make_simple_command(:post, 'v1alpha/{+organization}:reportPropertyUsage', options)
|
|
194
|
+
command.request_representation = Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageRequest::Representation
|
|
195
|
+
command.request_object = report_property_usage_request_object
|
|
196
|
+
command.response_representation = Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageResponse::Representation
|
|
197
|
+
command.response_class = Google::Apis::MarketingplatformadminV1alpha::ReportPropertyUsageResponse
|
|
198
|
+
command.params['organization'] = organization unless organization.nil?
|
|
199
|
+
command.query['fields'] = fields unless fields.nil?
|
|
200
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
201
|
+
execute_or_queue_command(command, &block)
|
|
202
|
+
end
|
|
203
|
+
|
|
89
204
|
# Creates the link between the Analytics account and the Google Marketing
|
|
90
205
|
# Platform organization. User needs to be an org user, and admin on the
|
|
91
206
|
# Analytics account to create the link. If the account is already linked to an
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-marketingplatformadmin_v1alpha
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.7.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -57,7 +57,7 @@ licenses:
|
|
|
57
57
|
metadata:
|
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-marketingplatformadmin_v1alpha/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-marketingplatformadmin_v1alpha/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-marketingplatformadmin_v1alpha/v0.7.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-marketingplatformadmin_v1alpha
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|
|
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
73
73
|
- !ruby/object:Gem::Version
|
|
74
74
|
version: '0'
|
|
75
75
|
requirements: []
|
|
76
|
-
rubygems_version: 3.6.
|
|
76
|
+
rubygems_version: 3.6.9
|
|
77
77
|
specification_version: 4
|
|
78
78
|
summary: Simple REST client for Google Marketing Platform Admin API V1alpha
|
|
79
79
|
test_files: []
|