Method: accounts.reports.search

Retrieves a report defined by a search query. The response might contain fewer rows than specified by pageSize. Rely on nextPageToken to determine if there are more rows to be requested.

HTTP request

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Fields
query

string

Required. Query that defines a report to be retrieved.

For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
pageSize

integer

Optional. Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
pageToken

string

Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from nextPageToken in the previous response should be used.

Response body

Response message for the ReportService.Search method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Fields
results[]

object (ReportRow)

Rows that matched the search query.
nextPageToken

string

Token which can be sent as pageToken to retrieve the next page. If omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

ReportRow

Result row returned from the search query.

Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated.

JSON representation 
{
  "productPerformanceView": {
    object (ProductPerformanceView)
  },
  "nonProductPerformanceView": {
    object (NonProductPerformanceView)
  },
  "productView": {
    object (ProductView)
  },
  "priceCompetitivenessProductView": {
    object (PriceCompetitivenessProductView)
  },
  "priceInsightsProductView": {
    object (PriceInsightsProductView)
  },
  "bestSellersProductClusterView": {
    object (BestSellersProductClusterView)
  },
  "bestSellersBrandView": {
    object (BestSellersBrandView)
  },
  "competitiveVisibilityCompetitorView": {
    object (CompetitiveVisibilityCompetitorView)
  },
  "competitiveVisibilityTopMerchantView": {
    object (CompetitiveVisibilityTopMerchantView)
  },
  "competitiveVisibilityBenchmarkView": {
    object (CompetitiveVisibilityBenchmarkView)
  }
}
Fields
productPerformanceView

object (ProductPerformanceView)

Fields available for query in productPerformanceView table.
nonProductPerformanceView

object (NonProductPerformanceView)

Fields available for query in nonProductPerformanceView table.
productView

object (ProductView)

Fields available for query in productView table.
priceCompetitivenessProductView

object (PriceCompetitivenessProductView)

Fields available for query in priceCompetitivenessProductView table.
priceInsightsProductView

object (PriceInsightsProductView)

Fields available for query in priceInsightsProductView table.
bestSellersProductClusterView

object (BestSellersProductClusterView)

Fields available for query in bestSellersProductClusterView table.
bestSellersBrandView

object (BestSellersBrandView)

Fields available for query in bestSellersBrandView table.
competitiveVisibilityCompetitorView

object (CompetitiveVisibilityCompetitorView)

Fields available for query in competitiveVisibilityCompetitorView table.
competitiveVisibilityTopMerchantView

object (CompetitiveVisibilityTopMerchantView)

Fields available for query in competitiveVisibilityTopMerchantView table.
competitiveVisibilityBenchmarkView

object (CompetitiveVisibilityBenchmarkView)

Fields available for query in competitiveVisibilityBenchmarkView table.

ProductPerformanceView

Fields available for query in productPerformanceView table.

Product performance data for your account, including performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, offerId). Values of product dimensions, such as offerId, reflect the state of a product at the time of the impression.

Segment fields cannot be selected in queries without also selecting at least one metric field.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "conversionValue": {
    object (Price)
  },
  "marketingMethod": enum (MarketingMethodEnum),
  "customerCountryCode": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number,
  "conversions": number,
  "conversionRate": number
}
Fields
date

object (Date)

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.
week

object (Date)

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.
conversionValue

object (Price)

Value of conversions attributed to the product, reported on the conversion date. Metric.

Available only for the FREE traffic source.
marketingMethod

enum (MarketingMethodEnum)

Marketing method to which metrics apply. Segment.
customerCountryCode

string

Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment.

If the customer country cannot be determined, a special 'ZZ' code is returned.
offerId

string

Merchant-provided id of the product. Segment.
title

string

Title of the product. Segment.
brand

string

Brand of the product. Segment.
categoryL1

string

Product category (1st level) in Google's product taxonomy. Segment.
categoryL2

string

Product category (2nd level) in Google's product taxonomy. Segment.
categoryL3

string

Product category (3rd level) in Google's product taxonomy. Segment.
categoryL4

string

Product category (4th level) in Google's product taxonomy. Segment.
categoryL5

string

Product category (5th level) in Google's product taxonomy. Segment.
productTypeL1

string

Product type (1st level) in merchant's own product taxonomy. Segment.
productTypeL2

string

Product type (2nd level) in merchant's own product taxonomy. Segment.
productTypeL3

string

