google-apis-marketingplatformadmin_v1alpha 0.9.0 → 0.10.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fc71ce6014bc21bd8833ac2f975a0061565a70620bed5f1d9f6abcaa8497e775
4
- data.tar.gz: 3ded7380361df096d616f466f1c97dff08375791fbbd45f0cca355c2b8cfc912
3
+ metadata.gz: f8bd0ee40ea278b060cc9d6cfec44769bcf933ea44ba21a8f5fe4137ca63eef7
4
+ data.tar.gz: 96d52e0c2de514f1c4f9dbf87dccfc56ab0b6861d1dd26aa2d6df825ee1729d6
5
5
  SHA512:
6
- metadata.gz: 5adc74e1cf6be57a105cea282c0a05d3fdb7765a6b8eb82d1882668cf930aabd634c2f386c4e2162966a849ca3b8c2bf9cbb421bf03362b7a5e64be8262b9185
7
- data.tar.gz: 502d268a8bc58d8ccbfec84c82649c287117de7f3b152fcde07e1617fd09b0ac394e977d1886c8ad35ade69ff9ef195b34f7fc029b05d5315a58967cc315188e
6
+ metadata.gz: dd9f183f6209f8c36da06b1b9e5247fd4ff3e962c6d4ca41c7a43f1df7f08e100b77bccc09d619a616bc33e2c175a2a8f3695ddeaf4d14c4440ba9b9675e8722
7
+ data.tar.gz: df1bc4a5d4e15af1da1b90da451fc4bf19a61db8d7671e2e112664f8d2529a76551e9fb483da8de60bae630e906c6453bd9fe3bfca80c4289392f9780d1a2c6a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-marketingplatformadmin_v1alpha
2
2
 
3
+ ### v0.10.0 (2026-09-20)
4
+
5
+ * Regenerated from discovery document revision 20260916
6
+
3
7
  ### v0.9.0 (2026-06-14)
4
8
 
5
9
  * Regenerated using generator version 0.19.0
@@ -22,6 +22,47 @@ module Google
22
22
  module Apis
23
23
  module MarketingplatformadminV1alpha
24
24
 
25
+ # A resource message representing a binding to a set of roles.
26
+ class AdminAccessBinding
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Identifier. The resource name of this AdminAccessBinding. Format:
30
+ # organizations/`org_id`/adminAccessBindings/`admin_access_binding_id` Example: "
31
+ # organizations/123abc/adminAccessBindings/456def"
32
+ # Corresponds to the JSON property `name`
33
+ # @return [String]
34
+ attr_accessor :name
35
+
36
+ # Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE
37
+ # and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is
38
+ # assigned. No roles will be assigned if no roles are specified.
39
+ # Corresponds to the JSON property `organizationRoles`
40
+ # @return [Array<String>]
41
+ attr_accessor :organization_roles
42
+
43
+ # Email address of the user.
44
+ # Corresponds to the JSON property `userEmail`
45
+ # @return [String]
46
+ attr_accessor :user_email
47
+
48
+ # Resource name of the user group.
49
+ # Corresponds to the JSON property `userGroup`
50
+ # @return [String]
51
+ attr_accessor :user_group
52
+
53
+ def initialize(**args)
54
+ update!(**args)
55
+ end
56
+
57
+ # Update properties of this object
58
+ def update!(**args)
59
+ @name = args[:name] if args.key?(:name)
60
+ @organization_roles = args[:organization_roles] if args.key?(:organization_roles)
61
+ @user_email = args[:user_email] if args.key?(:user_email)
62
+ @user_group = args[:user_group] if args.key?(:user_group)
63
+ end
64
+ end
65
+
25
66
  # A resource message representing the link between a Google Analytics account
26
67
  # and a Google Marketing Platform organization.
27
68
  class AnalyticsAccountLink
@@ -245,6 +286,32 @@ module Google
245
286
  end
246
287
  end
247
288
 
289
+ # Response message for ListAdminAccessBindings RPC.
290
+ class ListAdminAccessBindingsResponse
291
+ include Google::Apis::Core::Hashable
292
+
293
+ # Admin Access Bindings in the organization.
294
+ # Corresponds to the JSON property `adminAccessBindings`
295
+ # @return [Array<Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding>]
296
+ attr_accessor :admin_access_bindings
297
+
298
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
299
+ # field is omitted, there are no subsequent pages.
300
+ # Corresponds to the JSON property `nextPageToken`
301
+ # @return [String]
302
+ attr_accessor :next_page_token
303
+
304
+ def initialize(**args)
305
+ update!(**args)
306
+ end
307
+
308
+ # Update properties of this object
309
+ def update!(**args)
310
+ @admin_access_bindings = args[:admin_access_bindings] if args.key?(:admin_access_bindings)
311
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
312
+ end
313
+ end
314
+
248
315
  # Response message for ListAnalyticsAccountLinks RPC.
