Accountstatuses

For a list of methods for this resource, see the end of this page.

Resource representations

The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.

JSON

{
  "kind": "content#accountStatus",
  "accountId": string,
  "websiteClaimed": boolean,
  "dataQualityIssues": [
    {
      "id": string,
      "country": string,
      "severity": string,
      "numItems": unsigned integer,
      "lastChecked": string,
      "exampleItems": [
        {
          "itemId": string,
          "title": string,
          "link": string,
          "submittedValue": string,
          "valueOnLandingPage": string
        }
      ],
      "submittedValue": string,
      "displayedValue": string,
      "location": string,
      "detail": string,
      "destination": string
    }
  ],
  "accountLevelIssues": [
    {
      "id": string,
      "title": string,
      "country": string,
      "severity": string,
      "detail": string,
      "destination": string
    }
  ],
  "products": [
    {
      "channel": string,
      "destination": string,
      "country": string,
      "statistics": {
        "active": long,
        "pending": long,
        "disapproved": long,
        "expiring": long
      },
      "itemLevelIssues": [
        {
          "code": string,
          "servability": string,
          "resolution": string,
          "attributeName": string,
          "description": string,
          "detail": string,
          "documentation": string,
          "numItems": long
        }
      ]
    }
  ]
}
Property name Value Description Notes
accountId string The ID of the account for which the status is reported.
accountLevelIssues[] list A list of account level issues.
accountLevelIssues[].country string Country for which this issue is reported.
accountLevelIssues[].destination string The destination the issue applies to.
accountLevelIssues[].detail string Additional details about the issue.
accountLevelIssues[].id string Issue identifier.
accountLevelIssues[].severity string Severity of the issue.

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
accountLevelIssues[].title string Short description of the issue.
dataQualityIssues[] list A list of data quality issues.
dataQualityIssues[].country string Country for which this issue is reported.
dataQualityIssues[].destination string The destination the issue applies to.
dataQualityIssues[].detail string A more detailed description of the issue.
dataQualityIssues[].displayedValue string Actual value displayed on the landing page.
dataQualityIssues[].exampleItems[] list Example items featuring the issue.
dataQualityIssues[].exampleItems[].itemId string Unique item ID as specified in the uploaded product data.
dataQualityIssues[].exampleItems[].submittedValue string The item value that was submitted.
dataQualityIssues[].exampleItems[].title string Title of the item.
dataQualityIssues[].exampleItems[].valueOnLandingPage string The actual value on the landing page.
dataQualityIssues[].id string Issue identifier.
dataQualityIssues[].lastChecked string Last time the account was checked for this issue.
dataQualityIssues[].location string The attribute name that is relevant for the issue.
dataQualityIssues[].numItems unsigned integer Number of items in the account found to have the said issue.
dataQualityIssues[].severity string Severity of the problem.

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
dataQualityIssues[].submittedValue string Submitted value that causes the issue.
kind string Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
products[] list List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
products[].channel string The channel the data applies to.

Acceptable values are:
  • "local"
  • "online"
products[].country string The country the data applies to.
products[].destination string The destination the data applies to.
products[].itemLevelIssues[] list List of item-level issues.
products[].itemLevelIssues[].attributeName string The attribute's name, if the issue is caused by a single attribute.
products[].itemLevelIssues[].code string The error code of the issue.
products[].itemLevelIssues[].description string A short issue description in English.
products[].itemLevelIssues[].detail string A detailed issue description in English.
products[].itemLevelIssues[].documentation string The URL of a web page to help with resolving this issue.
products[].itemLevelIssues[].numItems long Number of items with this issue.
products[].itemLevelIssues[].resolution string Whether the issue can be resolved by the merchant.
products[].itemLevelIssues[].servability string How this issue affects serving of the offer.
products[].statistics nested object Aggregated product statistics.
products[].statistics.active long Number of active offers.
products[].statistics.disapproved long Number of disapproved offers.
products[].statistics.expiring long Number of expiring offers.
products[].statistics.pending long Number of pending offers.
websiteClaimed boolean Whether the account's website is claimed or not.

XML

<account_status>
  <account_id>
    string
  </account_id>
  <website_claimed>
    boolean
  </website_claimed>
  <data_quality_issues>
    (foreach)
      <data_quality_issue id="string" country="string" severity="string" num_items="unsigned integer" last_checked="string" submitted_value="string" displayed_value="string" location="string" detail="string">
        (foreach)
          <example_item>
            <item_id>
              string
            </item_id>
            <title>
              string
            </title>
            <link>
              string
            </link>
            <submitted_value>
              string
            </submitted_value>
            <value_on_landing_page>
              string
            </value_on_landing_page>
          </example_item>
        (/foreach)
      </data_quality_issue>
    (/foreach)
  </data_quality_issues>
  <account_level_issues>
    (foreach)
      <account_level_issue id="string" title="string" country="string" severity="string" detail="string"/>
    (/foreach)
  </account_level_issues>
</account_status>
Property name Value Description Notes
account_status object The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
account_status/account_id string The ID of the account for which the status is reported.
account_status/account_level_issues object
account_status/account_level_issues/account_level_issue object A list of account level issues.
account_status/account_level_issues/account_level_issue/country string Country for which this issue is reported.
account_status/account_level_issues/account_level_issue/detail string Additional details about the issue.
account_status/account_level_issues/account_level_issue/id string Issue identifier.
account_status/account_level_issues/account_level_issue/severity string Severity of the issue.

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
account_status/account_level_issues/account_level_issue/title string Short description of the issue.
account_status/data_quality_issues object
account_status/data_quality_issues/data_quality_issue object A list of data quality issues.
account_status/data_quality_issues/data_quality_issue/country string Country for which this issue is reported.
account_status/data_quality_issues/data_quality_issue/detail string A more detailed description of the issue.
account_status/data_quality_issues/data_quality_issue/displayed_value string Actual value displayed on the landing page.
account_status/data_quality_issues/data_quality_issue/example_item object Example items featuring the issue. An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
account_status/data_quality_issues/data_quality_issue/example_item/item_id string Unique item ID as specified in the uploaded product data.
account_status/data_quality_issues/data_quality_issue/example_item/submitted_value string The item value that was submitted.
account_status/data_quality_issues/data_quality_issue/example_item/title string Title of the item.
account_status/data_quality_issues/data_quality_issue/example_item/value_on_landing_page string The actual value on the landing page.
account_status/data_quality_issues/data_quality_issue/id string Issue identifier.
account_status/data_quality_issues/data_quality_issue/last_checked string Last time the account was checked for this issue.
account_status/data_quality_issues/data_quality_issue/location string The attribute name that is relevant for the issue.
account_status/data_quality_issues/data_quality_issue/num_items unsigned integer Number of items in the account found to have the said issue.
account_status/data_quality_issues/data_quality_issue/severity string Severity of the problem.

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
account_status/data_quality_issues/data_quality_issue/submitted_value string Submitted value that causes the issue.
account_status/website_claimed boolean Whether the account's website is claimed or not.

Methods

custombatch
get
Retrieves the status of a Merchant Center account. Multi-client accounts can only call this method for sub-accounts.
list
Lists the statuses of the sub-accounts in your Merchant Center account.

Send feedback about...

Content API for Shopping