Product type (3rd level) in merchant's own product taxonomy. Segment.
productTypeL4

string

Product type (4th level) in merchant's own product taxonomy. Segment.
productTypeL5

string

Product type (5th level) in merchant's own product taxonomy. Segment.
customLabel0

string

Custom label 0 for custom grouping of products. Segment.
customLabel1

string

Custom label 1 for custom grouping of products. Segment.
customLabel2

string

Custom label 2 for custom grouping of products. Segment.
customLabel3

string

Custom label 3 for custom grouping of products. Segment.
customLabel4

string

Custom label 4 for custom grouping of products. Segment.
clicks

string (int64 format)

Number of clicks. Metric.
impressions

string (int64 format)

Number of times merchant's products are shown. Metric.
clickThroughRate

number

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.
conversions

number

Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. Metric.

Available only for the FREE traffic source.
conversionRate

number

Number of conversions divided by the number of clicks, reported on the impression date. Metric.

Available only for the FREE traffic source.

MarketingMethodEnum

Marketing method values.

Enums
MARKETING_METHOD_ENUM_UNSPECIFIED Not specified.
ORGANIC Organic marketing.
ADS Ads-based marketing.

NonProductPerformanceView

Fields available for query in nonProductPerformanceView table.

Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, date).

Segment fields cannot be selected in queries without also selecting at least one metric field.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "clicks": string,
  "impressions": string,
  "clickThroughRate": number
}
Fields
date

object (Date)

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.
week

object (Date)

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.
clicks

string (int64 format)

Number of clicks on images and online store links leading to your non-product pages. Metric.
impressions

string (int64 format)

Number of times images and online store links leading to your non-product pages were shown. Metric.
clickThroughRate

number

Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and online store links leading to your non-product pages. Metric.

ProductView

Fields available for query in productView table.

Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by id or list all products, Products sub-API should be used.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "price": {
    object (Price)
  },
  "gtin": [
    string
  ],
  "creationTime": string,
  "expirationDate": {
    object (Date)
  },
  "itemIssues": [
    {
      object (ItemIssue)
    }
  ],
  "clickPotential": enum (ClickPotential),
  "id": string,
  "channel": enum (ChannelEnum),
  "languageCode": string,
  "feedLabel": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "condition": string,
  "availability": string,
  "shippingLabel": string,
  "itemGroupId": string,
  "thumbnailLink": string,
  "aggregatedReportingContextStatus": enum (AggregatedReportingContextStatus),
  "clickPotentialRank": string
}
Fields
price

object (Price)

Product price. Absent if the information about the price of the product is not available.
gtin[]

string

List of Global Trade Item Numbers (GTINs) of the product.
creationTime

string (Timestamp format)

The time the merchant created the product in timestamp seconds.
expirationDate

object (Date)

Expiration date for the product, specified on insertion.
itemIssues[]

object (ItemIssue)

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, itemIssues.severity.aggregated_severity) can be used for filtering the results.
clickPotential

enum (ClickPotential)

Estimated performance potential compared to highest performing products of the merchant.
id

string

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Merchant API methods that operate on products take this as their name parameter.

Required in the SELECT clause.
channel

enum (ChannelEnum)

Channel of the product. Can be ONLINE or LOCAL.
languageCode

string

Language code of the product in BCP 47 format.
feedLabel

string

Feed label of the product.
offerId

string

Merchant-provided id of the product.
title

string

Title of the product.
brand

string

Brand of the product.
categoryL1

string

Product category (1st level) in Google's product taxonomy.
categoryL2

string

Product category (2nd level) in Google's product taxonomy.
categoryL3

string

Product category (3rd level) in Google's product taxonomy.
categoryL4

string

Product category (4th level) in Google's product taxonomy.
categoryL5

string

Product category (5th level) in Google's product taxonomy.
productTypeL1

string

Product type (1st level) in merchant's own product taxonomy.
productTypeL2

string

Product type (2nd level) in merchant's own product taxonomy.
productTypeL3

string

Product type (3rd level) in merchant's own product taxonomy.
productTypeL4

string

Product type (4th level) in merchant's own product taxonomy.
productTypeL5

string

Product type (5th level) in merchant's own product taxonomy.
condition

string

Condition of the product.
availability

string

Availability of the product.
shippingLabel

string

Normalized shipping label specified in the data source.
itemGroupId

string

Item group id provided by the merchant for grouping variants together.
aggregatedReportingContextStatus

