authinfo()

Returns information about the authenticated user.

Args:

Returns:
  An object of the form:

    {
    "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
    "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
        # - For an individual account: only the merchant ID is defined
        # - For an aggregator: only the aggregator ID is defined
        # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
      {
        "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
        "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
      },
    ],
  }

claimwebsite(merchantId, accountId, overwrite=None)

Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account whose website is claimed. (required)
  overwrite: boolean, Flag to remove any existing claim on the requested website by another account and replace it with a claim from this account.

Returns:
  An object of the form:

    {
    "kind": "content#accountsClaimWebsiteResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".
  }

custombatch(body, dryRun=None)

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

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

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accounts request.
        "account": { # Account data. # The account to create or update. Only defined if the method is insert or update.
            "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
            "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
            "name": "A String", # Display name for the account.
            "adultContent": True or False, # Indicates whether the merchant sells adult content.
            "id": "A String", # Merchant Center account ID.
            "websiteUrl": "A String", # The merchant's website.
            "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
            "adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the  AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
                "adwordsId": "A String", # Customer ID of the AdWords account.
              },
            ],
            "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
              {
                "admin": True or False, # Whether user is an admin.
                "emailAddress": "A String", # User's email address.
              },
            ],
          },
        "merchantId": "A String", # The ID of the managing account.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "overwrite": True or False, # Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict.
        "accountId": "A String", # The ID of the targeted account. Only defined if the method is get, delete or claimwebsite.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#accountsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accounts response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "account": { # Account data. # The retrieved, created, or updated account. Not defined if the method was delete or claimwebsite.
            "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
            "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
            "name": "A String", # Display name for the account.
            "adultContent": True or False, # Indicates whether the merchant sells adult content.
            "id": "A String", # Merchant Center account ID.
            "websiteUrl": "A String", # The merchant's website.
            "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
            "adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the  AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
                "adwordsId": "A String", # Customer ID of the AdWords account.
              },
            ],
            "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
              {
                "admin": True or False, # Whether user is an admin.
                "emailAddress": "A String", # User's email address.
              },
            ],
          },
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry".
      },
    ],
  }

delete(merchantId, accountId, dryRun=None)

Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)
  dryRun: boolean, Flag to run the request in dry-run mode.

get(merchantId, accountId)

Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.

Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account. (required)

Returns:
An object of the form:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

insert(merchantId, body, dryRun=None)

Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.

Args:
merchantId: string, The ID of the managing account. (required)
body: object, The request body. (required)
The object takes the form of:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
An object of the form:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

list(merchantId, pageToken=None, maxResults=None)

Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.

Args:
merchantId: string, The ID of the managing account. (required)
pageToken: string, The token returned by the previous request.
maxResults: integer, The maximum number of accounts to return in the response, used for paging.

Returns:
An object of the form:

{
"nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
"kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
"resources": [
{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
},
],
}

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(merchantId, accountId, body, dryRun=None)

Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.

Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account. (required)
body: object, The request body. (required)
The object takes the form of:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
An object of the form:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

update(merchantId, accountId, body, dryRun=None)

Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.

Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account. (required)
body: object, The request body. (required)
The object takes the form of:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
An object of the form:

{ # Account data.
"reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
"kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
"name": "A String", # Display name for the account.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"id": "A String", # Merchant Center account ID.
"websiteUrl": "A String", # The merchant's website.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
{
"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
"adwordsId": "A String", # Customer ID of the AdWords account.
},
],
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
},
],
}

Content API for Shopping . accounts

Instance Methods

Method Details