2026-09-17
▼ ▲ marketingplatformadmin.organizations.userGroups.list
Parameter Order : parent
Description : Returns a list of user groups in the specified GMP organization.
Parameters :
pageSize
Format : int32
Location : query
Description : Optional. The maximum number of user groups to return in one call. The service may return fewer than this value. If unspecified, at most 50 user groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type : integer
parent
Type : string
Description : Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id}
Location : path
Required : Yes
Pattern : ^organizations/[^/]+$
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous ListUserGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserGroups` must match the call that provided the page token.
HTTP Method : GET
Path : v1alpha/{+parent}/userGroups
Scopes :
Flat Path : v1alpha/organizations/{organizationsId}/userGroups
▼ ▲ marketingplatformadmin.organizations.userGroups.patch
Parameter Order : name
HTTP Method : PATCH
Path : v1alpha/{+name}
Parameters :
name
Location : path
Required : Yes
Description : Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
Type : string
Pattern : ^organizations/[^/]+/userGroups/[^/]+$
updateMask
Description : Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Location : query
Type : string
Format : google-fieldmask
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Description : Updates a user group in the specified GMP organization.
▼ ▲ marketingplatformadmin.organizations.userGroups.delete
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}
Description : Deletes a user group in the specified GMP organization.
Path : v1alpha/{+name}
Parameters :
name
Pattern : ^organizations/[^/]+/userGroups/[^/]+$
Required : Yes
Description : Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_id}
Type : string
Location : path
Parameter Order : name
HTTP Method : DELETE
▼ ▲ marketingplatformadmin.organizations.userGroups.get
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}
Pattern : ^organizations/[^/]+/userGroups/[^/]+$
Location : path
HTTP Method : GET
Scopes :
Parameter Order : name
Description : Looks up a single user group.
Path : v1alpha/{+name}
▼ ▲ marketingplatformadmin.organizations.userGroups.create
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this UserGroup will be created. Format: organizations/{org_id}
Type : string
Pattern : ^organizations/[^/]+$
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Description : Creates a user group in the specified GMP organization.
Path : v1alpha/{+parent}/userGroups
Flat Path : v1alpha/organizations/{organizationsId}/userGroups
▼ ▲ marketingplatformadmin.organizations.userGroups.members.create
Parameters :
parent
Description : Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id}
Location : path
Pattern : ^organizations/[^/]+/userGroups/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}/members
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Description : Adds a member to the specified GMP user group.
Path : v1alpha/{+parent}/members
▼ ▲ marketingplatformadmin.organizations.userGroups.members.list
Description : Returns a list of members in the specified user group.
Path : v1alpha/{+parent}/members
HTTP Method : GET
Parameter Order : parent
Parameters :
pageSize
Format : int32
Description : Optional. The maximum number of user group members to return in one call. The service may return fewer than this value. If unspecified, at most 50 user group members will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type : integer
Location : query
pageToken
Description : Optional. A page token, received from a previous ListUserGroupMembers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserGroupMembers` must match the call that provided the page token.
Location : query
Type : string
parent
Location : path
Description : Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id}
Type : string
Required : Yes
Pattern : ^organizations/[^/]+/userGroups/[^/]+$
Scopes :
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}/members
▼ ▲ marketingplatformadmin.organizations.userGroups.members.get
Parameter Order : name
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}/members/{membersId}
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^organizations/[^/]+/userGroups/[^/]+/members/[^/]+$
Description : Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id}
HTTP Method : GET
Description : Looks up a single user group member.
Scopes :
Path : v1alpha/{+name}
▼ ▲ marketingplatformadmin.organizations.userGroups.members.delete
Parameters :
name
Pattern : ^organizations/[^/]+/userGroups/[^/]+/members/[^/]+$
Type : string
Description : Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id}
Required : Yes
Location : path
HTTP Method : DELETE
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}/members/{membersId}
Parameter Order : name
Path : v1alpha/{+name}
Description : Deletes a member in the specified GMP user group.
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
▼ ▲ marketingplatformadmin.organizations.userGroups.members.patch
Flat Path : v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}/members/{membersId}
HTTP Method : PATCH
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
name
Pattern : ^organizations/[^/]+/userGroups/[^/]+/members/[^/]+$
Description : Identifier. The resource name of this UserGroupMember. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} Example: "organizations/123abc/userGroups/456def/members/789ghi"
Required : Yes
Type : string
Location : path
Path : v1alpha/{+name}
Description : Updates a member in the specified GMP user group.
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Parameter Order : name
▼ ▲ marketingplatformadmin.organizations.adminAccessBindings.get
Flat Path : v1alpha/organizations/{organizationsId}/adminAccessBindings/{adminAccessBindingsId}
Parameter Order : name
Description : Looks up a single admin access binding.
Path : v1alpha/{+name}
Scopes :
HTTP Method : GET
Parameters :
name
Pattern : ^organizations/[^/]+/adminAccessBindings/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the AdminAccessBinding to retrieve. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id}
Location : path
▼ ▲ marketingplatformadmin.organizations.adminAccessBindings.create
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Description : Creates an admin access binding in the specified GMP organization.
Parameter Order : parent
Parameters :
parent
Pattern : ^organizations/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The parent organization, which owns this Admin Access Binding. Format: organizations/{org_id}
Flat Path : v1alpha/organizations/{organizationsId}/adminAccessBindings
HTTP Method : POST
Path : v1alpha/{+parent}/adminAccessBindings
▼ ▲ marketingplatformadmin.organizations.adminAccessBindings.list
Parameters :
pageSize
Description : Optional. The maximum number of Admin Access Bindings to return in one call. The service may return fewer than this value. If unspecified, at most 50 Admin Access Bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type : integer
Format : int32
Location : query
parent
Pattern : ^organizations/[^/]+$
Description : Required. The parent organization, which owns this collection of Admin Access Bindings. Format: organizations/{org_id}
Required : Yes
Type : string
Location : path
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous ListAdminAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdminAccessBindings` must match the call that provided the page token.
Description : Returns a list of admin access bindings in the specified GMP organization.
HTTP Method : GET
Path : v1alpha/{+parent}/adminAccessBindings
Parameter Order : parent
Flat Path : v1alpha/organizations/{organizationsId}/adminAccessBindings
Scopes :
▼ ▲ marketingplatformadmin.organizations.adminAccessBindings.patch
Flat Path : v1alpha/organizations/{organizationsId}/adminAccessBindings/{adminAccessBindingsId}
Parameters :
name
Location : path
Pattern : ^organizations/[^/]+/adminAccessBindings/[^/]+$
Required : Yes
Type : string
Description : Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"
updateMask
Format : google-fieldmask
Description : Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Location : query
Type : string
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
Path : v1alpha/{+name}
Description : Updates an admin access binding in the specified GMP organization.
Parameter Order : name