Merchant API . accounts

close()

Close httplib2 connections.

createAndConfigure(body=None, x__xgafv=None)

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `CreateAndConfigureAccount` method.
  "acceptTermsOfService": { # Reference to a Terms of Service resource. # Optional. The Terms of Service (ToS) to be accepted immediately upon account creation.
    "name": "A String", # Required. The resource name of the terms of service version.
    "regionCode": "A String", # Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or `001` when it applies globally.
  },
  "account": { # An account. # Required. The account to be created.
    "accountId": "A String", # Output only. The ID of the account.
    "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
    "adultContent": True or False, # Whether this account contains adult content.
    "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
    "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
    "testAccount": True or False, # Output only. Whether this is a test account.
    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
    },
  },
  "service": [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service.
    { # Additional instructions to add account services during creation of the account.
      "accountAggregation": { # 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); } # The provider is an aggregator for the account.
      },
      "provider": "A String", # Optional. The provider of the service. Format: `accounts/{account}`
    },
  ],
  "users": [ # Optional. Users to be added to the account.
    { # Request message for the `CreateUser` method.
      "parent": "A String", # Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
      "user": { # A [user](https://support.google.com/merchants/answer/12160472). # Required. The user to create.
        "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": "A 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:

    { # An account.
  "accountId": "A String", # Output only. The ID of the account.
  "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
  "adultContent": True or False, # Whether this account contains adult content.
  "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
  "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
  "testAccount": True or False, # Output only. Whether this is a test account.
  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
  },
}

delete(name, x__xgafv=None)

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.

Args:
  name: string, Required. The name of the account to delete. Format: `accounts/{account}` (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 an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

Args:
  name: string, Required. The name of the account to retrieve. Format: `accounts/{account}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An account.
  "accountId": "A String", # Output only. The ID of the account.
  "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
  "adultContent": True or False, # Whether this account contains adult content.
  "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
  "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
  "testAccount": True or False, # Output only. Whether this is a test account.
  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
  },
}

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

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.

Args:
  filter: string, Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
  pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` 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 `ListAccounts` method.
  "accounts": [ # The accounts matching the `ListAccountsRequest`.
    { # An account.
      "accountId": "A String", # Output only. The ID of the account.
      "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
      "adultContent": True or False, # Whether this account contains adult content.
      "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
      "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
      "testAccount": True or False, # Output only. Whether this is a test account.
      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
      },
    },
  ],
  "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.
}

listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`

Args:
  provider: string, Required. The parent account. Format: `accounts/{account}` (required)
  pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` 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 `ListSubAccounts` method.
  "accounts": [ # The accounts for which the given parent account is an aggregator.
    { # An account.
      "accountId": "A String", # Output only. The ID of the account.
      "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
      "adultContent": True or False, # Whether this account contains adult content.
      "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
      "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
      "testAccount": True or False, # Output only. Whether this is a test account.
      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
      },
    },
  ],
  "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.
}

listSubaccounts_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.
        

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 an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.

Args:
  name: string, Identifier. The resource name of the account. Format: `accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # An account.
  "accountId": "A String", # Output only. The ID of the account.
  "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
  "adultContent": True or False, # Whether this account contains adult content.
  "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
  "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
  "testAccount": True or False, # Output only. Whether this is a test account.
  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
  },
}

  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:

    { # An account.
  "accountId": "A String", # Output only. The ID of the account.
  "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information.
  "adultContent": True or False, # Whether this account contains adult content.
  "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
  "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}`
  "testAccount": True or False, # Output only. Whether this is a test account.
  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
  },
}