Content API for Shopping . accounts

Instance Methods

authinfo()

Returns information about the authenticated user.

custombatch(body)

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

delete(merchantId, accountId)

Deletes a Merchant Center sub-account.

get(merchantId, accountId)

Retrieves a Merchant Center account.

insert(merchantId, body)

Creates a Merchant Center sub-account.

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

Lists the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, accountId, body)

Updates a Merchant Center account. This method supports patch semantics.

update(merchantId, accountId, body)

Updates a Merchant Center account.

Method Details

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.
      { # Account identifier 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.
      },
    ],
  }
custombatch(body)
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.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "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.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
                "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.
        "accountId": "A String", # The ID of the account to get or delete. Only defined if the method is get or delete.
      },
    ],
  }


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.
            "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.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
                "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)
Deletes a Merchant Center sub-account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)
get(merchantId, accountId)
Retrieves a Merchant Center 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.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
          "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)
Creates a Merchant Center sub-account.

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.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
        "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.
      },
    ],
  }


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.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
          "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.

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.
            {
              "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
              "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)
Updates a Merchant Center 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.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
        "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.
      },
    ],
  }


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.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
          "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)
Updates a Merchant Center 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.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
        "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.
      },
    ],
  }


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.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account.
          "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.
        },
      ],
    }