Google Marketing Platform Admin API . organizations . userGroups

close()

Close httplib2 connections.

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

Creates a user group in the specified GMP organization.

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

{ # A resource message representing a user group in a GMP organization.
  "description": "A String", # Optional. The description of the user group.
  "displayName": "A String", # Optional. The human-readable name for the user group.
  "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
}

  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 user group in a GMP organization.
  "description": "A String", # Optional. The description of the user group.
  "displayName": "A String", # Optional. The human-readable name for the user group.
  "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
}

delete(name, x__xgafv=None)

Deletes a user group in the specified GMP organization.

Args:
  name: string, Required. The name of the user group to delete. Format: organizations/{org_id}/userGroups/{user_group_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.

Args:
  name: string, Required. The name of the UserGroup to retrieve. Format: organizations/{org_id}/userGroups/{user_group_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 user group in a GMP organization.
  "description": "A String", # Optional. The description of the user group.
  "displayName": "A String", # Optional. The human-readable name for the user group.
  "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
}

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

Returns a list of user groups in the specified GMP organization.

Args:
  parent: string, Required. The parent org where this UserGroup will be listed. Format: organizations/{org_id} (required)
  pageSize: integer, 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.
  pageToken: string, 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.
  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 ListUserGroups 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.
  "userGroups": [ # User groups in the organization.
    { # A resource message representing a user group in a GMP organization.
      "description": "A String", # Optional. The description of the user group.
      "displayName": "A String", # Optional. The human-readable name for the user group.
      "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
    },
  ],
}

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 user group in the specified GMP organization.

Args:
  name: string, Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def" (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a user group in a GMP organization.
  "description": "A String", # Optional. The description of the user group.
  "displayName": "A String", # Optional. The human-readable name for the user group.
  "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
}

  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 user group in a GMP organization.
  "description": "A String", # Optional. The description of the user group.
  "displayName": "A String", # Optional. The human-readable name for the user group.
  "name": "A String", # Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"
}