enum (AggregatedReportingContextStatus)

Aggregated status.
clickPotentialRank

string (int64 format)

Rank of the product based on its click potential. A product with clickPotentialRank 1 has the highest click potential among the merchant's products that fulfill the search query conditions.

AggregatedReportingContextStatus

Status of the product aggregated for all reporting contexts.

Here's an example of how the aggregated status is computed:

Free listings Shopping ads Status
Approved Approved ELIGIBLE
Approved Pending ELIGIBLE
Approved Disapproved ELIGIBLE_LIMITED
Pending Pending PENDING
Disapproved Disapproved NOT_ELIGIBLE_OR_DISAPPROVED
Enums
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED Not specified.
NOT_ELIGIBLE_OR_DISAPPROVED Product is not eligible or is disapproved for all reporting contexts.
PENDING Product's status is pending in all reporting contexts.
ELIGIBLE_LIMITED Product is eligible for some (but not all) reporting contexts.
ELIGIBLE Product is eligible for all reporting contexts.

ItemIssue

Item issue associated with the product.

JSON representation 
{
  "type": {
    object (ItemIssueType)
  },
  "severity": {
    object (ItemIssueSeverity)
  },
  "resolution": enum (ItemIssueResolution)
}
Fields
type

object (ItemIssueType)

Item issue type.
severity

object (ItemIssueSeverity)

Item issue severity.
resolution

enum (ItemIssueResolution)

Item issue resolution.

ItemIssueType

Issue type.

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

string

Error code of the issue, equivalent to the code of Product issues.
canonicalAttribute

string

Canonical attribute name for attribute-specific issues.

ItemIssueSeverity

How the issue affects the serving of the product.

JSON representation 
{
  "severityPerReportingContext": [
    {
      object (IssueSeverityPerReportingContext)
    }
  ],
  "aggregatedSeverity": enum (AggregatedIssueSeverity)
}
Fields
severityPerReportingContext[]

object (IssueSeverityPerReportingContext)

Issue severity per reporting context.
aggregatedSeverity

enum (AggregatedIssueSeverity)

Aggregated severity of the issue for all reporting contexts it affects.

This field can be used for filtering the results.

IssueSeverityPerReportingContext

Issue severity per reporting context.

JSON representation 
{
  "disapprovedCountries": [
    string
  ],
  "demotedCountries": [
    string
  ],
  "reportingContext": enum (ReportingContextEnum)
}
Fields
disapprovedCountries[]

string

List of disapproved countries in the reporting context, represented in ISO 3166 format.
demotedCountries[]

string

List of demoted countries in the reporting context, represented in ISO 3166 format.
reportingContext

enum (ReportingContextEnum)

Reporting context the issue applies to.

AggregatedIssueSeverity

Issue severity aggregated for all reporting contexts.

Enums
AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED Not specified.
DISAPPROVED Issue disapproves the product in at least one reporting context.
DEMOTED Issue demotes the product in all reporting contexts it affects.
PENDING Issue resolution is PENDING_PROCESSING.

ItemIssueResolution

How to resolve the issue.

Enums
ITEM_ISSUE_RESOLUTION_UNSPECIFIED Not specified.
MERCHANT_ACTION The merchant has to fix the issue.
PENDING_PROCESSING The issue will be resolved automatically (for example, image crawl) or through a Google review. No merchant action is required now. Resolution might lead to another issue (for example, if crawl fails).

ClickPotential

A product's click potential estimates its performance potential compared to highest performing products of the merchant. Click potential of a product helps merchants to prioritize which products to fix and helps them understand how products are performing against their potential.

Enums
CLICK_POTENTIAL_UNSPECIFIED Unknown predicted clicks impact.
LOW Potential to receive a low number of clicks compared to the highest performing products of the merchant.
MEDIUM Potential to receive a moderate number of clicks compared to the highest performing products of the merchant.
HIGH Potential to receive a similar number of clicks as the highest performing products of the merchant.

PriceCompetitivenessProductView

Fields available for query in priceCompetitivenessProductView table.

Price competitiveness report.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "price": {
    object (Price)
  },
  "benchmarkPrice": {
    object (Price)
  },
  "reportCountryCode": string,
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string
}
Fields
price

object (Price)

Current price of the product.
benchmarkPrice

object (Price)

Latest available price benchmark for the product's catalog in the benchmark country.
reportCountryCode

string

