Merchant API . accounts . users

close()

Close httplib2 connections.

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

Creates a Merchant Center account user. Executing this method requires admin access.

Args:
  parent: string, Required. The resource name of the account for which a user will be created. Format: `accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A [user](https://support.google.com/merchants/answer/12160472).
  "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
  "state": "A String", # Output only. The state of the user.
}

  userId: string, Required. The email address of the user (for example, `john.doe@gmail.com`).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A [user](https://support.google.com/merchants/answer/12160472).
  "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
  "state": "A String", # Output only. The state of the user.
}

delete(name, x__xgafv=None)

Deletes a Merchant Center account user. Executing this method requires admin access.

Args:
  name: string, Required. The name of the user to delete. Format: `accounts/{account}/users/{email}` It is also possible to delete the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`. (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)

Retrieves a Merchant Center account user.

Args:
  name: string, Required. The name of the user to retrieve. Format: `accounts/{account}/users/{email}` It is also possible to retrieve the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A [user](https://support.google.com/merchants/answer/12160472).
  "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
  "state": "A String", # Output only. The state of the user.
}

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

Lists all users of a Merchant Center account.

Args:
  parent: string, Required. The parent, which owns this collection of users. Format: `accounts/{account}` (required)
  pageSize: integer, Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
  pageToken: string, Optional. A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUsers` 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 the `ListUsers` method.
  "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.
  "users": [ # The users from the specified account.
    { # A [user](https://support.google.com/merchants/answer/12160472).
      "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
        "A String",
      ],
      "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
      "state": "A String", # Output only. The state of the user.
    },
  ],
}

list_next()

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 Merchant Center account user. Executing this method requires admin access.

Args:
  name: string, Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A [user](https://support.google.com/merchants/answer/12160472).
  "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
  "state": "A String", # Output only. The state of the user.
}

  updateMask: string, Required. List of fields being updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A [user](https://support.google.com/merchants/answer/12160472).
  "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
    "A String",
  ],
  "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
  "state": "A String", # Output only. The state of the user.
}