249
316
  class ListAnalyticsAccountLinksResponse
250
317
  include Google::Apis::Core::Hashable
@@ -298,6 +365,58 @@ module Google
298
365
  end
299
366
  end
300
367
 
368
+ # Response message for ListUserGroupMembers RPC.
369
+ class ListUserGroupMembersResponse
370
+ include Google::Apis::Core::Hashable
371
+
372
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
373
+ # field is omitted, there are no subsequent pages.
374
+ # Corresponds to the JSON property `nextPageToken`
375
+ # @return [String]
376
+ attr_accessor :next_page_token
377
+
378
+ # User group members in the user group.
379
+ # Corresponds to the JSON property `userGroupMembers`
380
+ # @return [Array<Google::Apis::MarketingplatformadminV1alpha::UserGroupMember>]
381
+ attr_accessor :user_group_members
382
+
383
+ def initialize(**args)
384
+ update!(**args)
385
+ end
386
+
387
+ # Update properties of this object
388
+ def update!(**args)
389
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
390
+ @user_group_members = args[:user_group_members] if args.key?(:user_group_members)
391
+ end
392
+ end
393
+
394
+ # Response message for ListUserGroups RPC.
395
+ class ListUserGroupsResponse
396
+ include Google::Apis::Core::Hashable
397
+
398
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
399
+ # field is omitted, there are no subsequent pages.
400
+ # Corresponds to the JSON property `nextPageToken`
401
+ # @return [String]
402
+ attr_accessor :next_page_token
403
+
404
+ # User groups in the organization.
405
+ # Corresponds to the JSON property `userGroups`
406
+ # @return [Array<Google::Apis::MarketingplatformadminV1alpha::UserGroup>]
407
+ attr_accessor :user_groups
408
+
409
+ def initialize(**args)
410
+ update!(**args)
411
+ end
412
+
413
+ # Update properties of this object
414
+ def update!(**args)
415
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
416
+ @user_groups = args[:user_groups] if args.key?(:user_groups)
417
+ end
418
+ end
419
+
301
420
  # Represents an amount of money with its currency type.
302
421
  class Money
303
422
  include Google::Apis::Core::Hashable
@@ -501,6 +620,77 @@ module Google
501
620
  def update!(**args)
502
621
  end
503
622
  end
623
+
624
+ # A resource message representing a user group in a GMP organization.
625
+ class UserGroup
626
+ include Google::Apis::Core::Hashable
627
+
628
+ # Optional. The description of the user group.
629
+ # Corresponds to the JSON property `description`
630
+ # @return [String]
631
+ attr_accessor :description
632
+
633
+ # Optional. The human-readable name for the user group.
634
+ # Corresponds to the JSON property `displayName`
635
+ # @return [String]
636
+ attr_accessor :display_name
637
+
638
+ # Identifier. Resource name of this UserGroup. Format: organizations/`org_id`/
639
+ # userGroups/`user_group_id` Example: "organizations/123abc/userGroups/456def"
640
+ # Corresponds to the JSON property `name`
641
+ # @return [String]
642
+ attr_accessor :name
643
+
644
+ def initialize(**args)
645
+ update!(**args)
646
+ end
647
+
648
+ # Update properties of this object
649
+ def update!(**args)
650
+ @description = args[:description] if args.key?(:description)
651
+ @display_name = args[:display_name] if args.key?(:display_name)
652
+ @name = args[:name] if args.key?(:name)
653
+ end
654
+ end
655
+
656
+ # A resource message representing a member of a user group.
657
+ class UserGroupMember
658
+ include Google::Apis::Core::Hashable
659
+
660
+ # Optional. The role of the member in the user group.
661
+ # Corresponds to the JSON property `membershipRole`
662
+ # @return [String]
663
+ attr_accessor :membership_role
664
+
665
+ # Identifier. The resource name of this UserGroupMember. Format: organizations/`
666
+ # org_id`/userGroups/`user_group_id`/members/`member_id` Example: "organizations/
667
+ # 123abc/userGroups/456def/members/789ghi"
668
+ # Corresponds to the JSON property `name`
669
+ # @return [String]
670
+ attr_accessor :name
671
+
672
+ # Email address of the user member.
673
+ # Corresponds to the JSON property `userEmail`
674
+ # @return [String]
675
+ attr_accessor :user_email
676
+
677
+ # User group resource name of the group member.
678
+ # Corresponds to the JSON property `userGroup`
679
+ # @return [String]
680
+ attr_accessor :user_group
681
+
682
+ def initialize(**args)
683
+ update!(**args)
684
+ end
685
+
686
+ # Update properties of this object
687
+ def update!(**args)
688
+ @membership_role = args[:membership_role] if args.key?(:membership_role)
689
+ @name = args[:name] if args.key?(:name)
690
+ @user_email = args[:user_email] if args.key?(:user_email)
691
+ @user_group = args[:user_group] if args.key?(:user_group)
692
+ end
693
+ end
504
694
  end