Country of the price benchmark. Represented in the ISO 3166 format.

Required in the SELECT clause.
id

string

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the productView table.

Required in the SELECT clause.
offerId

string

Merchant-provided id of the product.
title

string

Title of the product.
brand

string

Brand of the product.
categoryL1

string

Product category (1st level) in Google's product taxonomy.
categoryL2

string

Product category (2nd level) in Google's product taxonomy.
categoryL3

string

Product category (3rd level) in Google's product taxonomy.
categoryL4

string

Product category (4th level) in Google's product taxonomy.
categoryL5

string

Product category (5th level) in Google's product taxonomy.
productTypeL1

string

Product type (1st level) in merchant's own product taxonomy.
productTypeL2

string

Product type (2nd level) in merchant's own product taxonomy.
productTypeL3

string

Product type (3rd level) in merchant's own product taxonomy.
productTypeL4

string

Product type (4th level) in merchant's own product taxonomy.
productTypeL5

string

Product type (5th level) in merchant's own product taxonomy.

PriceInsightsProductView

Fields available for query in priceInsightsProductView table.

Price insights report.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "price": {
    object (Price)
  },
  "suggestedPrice": {
    object (Price)
  },
  "effectiveness": enum (Effectiveness),
  "id": string,
  "offerId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "predictedImpressionsChangeFraction": number,
  "predictedClicksChangeFraction": number,
  "predictedConversionsChangeFraction": number
}
Fields
price

object (Price)

Current price of the product.
suggestedPrice

object (Price)

Latest suggested price for the product.
effectiveness

enum (Effectiveness)

The predicted effectiveness of applying the price suggestion, bucketed.
id

string

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the productView table.

Required in the SELECT clause.
offerId

string

Merchant-provided id of the product.
title

string

Title of the product.
brand

string

Brand of the product.
categoryL1

string

Product category (1st level) in Google's product taxonomy.
categoryL2

string

Product category (2nd level) in Google's product taxonomy.
categoryL3

string

Product category (3rd level) in Google's product taxonomy.
categoryL4

string

Product category (4th level) in Google's product taxonomy.
categoryL5

string

Product category (5th level) in Google's product taxonomy.
productTypeL1

string

Product type (1st level) in merchant's own product taxonomy.
productTypeL2

string

Product type (2nd level) in merchant's own product taxonomy.
productTypeL3

string

Product type (3rd level) in merchant's own product taxonomy.
productTypeL4

string

Product type (4th level) in merchant's own product taxonomy.
productTypeL5

string

Product type (5th level) in merchant's own product taxonomy.
predictedImpressionsChangeFraction

number

Predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.
predictedClicksChangeFraction

number

Predicted change in clicks as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in clicks.
predictedConversionsChangeFraction

number

Predicted change in conversions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).

Effectiveness

Predicted effectiveness bucket.

Effectiveness indicates which products would benefit most from price changes. This rating takes into consideration the performance boost predicted by adjusting the sale price and the difference between your current price and the suggested price. Price suggestions with HIGH effectiveness are predicted to drive the largest increase in performance.

Enums
EFFECTIVENESS_UNSPECIFIED Effectiveness is unknown.
LOW Effectiveness is low.
MEDIUM Effectiveness is medium.
HIGH Effectiveness is high.

BestSellersProductClusterView

Fields available for query in bestSellersProductClusterView table.

Best sellers report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "reportDate": {
    object (Date)
  },
  "variantGtins": [
    string
  ],
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "inventoryStatus": enum (InventoryStatus),
  "brandInventoryStatus": enum (InventoryStatus),
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
Fields
reportDate

object (Date)

Report date. The value of this field can only be one of the following:

  • The first day of the week (Monday) for weekly reports,
  • The first day of the month for monthly reports.

Required in the SELECT clause. If a WHERE condition on reportDate is not specified in the query, the latest available weekly or monthly report is returned.
variantGtins[]

string

GTINs of example variants of the product cluster.
reportGranularity

enum (ReportGranularityEnum)

Granularity of the report. The ranking can be done over a week or a month timeframe.

Required in the SELECT clause. Condition on reportGranularity is required in the WHERE clause.
reportCountryCode

string

Country where the ranking is calculated. Represented in the ISO 3166 format.

Required in the SELECT clause. Condition on reportCountryCode is required in the WHERE clause.
reportCategoryId

string (int64 format)

Google product category ID to calculate the ranking for, represented in Google's product taxonomy.

