Method: reports.search

string (int64 format)

Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

{
  "segments": {
    object (Segments)
  },
  "metrics": {
    object (Metrics)
  },
  "productView": {
    object (ProductView)
  },
  "productCluster": {
    object (ProductCluster)
  },
  "brand": {
    object (Brand)
  },
  "bestSellers": {
    object (BestSellers)
  },
  "priceCompetitiveness": {
    object (PriceCompetitiveness)
  },
  "priceInsights": {
    object (PriceInsights)
  }
}

object (Segments)

Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.

object (Metrics)

Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.

object (ProductView)

Product fields requested by the merchant in the query. Field values are only set if the merchant queries ProductView. Available only to selected merchants. Submit the interest form to request access.

object (ProductCluster)

Product cluster fields requested by the merchant in the query. Field values are only set if the merchant queries BestSellersProductClusterView.

object (Brand)

Brand fields requested by the merchant in the query. Field values are only set if the merchant queries BestSellersBrandView.

object (BestSellers)

Best Sellers fields requested by the merchant in the query. Field values are only set if the merchant queries BestSellersProductClusterView or BestSellersBrandView.

object (PriceCompetitiveness)

Price Competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries PriceCompetitivenessProductView.

object (PriceInsights)

Price Insights fields requested by the merchant in the query. Field values are only set if the merchant queries PriceInsightsProductView.

{
  "program": enum (Program),
  "date": {
    object (Date)
  },
  "week": {
    object (Date)
  },
  "customerCountryCode": string,
  "currencyCode": 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
}

enum (Program)

Program to which metrics apply, for example, Free Product Listing.

object (Date)

Date in the merchant timezone to which metrics apply.

object (Date)

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

string

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

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

string

Currency in which price metrics are represented, for example, if you select orderedItemSalesMicros, the returned value will be represented by this currency.

string

Merchant-provided id of the product.

string

Title of the product.

string

Brand of the product.

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

Custom label 0 for custom grouping of products.

string

Custom label 1 for custom grouping of products.

string

Custom label 2 for custom grouping of products.

string

Custom label 3 for custom grouping of products.

string

Custom label 4 for custom grouping of products.

{
  "clicks": string,
  "impressions": string,
  "ctr": number,
  "conversions": number,
  "conversionValueMicros": string,
  "conversionRate": number,
  "orders": string,
  "shippedOrders": string,
  "unshippedOrders": number,
  "daysToShip": number,
  "aos": number,
  "aovMicros": number,
  "orderedItems": string,
  "orderedItemSalesMicros": string,
  "shippedItems": string,
  "unshippedItems": number,
  "shippedItemSalesMicros": string,
  "rejectedItems": string,
  "itemDaysToShip": number,
  "itemFillRate": number,
  "returnedItems": string,
  "returnsMicros": string,
  "returnRate": number
}

string (Int64Value format)

Number of clicks.

string (Int64Value format)

Number of times merchant's products are shown.

number

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

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.

The metric is currently available only for the FREE_PRODUCT_LISTING program.

string (Int64Value format)

Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date.

The metric is currently available only for the FREE_PRODUCT_LISTING program.

The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

number

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

The metric is currently available only for the FREE_PRODUCT_LISTING program.

string (Int64Value format)

Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order.

This metric cannot be segmented by product dimensions and customerCountryCode.

string (Int64Value format)

Number of fully shipped orders, reported on the last shipment date.

This metric cannot be segmented by product dimensions and customerCountryCode.

number

Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period.

This metric cannot be segmented by product dimensions and customerCountryCode.

number

Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date.

This metric cannot be segmented by product dimensions and customerCountryCode.

number

Average order size - the average number of items in an order.

This metric cannot be segmented by product dimensions and customerCountryCode.

number

Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders.

The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

This metric cannot be segmented by product dimensions and customerCountryCode.

string (Int64Value format)

Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order.

The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Number of shipped items, reported on the shipment date.

This metric cannot be segmented by customerCountryCode.

number

Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only).

The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Number of ordered items canceled by the merchant, reported on the order date.

This metric cannot be segmented by customerCountryCode.

number

Average number of days between an item being ordered and the item being

This metric cannot be segmented by customerCountryCode.

number

Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Number of ordered items sent back for return, reported on the date when the merchant accepted the return.

This metric cannot be segmented by customerCountryCode.

string (Int64Value format)

Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return.

The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

This metric cannot be segmented by customerCountryCode.

number

Total price of returned items divided by the total price of shipped items, reported on the order date.

If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response.

This metric cannot be segmented by customerCountryCode.

{
  "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,
  "currencyCode": string,
  "priceMicros": string,
  "languageCode": string,
  "condition": string,
  "channel": enum (Channel),
  "availability": string,
  "shippingLabel": string,
  "gtin": [
    string
  ],
  "itemGroupId": string,
  "creationTime": string,
  "expirationDate": {
    object (Date)
  },
  "aggregatedDestinationStatus": enum (AggregatedDestinationStatus),
  "itemIssues": [
    {
      object (ItemIssue)
    }
  ]
}

string

The REST ID of the product, in the form of channel:contentLanguage:targetCountry:offerId. Content API methods that operate on products take this as their productId parameter.

Should always be included in the SELECT clause.

string

Merchant-provided id of the product.

string

Title of the product.

string

Brand of the product.

string

First level of the product category in Google's product taxonomy.

string

Second level of the product category in Google's product taxonomy.

string

Third level of the product category in Google's product taxonomy.

string

Fourth level of the product category in Google's product taxonomy.

string

Fifth level of the product category in Google's product taxonomy.

string

First level of the product type in merchant's own product taxonomy.

string

