Breakdown

  • This documentation details the structure and fields for representing a breakdown of an issue's impact by region.

  • The breakdown includes a list of regions and a detailed description of the issue's effect on shopping destinations within those regions.

  • Regions are identified by their CLDR territory code and localized name.

  • The impact description provides information about the issue's consequences, such as products not showing in ads or organic search results.

A detailed impact breakdown for a group of regions where the impact of the issue on different shopping destinations is the same.

JSON representation 
{
  "regions": [
    {
      object (Region)
    }
  ],
  "details": [
    string
  ]
}
Fields
regions[]

object (Region)

Lists of regions. Should be rendered as a title for this group of details. The full list should be shown to merchant. If the list is too long, it is recommended to make it expandable.
details[]

string

Human readable, localized description of issue's effect on different targets. Should be rendered as a list.

For example:

  • "Products not showing in ads"
  • "Products not showing organically"

Region

Region with code and localized name.

JSON representation 
{
  "code": string,
  "name": string
}
Fields
code

string

The CLDR territory code
name

string

The localized name of the region. For region with code='001' the value is 'All countries' or the equivalent in other languages.