Required in the SELECT clause. If a WHERE condition on reportCategoryId is not specified in the query, rankings for all top-level categories are returned.
title

string

Title of the product cluster.
brand

string

Brand of the product cluster.
categoryL1

string

Product category (1st level) of the product cluster, represented in Google's product taxonomy.
categoryL2

string

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
categoryL3

string

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
categoryL4

string

Product category (4th level) of the product cluster, represented in Google's product taxonomy.
categoryL5

string

Product category (5th level) of the product cluster, represented in Google's product taxonomy.
inventoryStatus

enum (InventoryStatus)

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source in all countries, or NOT_IN_INVENTORY at all.

The field doesn't take the Best sellers report country filter into account.
brandInventoryStatus

enum (InventoryStatus)

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source in all countries, or NOT_IN_INVENTORY.

The field doesn't take the Best sellers report country filter into account.
rank

string (int64 format)

Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
previousRank

string (int64 format)

Popularity rank in the previous week or month.
relativeDemand

enum (RelativeDemandEnum)

Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.
previousRelativeDemand

enum (RelativeDemandEnum)

Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.
relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

Change in the estimated demand. Whether it rose, sank or remained flat.

ReportGranularityEnum

Report granularity values.

Enums
REPORT_GRANULARITY_ENUM_UNSPECIFIED Not specified.
WEEKLY Report is computed over a week timeframe.
MONTHLY Report is computed over a month timeframe.

InventoryStatus

Status of the product cluster or brand in your inventory.

Enums
INVENTORY_STATUS_UNSPECIFIED Not specified.
IN_STOCK You have a product for this product cluster or brand in stock.
OUT_OF_STOCK You have a product for this product cluster or brand in inventory but it is currently out of stock.
NOT_IN_INVENTORY You do not have a product for this product cluster or brand in inventory.

RelativeDemandEnum

Relative demand values.

Enums
RELATIVE_DEMAND_ENUM_UNSPECIFIED Not specified.
VERY_LOW Demand is 0-5% of the demand of the highest ranked product cluster or brand.
LOW Demand is 6-10% of the demand of the highest ranked product cluster or brand.
MEDIUM Demand is 11-20% of the demand of the highest ranked product cluster or brand.
HIGH Demand is 21-50% of the demand of the highest ranked product cluster or brand.
VERY_HIGH Demand is 51-100% of the demand of the highest ranked product cluster or brand.

RelativeDemandChangeTypeEnum

Relative demand change type values.

Enums
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED Not specified.
SINKER Relative demand is lower than the previous time period.
FLAT Relative demand is equal to the previous time period.
RISER Relative demand is higher than the previous time period.

BestSellersBrandView

Fields available for query in bestSellersBrandView table.

Best sellers report with top brands.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "reportDate": {
    object (Date)
  },
  "reportGranularity": enum (ReportGranularityEnum),
  "reportCountryCode": string,
  "reportCategoryId": string,
  "brand": string,
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemandEnum),
  "previousRelativeDemand": enum (RelativeDemandEnum),
  "relativeDemandChange": enum (RelativeDemandChangeTypeEnum)
}
Fields
reportDate

object (Date)

Report date. The value of this field can only be one of the following:

  • The first day of the week (Monday) for weekly reports,
  • The first day of the month for monthly reports.

Required in the SELECT clause. If a WHERE condition on reportDate is not specified in the query, the latest available weekly or monthly report is returned.
reportGranularity

enum (ReportGranularityEnum)

Granularity of the report. The ranking can be done over a week or a month timeframe.

Required in the SELECT clause. Condition on reportGranularity is required in the WHERE clause.
reportCountryCode

string

Country where the ranking is calculated. Represented in the ISO 3166 format.

Required in the SELECT clause. Condition on reportCountryCode is required in the WHERE clause.
reportCategoryId

string (int64 format)

Google product category ID to calculate the ranking for, represented in Google's product taxonomy.

Required in the SELECT clause. If a WHERE condition on reportCategoryId is not specified in the query, rankings for all top-level categories are returned.
brand

string

Name of the brand.
rank

string (int64 format)

Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
previousRank

string (int64 format)

Popularity rank in the previous week or month.
relativeDemand

enum (RelativeDemandEnum)

Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
previousRelativeDemand

enum (RelativeDemandEnum)

Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
relativeDemandChange

enum (RelativeDemandChangeTypeEnum)