Second level of the product type in merchant's own product taxonomy.

string

Third level of the product type in merchant's own product taxonomy.

string

Fourth level of the product type in merchant's own product taxonomy.

string

Fifth level of the product type in merchant's own product taxonomy.

string

Product price currency code (for example, ISO 4217). Absent if product price is not available.

string (Int64Value format)

Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available.

string

Language code of the product in BCP 47 format.

string

Condition of the product.

enum (Channel)

Channel of the product (online versus local).

string

Availability of the product.

string

The normalized shipping label specified in the feed

string

GTIN of the product.

string

Item group ID provided by the merchant for grouping variants together.

string (Timestamp format)

The time the merchant created the product in timestamp seconds.

object (Date)

Expiration date for the product. Specified on insertion.

enum (AggregatedDestinationStatus)

Aggregated destination status.

object (ItemIssue)

accounts.list of item issues for the product.

{

  // Union field _issue_type can be only one of the following:
  "issueType": {
    object (ItemIssueType)
  }
  // End of list of possible types for union field _issue_type.

  // Union field _severity can be only one of the following:
  "severity": {
    object (ItemIssueSeverity)
  }
  // End of list of possible types for union field _severity.

  // Union field _resolution can be only one of the following:
  "resolution": enum (IssueResolution)
  // End of list of possible types for union field _resolution.
}

object (ItemIssueType)

Item issue type.

object (ItemIssueSeverity)

Item issue severity.

enum (IssueResolution)

Item issue resolution.

{

  // Union field _canonical_attribute can be only one of the following:
  "canonicalAttribute": string
  // End of list of possible types for union field _canonical_attribute.
}

string

Canonical attribute name for attribute-specific issues.

{
  "severityPerDestination": [
    {
      object (IssueSeverityPerDestination)
    }
  ],

  // Union field _aggregated_severity can be only one of the following:
  "aggregatedSeverity": enum (AggregatedIssueSeverity)
  // End of list of possible types for union field _aggregated_severity.
}

object (IssueSeverityPerDestination)

Item issue severity for every destination.

enum (AggregatedIssueSeverity)

Severity of an issue aggregated for destination.

{
  "disapprovedCountries": [
    string
  ],
  "demotedCountries": [
    string
  ],

  // Union field _destination can be only one of the following:
  "destination": string
  // End of list of possible types for union field _destination.
}

string

accounts.list of disapproved countries in the destination.

string

accounts.list of demoted countries in the destination.

string

Issue destination.

{
  "title": string,
  "brand": string,
  "categoryL1": string,
  "categoryL2": string,
  "categoryL3": string,
  "categoryL4": string,
  "categoryL5": string,
  "variantGtins": [
    string
  ],
  "inventoryStatus": enum (InventoryStatus),
  "brandInventoryStatus": enum (InventoryStatus)
}

string

Title of the product cluster.

string

Brand of the product cluster.

string

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

string

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

string

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

string

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

string

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

string

GTINs of example variants of the product cluster.

enum (InventoryStatus)

Tells whether the product cluster is IN_STOCK in your product feed across multiple countries, OUT_OF_STOCK in your product feed, or NOT_IN_INVENTORY at all. The field doesn't take the Best Sellers report country filter into account.

enum (InventoryStatus)

Tells if there is at least one product of the brand currently IN_STOCK in your product feed across multiple countries, all products are OUT_OF_STOCK in your product feed, or NOT_IN_INVENTORY. The field doesn't take the Best Sellers report country filter into account.

{
  "name": string
}

string

Name of the brand.

{
  "reportDate": {
    object (Date)
  },
  "reportGranularity": enum (ReportGranularity),
  "countryCode": string,
  "categoryId": string,
  "rank": string,
  "previousRank": string,
  "relativeDemand": enum (RelativeDemand),
  "previousRelativeDemand": enum (RelativeDemand),
  "relativeDemandChange": enum (RelativeDemandChangeType)
}

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.

If a WHERE condition on bestSellers.report_date is not specified in the query, the latest available weekly or monthly report is returned.

enum (ReportGranularity)

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

A WHERE condition on bestSellers.report_granularity is required in the query.

string

Country where the ranking is calculated.

A WHERE condition on bestSellers.country_code is required in the query.

string (Int64Value format)

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

If a WHERE condition on bestSellers.category_id is not specified in the query, rankings for all top-level categories are returned.

string (Int64Value format)

Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold.

string (Int64Value format)

Popularity rank in the previous week or month.

enum (RelativeDemand)

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

enum (RelativeDemand)

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

enum (RelativeDemandChangeType)

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

{
  "countryCode": string,
  "benchmarkPriceMicros": string,
  "benchmarkPriceCurrencyCode": string
}

string

The country of the price benchmark (ISO 3166 code).

string (Int64Value format)

The latest available price benchmark in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product's catalog in the benchmark country.

string

The price benchmark currency (ISO 4217 code).

{
  "suggestedPriceMicros": string,
  "suggestedPriceCurrencyCode": string,
  "predictedImpressionsChangeFraction": number,
  "predictedClicksChangeFraction": number,
  "predictedConversionsChangeFraction": number,
  "predictedGrossProfitChangeFraction": number,
  "predictedMonthlyGrossProfitChangeMicros": string,
  "predictedMonthlyGrossProfitChangeCurrencyCode": string
}

string (Int64Value format)

The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.

string

The suggested price currency (ISO 4217 code).

number

The 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.

number

The 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.

number

The 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).

number

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

string (Int64Value format)

The predicted change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after introducing the suggested price for a month compared to current active price.

string

The predicted monthly gross profit change currency (ISO 4217 code).