Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

Method: repricingrules.repricingreports.list

Lists the metrics report for a given Repricing rule.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/repricingrules/{ruleId}/repricingreports

Path parameters

Parameters
merchantId

string (int64 format)

Required. Id of the merchant who owns the Repricing rule.

ruleId

string

Required. Id of the Repricing rule.

Query parameters

Parameters
startDate

string

Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.

endDate

string

Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.

pageSize

integer

Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.

pageToken

string

Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response message for the repricingreports.list method.

JSON representation
{
  "repricingRuleReports": [
    {
      object (RepricingRuleReport)
    }
  ],
  "nextPageToken": string
}
Fields
repricingRuleReports[]

object (RepricingRuleReport)

Daily reports for the given Repricing rule.

nextPageToken

string

A token for retrieving the next page. Its absence means there is no subsequent page.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

RepricingRuleReport

Resource that represents a daily Repricing rule report. Next ID: 11

JSON representation
{
  "ruleId": string,
  "type": enum (RepricingRuleType),
  "date": {
    object (Date)
  },
  "impactedProducts": [
    string
  ],
  "inapplicableProducts": [
    string
  ],
  "inapplicabilityDetails": [
    {
      object (InapplicabilityDetails)
    }
  ],
  "orderItemCount": integer,
  "totalGmv": {
    object (PriceAmount)
  },
  "buyboxWinningRuleStats": {
    object (BuyboxWinningRuleStats)
  }
}
Fields
ruleId

string

Id of the Repricing rule for this report.

type

enum (RepricingRuleType)

Type of the rule.

date

object (Date)

Date of the stats in this report. The report starts and ends according to the merchant's timezone.

impactedProducts[]

string

accounts.list of product ids that are impacted by this rule during this reporting period. Out of stock products and products not searched for by customers are examples of non-impacted products.

inapplicableProducts[]

string

accounts.list of product ids that are inapplicable to this rule during this reporting period. To get the inapplicable reason for a specific product, see [RepricingProductReport][google.shopping.content.v2p1.RepricingProductReport].

inapplicabilityDetails[]

object (InapplicabilityDetails)

accounts.list of all reasons the rule did not apply to the inapplicable products during the specified reporting period.

orderItemCount

integer

Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.

totalGmv

object (PriceAmount)

Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.

buyboxWinningRuleStats

object (BuyboxWinningRuleStats)

Stats specific to buybox winning rules for rule report.

BuyboxWinningRuleStats

Stats specific to buybox winning rules for rule report.

JSON representation
{
  "buyboxWonProductCount": integer
}
Fields
buyboxWonProductCount

integer

Number of unique products that won the buybox with this rule during this period of time.