Change in the estimated demand. Whether it rose, sank or remained flat.

CompetitiveVisibilityCompetitorView

Fields available for query in competitiveVisibilityCompetitorView table.

Competitive visibility report with businesses with similar visibility.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number,
  "relativeVisibility": number
}
Fields
date

object (Date)

Date of this row.

A condition on date is required in the WHERE clause.
domain

string

Domain of your competitor or your domain, if 'isYourDomain' is true.

Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.
isYourDomain

boolean

True if this row contains data for your domain.

Cannot be filtered on in the 'WHERE' clause.
reportCountryCode

string

Country where impressions appeared.

Required in the SELECT clause. A condition on reportCountryCode is required in the WHERE clause.
reportCategoryId

string (int64 format)

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on reportCategoryId is required in the WHERE clause.
trafficSource

enum (TrafficSourceEnum)

Traffic source of impressions.

Required in the SELECT clause.
rank

string (int64 format)

Position of the domain in the similar businesses ranking for the selected keys (date, reportCategoryId, reportCountryCode, trafficSource) based on impressions. 1 is the highest.

Cannot be filtered on in the 'WHERE' clause.
adsOrganicRatio

number

Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.

Cannot be filtered on in the 'WHERE' clause.
pageOverlapRate

number

Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.

Cannot be filtered on in the 'WHERE' clause.
higherPositionRate

number

Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.

Cannot be filtered on in the 'WHERE' clause.
relativeVisibility

number

Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country.

Cannot be filtered on in the 'WHERE' clause.

TrafficSourceEnum

Traffic source values.

Enums
TRAFFIC_SOURCE_ENUM_UNSPECIFIED Not specified.
ORGANIC Organic traffic.
ADS Traffic from ads.
ALL Organic and ads traffic.

CompetitiveVisibilityTopMerchantView

Fields available for query in competitiveVisibilityTopMerchantView table.

Competitive visibility report with business with highest visibility.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "date": {
    object (Date)
  },
  "domain": string,
  "isYourDomain": boolean,
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "rank": string,
  "adsOrganicRatio": number,
  "pageOverlapRate": number,
  "higherPositionRate": number
}
Fields
date

object (Date)

Date of this row.

Cannot be selected in the SELECT clause. A condition on date is required in the WHERE clause.
domain

string

Domain of your competitor or your domain, if 'isYourDomain' is true.

Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.
isYourDomain

boolean

True if this row contains data for your domain.

Cannot be filtered on in the 'WHERE' clause.
reportCountryCode

string

Country where impressions appeared.

Required in the SELECT clause. A condition on reportCountryCode is required in the WHERE clause.
reportCategoryId

string (int64 format)

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on reportCategoryId is required in the WHERE clause.
trafficSource

enum (TrafficSourceEnum)

Traffic source of impressions.

Required in the SELECT clause.
rank

string (int64 format)

Position of the domain in the top merchants ranking for the selected keys (date, reportCategoryId, reportCountryCode, trafficSource) based on impressions. 1 is the highest.

Cannot be filtered on in the 'WHERE' clause.
adsOrganicRatio

number

Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.

Cannot be filtered on in the 'WHERE' clause.
pageOverlapRate

number

Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.

Cannot be filtered on in the 'WHERE' clause.
higherPositionRate

number

Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.

Cannot be filtered on in the 'WHERE' clause.

CompetitiveVisibilityBenchmarkView

Fields available for query in competitiveVisibilityBenchmarkView table.

Competitive visibility report with the category benchmark.

Values are only set for fields requested explicitly in the request's search query.

JSON representation 
{
  "date": {
    object (Date)
  },
  "reportCountryCode": string,
  "reportCategoryId": string,
  "trafficSource": enum (TrafficSourceEnum),
  "yourDomainVisibilityTrend": number,
  "categoryBenchmarkVisibilityTrend": number
}
Fields
date

object (Date)

Date of this row.

Required in the SELECT clause. A condition on date is required in the WHERE clause.
reportCountryCode

string

Country where impressions appeared.

Required in the SELECT clause. A condition on reportCountryCode is required in the WHERE clause.
reportCategoryId

string (int64 format)

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on reportCategoryId is required in the WHERE clause.
trafficSource

enum (TrafficSourceEnum)

Traffic source of impressions.

Required in the SELECT clause.
yourDomainVisibilityTrend

number

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.
categoryBenchmarkVisibilityTrend

number

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.