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,
      "documentation": 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[].documentation string The URL of a web page to help resolving this 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 DEPRECATED - never populated.
dataQualityIssues[].country string
dataQualityIssues[].destination string
dataQualityIssues[].detail string
dataQualityIssues[].displayedValue string
dataQualityIssues[].exampleItems[] list
dataQualityIssues[].exampleItems[].itemId string
dataQualityIssues[].exampleItems[].submittedValue string
dataQualityIssues[].exampleItems[].title string
dataQualityIssues[].exampleItems[].valueOnLandingPage string
dataQualityIssues[].id string
dataQualityIssues[].lastChecked string
dataQualityIssues[].location string
dataQualityIssues[].numItems unsigned integer
dataQualityIssues[].severity string

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
dataQualityIssues[].submittedValue string
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>
  <products>
    (foreach)
      <product channel="string" destination="string" country="string">
        <statistics>
          <active>
            long
          </active>
          <pending>
            long
          </pending>
          <disapproved>
            long
          </disapproved>
          <expiring>
            long
          </expiring>
        </statistics>
        <item_level_issues>
          (foreach)
            <item_level_issue code="string" servability="string" resolution="string" attribute_name="string" description="string" detail="string" documentation="string" num_items="long"/>
          (/foreach)
        </item_level_issues>
      </product>
    (/foreach)
  </products>
</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 DEPRECATED - never populated.
account_status/data_quality_issues/data_quality_issue/country string
account_status/data_quality_issues/data_quality_issue/detail string
account_status/data_quality_issues/data_quality_issue/displayed_value string
account_status/data_quality_issues/data_quality_issue/example_item object
account_status/data_quality_issues/data_quality_issue/example_item/item_id string
account_status/data_quality_issues/data_quality_issue/example_item/submitted_value string
account_status/data_quality_issues/data_quality_issue/example_item/title string
account_status/data_quality_issues/data_quality_issue/example_item/value_on_landing_page string
account_status/data_quality_issues/data_quality_issue/id string
account_status/data_quality_issues/data_quality_issue/last_checked string
account_status/data_quality_issues/data_quality_issue/location string
account_status/data_quality_issues/data_quality_issue/num_items unsigned integer
account_status/data_quality_issues/data_quality_issue/severity string

Acceptable values are:
  • "critical"
  • "error"
  • "suggestion"
account_status/data_quality_issues/data_quality_issue/submitted_value string
account_status/products object
account_status/products/product object List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
account_status/products/product/channel string The channel the data applies to.

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

Methods

custombatch
Retrieves multiple Merchant Center account statuses in a single request.
get
Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
list
Lists the statuses of the sub-accounts in your Merchant Center account.