create(parent, body=None, x__xgafv=None)

Adds a member to the specified GMP user group.

Args:
  parent: string, Required. The parent resource where this UserGroupMember will be created. Format: organizations/{org_id}/userGroups/{user_group_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a member of a user group.
  "membershipRole": "A String", # Optional. The role of the member in the user group.
  "name": "A String", # 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"
  "userEmail": "A String", # Email address of the user member.
  "userGroup": "A String", # User group resource name of the group member.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a member of a user group.
  "membershipRole": "A String", # Optional. The role of the member in the user group.
  "name": "A String", # 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"
  "userEmail": "A String", # Email address of the user member.
  "userGroup": "A String", # User group resource name of the group member.
}

delete(name, x__xgafv=None)

Deletes a member in the specified GMP user group.

Args:
  name: string, Required. The name of the user group member to delete. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Looks up a single user group member.

Args:
  name: string, Required. The name of the user group member to retrieve. Format: organizations/{org_id}/userGroups/{user_group_id}/members/{member_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a member of a user group.
  "membershipRole": "A String", # Optional. The role of the member in the user group.
  "name": "A String", # 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"
  "userEmail": "A String", # Email address of the user member.
  "userGroup": "A String", # User group resource name of the group member.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of members in the specified user group.

Args:
  parent: string, Required. The parent user group where this UserGroupMember will be listed. Format: organizations/{org_id}/userGroups/{user_group_id} (required)
  pageSize: integer, 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.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListUserGroupMembers RPC.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "userGroupMembers": [ # User group members in the user group.
    { # A resource message representing a member of a user group.
      "membershipRole": "A String", # Optional. The role of the member in the user group.
      "name": "A String", # 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"
      "userEmail": "A String", # Email address of the user member.
      "userGroup": "A String", # User group resource name of the group member.
    },
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a member in the specified GMP user group.

Args:
  name: string, 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)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a member of a user group.
  "membershipRole": "A String", # Optional. The role of the member in the user group.
  "name": "A String", # 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"
  "userEmail": "A String", # Email address of the user member.
  "userGroup": "A String", # User group resource name of the group member.
}

  updateMask: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a member of a user group.
  "membershipRole": "A String", # Optional. The role of the member in the user group.
  "name": "A String", # 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"
  "userEmail": "A String", # Email address of the user member.
  "userGroup": "A String", # User group resource name of the group member.
}

Google Marketing Platform Admin API . organizations . userGroups . members

Instance Methods

Method Details