505
695
  end
506
696
  end
@@ -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.9.0"
19
+ GEM_VERSION = "0.10.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.19.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20260303"
25
+ REVISION = "20260916"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,12 @@ module Google
22
22
  module Apis
23
23
  module MarketingplatformadminV1alpha
24
24
 
25
+ class AdminAccessBinding
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
25
31
  class AnalyticsAccountLink
26
32
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
33
 
@@ -64,6 +70,12 @@ module Google
64
70
  include Google::Apis::Core::JsonObjectSupport
65
71
  end
66
72
 
73
+ class ListAdminAccessBindingsResponse
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
67
79
  class ListAnalyticsAccountLinksResponse
68
80
  class Representation < Google::Apis::Core::JsonRepresentation; end
69
81
 
@@ -76,6 +88,18 @@ module Google
76
88
  include Google::Apis::Core::JsonObjectSupport
77
89
  end
78
90
 
91
+ class ListUserGroupMembersResponse
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class ListUserGroupsResponse
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
79
103
  class Money
80
104
  class Representation < Google::Apis::Core::JsonRepresentation; end
81
105
 
@@ -118,6 +142,28 @@ module Google
118
142
  include Google::Apis::Core::JsonObjectSupport
119
143
  end
120
144
 
145
+ class UserGroup
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
151
+ class UserGroupMember
152
+ class Representation < Google::Apis::Core::JsonRepresentation; end
153
+
154
+ include Google::Apis::Core::JsonObjectSupport
155
+ end
156
+
157
+ class AdminAccessBinding
158
+ # @private
159
+ class Representation < Google::Apis::Core::JsonRepresentation
160
+ property :name, as: 'name'
161
+ collection :organization_roles, as: 'organizationRoles'
162
+ property :user_email, as: 'userEmail'
163
+ property :user_group, as: 'userGroup'
164
+ end
165
+ end
166
+
121
167
  class AnalyticsAccountLink
122
168
  # @private
123
169
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -184,6 +230,15 @@ module Google
184
230
  end
185
231
  end
186
232
 
233
+ class ListAdminAccessBindingsResponse
234
+ # @private
235
+ class Representation < Google::Apis::Core::JsonRepresentation
236
+ collection :admin_access_bindings, as: 'adminAccessBindings', class: Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding, decorator: Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
237
+
238
+ property :next_page_token, as: 'nextPageToken'
239
+ end
240
+ end
241
+
187
242
  class ListAnalyticsAccountLinksResponse
188
243
  # @private
189
244
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -202,6 +257,24 @@ module Google
202
257
  end
203
258
  end
204
259
 
260
+ class ListUserGroupMembersResponse
261
+ # @private
262
+ class Representation < Google::Apis::Core::JsonRepresentation
263
+ property :next_page_token, as: 'nextPageToken'
264
+ collection :user_group_members, as: 'userGroupMembers', class: Google::Apis::MarketingplatformadminV1alpha::UserGroupMember, decorator: Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
265
+
266
+ end
267
+ end
268
+
269
+ class ListUserGroupsResponse
270
+ # @private
271
+ class Representation < Google::Apis::Core::JsonRepresentation
272
+ property :next_page_token, as: 'nextPageToken'
273
+ collection :user_groups, as: 'userGroups', class: Google::Apis::MarketingplatformadminV1alpha::UserGroup, decorator: Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
274
+
275
+ end
276
+ end
277
+
205
278
  class Money
206
279
  # @private
207
280
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -262,6 +335,25 @@ module Google
262
335
  class Representation < Google::Apis::Core::JsonRepresentation
263
336
  end
264
337
  end
338
+
339
+ class UserGroup
340
+ # @private
341
+ class Representation < Google::Apis::Core::JsonRepresentation
342
+ property :description, as: 'description'
343
+ property :display_name, as: 'displayName'
344
+ property :name, as: 'name'
345
+ end
346
+ end
347
+
348
+ class UserGroupMember
349
+ # @private
350
+ class Representation < Google::Apis::Core::JsonRepresentation
351
+ property :membership_role, as: 'membershipRole'
352
+ property :name, as: 'name'
353
+ property :user_email, as: 'userEmail'
354
+ property :user_group, as: 'userGroup'
355
+ end
356
+ end
265
357
  end
266
358
  end
267
359
  end
@@ -201,6 +201,154 @@ module Google
201
201
  execute_or_queue_command(command, &block)
202
202
  end
203
203
 
204
+ # Creates an admin access binding in the specified GMP organization.
205
+ # @param [String] parent
206
+ # Required. The parent organization, which owns this Admin Access Binding.
207
+ # Format: organizations/`org_id`
208
+ # @param [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding] admin_access_binding_object
209
+ # @param [String] fields
210
+ # Selector specifying which fields to include in a partial response.
211
+ # @param [String] quota_user
212
+ # Available to use for quota purposes for server-side applications. Can be any
213
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
214
+ # @param [Google::Apis::RequestOptions] options
215
+ # Request-specific options
216
+ #
217
+ # @yield [result, err] Result & error if block supplied
218
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding] parsed result object
219
+ # @yieldparam err [StandardError] error object if request failed
220
+ #
221
+ # @return [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding]
222
+ #
223
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
224
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
225
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
226
+ def create_organization_admin_access_binding(parent, admin_access_binding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
227
+ command = make_simple_command(:post, 'v1alpha/{+parent}/adminAccessBindings', options)
228
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
229
+ command.request_object = admin_access_binding_object
230
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
231
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding
232
+ command.params['parent'] = parent unless parent.nil?
233
+ command.query['fields'] = fields unless fields.nil?
234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
235
+ execute_or_queue_command(command, &block)
236
+ end
237
+
238
+ # Looks up a single admin access binding.
239
+ # @param [String] name
240
+ # Required. The name of the AdminAccessBinding to retrieve. Format:
241
+ # organizations/`org_id`/adminAccessBindings/`admin_access_binding_id`
242
+ # @param [String] fields
243
+ # Selector specifying which fields to include in a partial response.
244
+ # @param [String] quota_user
245
+ # Available to use for quota purposes for server-side applications. Can be any
246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
247
+ # @param [Google::Apis::RequestOptions] options
248
+ # Request-specific options
249
+ #
250
+ # @yield [result, err] Result & error if block supplied
251
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding] parsed result object
252
+ # @yieldparam err [StandardError] error object if request failed
253
+ #
254
+ # @return [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding]
255
+ #
256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
259
+ def get_organization_admin_access_binding(name, fields: nil, quota_user: nil, options: nil, &block)
260
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
261
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
262
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding
263
+ command.params['name'] = name unless name.nil?
264
+ command.query['fields'] = fields unless fields.nil?
265
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
266
+ execute_or_queue_command(command, &block)
267
+ end
268
+
269
+ # Returns a list of admin access bindings in the specified GMP organization.
270
+ # @param [String] parent
271
+ # Required. The parent organization, which owns this collection of Admin Access
272
+ # Bindings. Format: organizations/`org_id`
273
+ # @param [Fixnum] page_size
274
+ # Optional. The maximum number of Admin Access Bindings to return in one call.
275
+ # The service may return fewer than this value. If unspecified, at most 50 Admin
276
+ # Access Bindings will be returned. The maximum value is 1000; values above 1000
277
+ # will be coerced to 1000.
278
+ # @param [String] page_token
279
+ # Optional. A page token, received from a previous ListAdminAccessBindings call.
280
+ # Provide this to retrieve the subsequent page. When paginating, all other
281
+ # parameters provided to `ListAdminAccessBindings` must match the call that
282
+ # provided the page token.
283
+ # @param [String] fields
284
+ # Selector specifying which fields to include in a partial response.
285
+ # @param [String] quota_user
286
+ # Available to use for quota purposes for server-side applications. Can be any
287
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
288
+ # @param [Google::Apis::RequestOptions] options
289
+ # Request-specific options
290
+ #
291
+ # @yield [result, err] Result & error if block supplied
292
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::ListAdminAccessBindingsResponse] parsed result object
293
+ # @yieldparam err [StandardError] error object if request failed
294
+ #
295
+ # @return [Google::Apis::MarketingplatformadminV1alpha::ListAdminAccessBindingsResponse]
296
+ #
297
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
298
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
299
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
300
+ def list_organization_admin_access_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
301
+ command = make_simple_command(:get, 'v1alpha/{+parent}/adminAccessBindings', options)
302
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::ListAdminAccessBindingsResponse::Representation
303
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::ListAdminAccessBindingsResponse
304
+ command.params['parent'] = parent unless parent.nil?
305
+ command.query['pageSize'] = page_size unless page_size.nil?
306
+ command.query['pageToken'] = page_token unless page_token.nil?
307
+ command.query['fields'] = fields unless fields.nil?
308
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
309
+ execute_or_queue_command(command, &block)
310
+ end
311
+
312
+ # Updates an admin access binding in the specified GMP organization.
313
+ # @param [String] name
314
+ # Identifier. The resource name of this AdminAccessBinding. Format:
315
+ # organizations/`org_id`/adminAccessBindings/`admin_access_binding_id` Example: "
316
+ # organizations/123abc/adminAccessBindings/456def"
317
+ # @param [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding] admin_access_binding_object
318
+ # @param [String] update_mask
319
+ # Required. The list of fields to update. Field names must be in snake case (for
320
+ # example, "field_to_update"). Omitted fields will not be updated. To replace
321
+ # the entire entity, use one path with the string "*" to match all fields.
322
+ # @param [String] fields
323
+ # Selector specifying which fields to include in a partial response.
324
+ # @param [String] quota_user
325
+ # Available to use for quota purposes for server-side applications. Can be any
326
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
327
+ # @param [Google::Apis::RequestOptions] options
328
+ # Request-specific options
329
+ #
330
+ # @yield [result, err] Result & error if block supplied
331
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding] parsed result object
332
+ # @yieldparam err [StandardError] error object if request failed
333
+ #
334
+ # @return [Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding]
335
+ #
336
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
337
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
338
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
339
+ def patch_organization_admin_access_binding(name, admin_access_binding_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
340
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
341
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
342
+ command.request_object = admin_access_binding_object
343
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding::Representation
344
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::AdminAccessBinding
345
+ command.params['name'] = name unless name.nil?
346
+ command.query['updateMask'] = update_mask unless update_mask.nil?
347
+ command.query['fields'] = fields unless fields.nil?
348
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
349
+ execute_or_queue_command(command, &block)
350
+ end
351
+
204
352
  # Creates the link between the Analytics account and the Google Marketing
205
353
  # Platform organization. User needs to be an org user, and admin on the
206
354
  # Analytics account to create the link. If the account is already linked to an
@@ -350,6 +498,362 @@ module Google
350
498
  command.query['quotaUser'] = quota_user unless quota_user.nil?
351
499
  execute_or_queue_command(command, &block)
352
500
  end
501
+
502
+ # Creates a user group in the specified GMP organization.
503
+ # @param [String] parent
504
+ # Required. The parent resource where this UserGroup will be created. Format:
505
+ # organizations/`org_id`
506
+ # @param [Google::Apis::MarketingplatformadminV1alpha::UserGroup] user_group_object
507
+ # @param [String] fields
508
+ # Selector specifying which fields to include in a partial response.
509
+ # @param [String] quota_user
510
+ # Available to use for quota purposes for server-side applications. Can be any
511
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
512
+ # @param [Google::Apis::RequestOptions] options
513
+ # Request-specific options
514
+ #
515
+ # @yield [result, err] Result & error if block supplied
516
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroup] parsed result object
517
+ # @yieldparam err [StandardError] error object if request failed
518
+ #
519
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroup]
520
+ #
521
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
522
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
523
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
524
+ def create_organization_user_group(parent, user_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
525
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userGroups', options)
526
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
527
+ command.request_object = user_group_object
528
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
529
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroup
530
+ command.params['parent'] = parent unless parent.nil?
531
+ command.query['fields'] = fields unless fields.nil?
532
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
533
+ execute_or_queue_command(command, &block)
534
+ end
535
+
536
+ # Deletes a user group in the specified GMP organization.
537
+ # @param [String] name
538
+ # Required. The name of the user group to delete. Format: organizations/`org_id`/
539
+ # userGroups/`user_group_id`
540
+ # @param [String] fields
541
+ # Selector specifying which fields to include in a partial response.
542
+ # @param [String] quota_user
543
+ # Available to use for quota purposes for server-side applications. Can be any
544
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
545
+ # @param [Google::Apis::RequestOptions] options
546
+ # Request-specific options
547
+ #
548
+ # @yield [result, err] Result & error if block supplied
549
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::Empty] parsed result object
550
+ # @yieldparam err [StandardError] error object if request failed
551
+ #
552
+ # @return [Google::Apis::MarketingplatformadminV1alpha::Empty]
553
+ #
554
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
555
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
556
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
557
+ def delete_organization_user_group(name, fields: nil, quota_user: nil, options: nil, &block)
558
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
559
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::Empty::Representation
560
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::Empty
561
+ command.params['name'] = name unless name.nil?
562
+ command.query['fields'] = fields unless fields.nil?
563
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
564
+ execute_or_queue_command(command, &block)
565
+ end
566
+
567
+ # Looks up a single user group.
568
+ # @param [String] name
569
+ # Required. The name of the UserGroup to retrieve. Format: organizations/`org_id`
570
+ # /userGroups/`user_group_id`
571
+ # @param [String] fields
572
+ # Selector specifying which fields to include in a partial response.
573
+ # @param [String] quota_user
574
+ # Available to use for quota purposes for server-side applications. Can be any
575
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
576
+ # @param [Google::Apis::RequestOptions] options
577
+ # Request-specific options
578
+ #
579
+ # @yield [result, err] Result & error if block supplied
580
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroup] parsed result object
581
+ # @yieldparam err [StandardError] error object if request failed
582
+ #
583
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroup]
584
+ #
585
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
586
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
587
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
588
+ def get_organization_user_group(name, fields: nil, quota_user: nil, options: nil, &block)
589
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
590
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
591
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroup
592
+ command.params['name'] = name unless name.nil?
593
+ command.query['fields'] = fields unless fields.nil?
594
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
595
+ execute_or_queue_command(command, &block)
596
+ end
597
+
598
+ # Returns a list of user groups in the specified GMP organization.
599
+ # @param [String] parent
600
+ # Required. The parent org where this UserGroup will be listed. Format:
601
+ # organizations/`org_id`
602
+ # @param [Fixnum] page_size
603
+ # Optional. The maximum number of user groups to return in one call. The service
604
+ # may return fewer than this value. If unspecified, at most 50 user groups will
605
+ # be returned. The maximum value is 1000; values above 1000 will be coerced to
606
+ # 1000.
607
+ # @param [String] page_token
608
+ # Optional. A page token, received from a previous ListUserGroups call. Provide
609
+ # this to retrieve the subsequent page. When paginating, all other parameters
610
+ # provided to `ListUserGroups` must match the call that provided the page token.
611
+ # @param [String] fields
612
+ # Selector specifying which fields to include in a partial response.
613
+ # @param [String] quota_user
614
+ # Available to use for quota purposes for server-side applications. Can be any
615
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
616
+ # @param [Google::Apis::RequestOptions] options
617
+ # Request-specific options
618
+ #
619
+ # @yield [result, err] Result & error if block supplied
620
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::ListUserGroupsResponse] parsed result object
621
+ # @yieldparam err [StandardError] error object if request failed
622
+ #
623
+ # @return [Google::Apis::MarketingplatformadminV1alpha::ListUserGroupsResponse]
624
+ #
625
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
626
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
627
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
628
+ def list_organization_user_groups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
629
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userGroups', options)
630
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::ListUserGroupsResponse::Representation
631
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::ListUserGroupsResponse
632
+ command.params['parent'] = parent unless parent.nil?
633
+ command.query['pageSize'] = page_size unless page_size.nil?
634
+ command.query['pageToken'] = page_token unless page_token.nil?
635
+ command.query['fields'] = fields unless fields.nil?
636
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
637
+ execute_or_queue_command(command, &block)
638
+ end
639
+
640
+ # Updates a user group in the specified GMP organization.
641
+ # @param [String] name
642
+ # Identifier. Resource name of this UserGroup. Format: organizations/`org_id`/
643
+ # userGroups/`user_group_id` Example: "organizations/123abc/userGroups/456def"
644
+ # @param [Google::Apis::MarketingplatformadminV1alpha::UserGroup] user_group_object
645
+ # @param [String] update_mask
646
+ # Required. The list of fields to update. Field names must be in snake case (for
647
+ # example, "field_to_update"). Omitted fields will not be updated. To replace
648
+ # the entire entity, use one path with the string "*" to match all fields.
649
+ # @param [String] fields
650
+ # Selector specifying which fields to include in a partial response.
651
+ # @param [String] quota_user
652
+ # Available to use for quota purposes for server-side applications. Can be any
653
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
654
+ # @param [Google::Apis::RequestOptions] options
655
+ # Request-specific options
656
+ #
657
+ # @yield [result, err] Result & error if block supplied
658
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroup] parsed result object
659
+ # @yieldparam err [StandardError] error object if request failed
660
+ #
661
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroup]
662
+ #
663
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
664
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
665
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
666
+ def patch_organization_user_group(name, user_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
667
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
668
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
669
+ command.request_object = user_group_object
670
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroup::Representation
671
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroup
672
+ command.params['name'] = name unless name.nil?
673
+ command.query['updateMask'] = update_mask unless update_mask.nil?
674
+ command.query['fields'] = fields unless fields.nil?
675
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
676
+ execute_or_queue_command(command, &block)
677
+ end
678
+
679
+ # Adds a member to the specified GMP user group.
680
+ # @param [String] parent
681
+ # Required. The parent resource where this UserGroupMember will be created.
682
+ # Format: organizations/`org_id`/userGroups/`user_group_id`
683
+ # @param [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember] user_group_member_object
684
+ # @param [String] fields
685
+ # Selector specifying which fields to include in a partial response.
686
+ # @param [String] quota_user
687
+ # Available to use for quota purposes for server-side applications. Can be any
688
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
689
+ # @param [Google::Apis::RequestOptions] options
690
+ # Request-specific options
691
+ #
692
+ # @yield [result, err] Result & error if block supplied
693
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember] parsed result object
694
+ # @yieldparam err [StandardError] error object if request failed
695
+ #
696
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember]
697
+ #
698
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
699
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
700
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
701
+ def create_organization_user_group_member(parent, user_group_member_object = nil, fields: nil, quota_user: nil, options: nil, &block)
702
+ command = make_simple_command(:post, 'v1alpha/{+parent}/members', options)
703
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
704
+ command.request_object = user_group_member_object
705
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
706
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember
707
+ command.params['parent'] = parent unless parent.nil?
708
+ command.query['fields'] = fields unless fields.nil?
709
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
710
+ execute_or_queue_command(command, &block)
711
+ end
712
+
713
+ # Deletes a member in the specified GMP user group.
714
+ # @param [String] name
715
+ # Required. The name of the user group member to delete. Format: organizations/`
716
+ # org_id`/userGroups/`user_group_id`/members/`member_id`
717
+ # @param [String] fields
718
+ # Selector specifying which fields to include in a partial response.
719
+ # @param [String] quota_user
720
+ # Available to use for quota purposes for server-side applications. Can be any
721
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
722
+ # @param [Google::Apis::RequestOptions] options
723
+ # Request-specific options
724
+ #
725
+ # @yield [result, err] Result & error if block supplied
726
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::Empty] parsed result object
727
+ # @yieldparam err [StandardError] error object if request failed
728
+ #
729
+ # @return [Google::Apis::MarketingplatformadminV1alpha::Empty]
730
+ #
731
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
732
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
733
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
734
+ def delete_organization_user_group_member(name, fields: nil, quota_user: nil, options: nil, &block)
735
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
736
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::Empty::Representation
737
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::Empty
738
+ command.params['name'] = name unless name.nil?
739
+ command.query['fields'] = fields unless fields.nil?
740
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
741
+ execute_or_queue_command(command, &block)
742
+ end
743
+
744
+ # Looks up a single user group member.
745
+ # @param [String] name
746
+ # Required. The name of the user group member to retrieve. Format: organizations/
747
+ # `org_id`/userGroups/`user_group_id`/members/`member_id`
748
+ # @param [String] fields
749
+ # Selector specifying which fields to include in a partial response.
750
+ # @param [String] quota_user
751
+ # Available to use for quota purposes for server-side applications. Can be any
752
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
753
+ # @param [Google::Apis::RequestOptions] options
754
+ # Request-specific options
755
+ #
756
+ # @yield [result, err] Result & error if block supplied
757
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember] parsed result object
758
+ # @yieldparam err [StandardError] error object if request failed
759
+ #
760
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember]
761
+ #
762
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
763
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
764
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
765
+ def get_organization_user_group_member(name, fields: nil, quota_user: nil, options: nil, &block)
766
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
767
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
768
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember
769
+ command.params['name'] = name unless name.nil?
770
+ command.query['fields'] = fields unless fields.nil?
771
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
772
+ execute_or_queue_command(command, &block)
773
+ end
774
+
775
+ # Returns a list of members in the specified user group.
776
+ # @param [String] parent
777
+ # Required. The parent user group where this UserGroupMember will be listed.
778
+ # Format: organizations/`org_id`/userGroups/`user_group_id`
779
+ # @param [Fixnum] page_size
780
+ # Optional. The maximum number of user group members to return in one call. The
781
+ # service may return fewer than this value. If unspecified, at most 50 user
782
+ # group members will be returned. The maximum value is 1000; values above 1000
783
+ # will be coerced to 1000.
784
+ # @param [String] page_token
785
+ # Optional. A page token, received from a previous ListUserGroupMembers call.
786
+ # Provide this to retrieve the subsequent page. When paginating, all other
787
+ # parameters provided to `ListUserGroupMembers` must match the call that
788
+ # provided the page token.
789
+ # @param [String] fields
790
+ # Selector specifying which fields to include in a partial response.
791
+ # @param [String] quota_user
792
+ # Available to use for quota purposes for server-side applications. Can be any
793
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
794
+ # @param [Google::Apis::RequestOptions] options
795
+ # Request-specific options
796
+ #
797
+ # @yield [result, err] Result & error if block supplied
798
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::ListUserGroupMembersResponse] parsed result object
799
+ # @yieldparam err [StandardError] error object if request failed
800
+ #
801
+ # @return [Google::Apis::MarketingplatformadminV1alpha::ListUserGroupMembersResponse]
802
+ #
803
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
804
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
805
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
806
+ def list_organization_user_group_members(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
807
+ command = make_simple_command(:get, 'v1alpha/{+parent}/members', options)
808
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::ListUserGroupMembersResponse::Representation
809
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::ListUserGroupMembersResponse
810
+ command.params['parent'] = parent unless parent.nil?
811
+ command.query['pageSize'] = page_size unless page_size.nil?
812
+ command.query['pageToken'] = page_token unless page_token.nil?
813
+ command.query['fields'] = fields unless fields.nil?
814
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
815
+ execute_or_queue_command(command, &block)
816
+ end
817
+
818
+ # Updates a member in the specified GMP user group.
819
+ # @param [String] name
820
+ # Identifier. The resource name of this UserGroupMember. Format: organizations/`
821
+ # org_id`/userGroups/`user_group_id`/members/`member_id` Example: "organizations/
822
+ # 123abc/userGroups/456def/members/789ghi"
823
+ # @param [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember] user_group_member_object
824
+ # @param [String] update_mask
825
+ # Required. The list of fields to update. Field names must be in snake case (for
826
+ # example, "field_to_update"). Omitted fields will not be updated. To replace
827
+ # the entire entity, use one path with the string "*" to match all fields.
828
+ # @param [String] fields
829
+ # Selector specifying which fields to include in a partial response.
830
+ # @param [String] quota_user
831
+ # Available to use for quota purposes for server-side applications. Can be any
832
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
833
+ # @param [Google::Apis::RequestOptions] options
834
+ # Request-specific options
835
+ #
836
+ # @yield [result, err] Result & error if block supplied
837
+ # @yieldparam result [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember] parsed result object
838
+ # @yieldparam err [StandardError] error object if request failed
839
+ #
840
+ # @return [Google::Apis::MarketingplatformadminV1alpha::UserGroupMember]
841
+ #
842
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
843
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
844
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
845
+ def patch_organization_user_group_member(name, user_group_member_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
846
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
847
+ command.request_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
848
+ command.request_object = user_group_member_object
849
+ command.response_representation = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember::Representation
850
+ command.response_class = Google::Apis::MarketingplatformadminV1alpha::UserGroupMember
851
+ command.params['name'] = name unless name.nil?
852
+ command.query['updateMask'] = update_mask unless update_mask.nil?
853
+ command.query['fields'] = fields unless fields.nil?
854
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
855
+ execute_or_queue_command(command, &block)
856
+ end
353
857
 
354
858
  protected
355
859
 
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.9.0
4
+ version: 0.10.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.9.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-marketingplatformadmin_v1alpha/v0.10.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: