Method: productstatuses.repricingreports.list

Lists the metrics report for a given Repricing product.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/productstatuses/{productId}/repricingreports

Path parameters

Parameters
merchantId

string (int64 format)

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

productId

string

Required. Id of the Repricing product. Also known as the REST_ID

Query parameters

Parameters
ruleId

string

Id of the Repricing rule. If specified, only gets this rule's reports.

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 is 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 is YYYY-MM-DD.

pageSize

integer

Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a pageSize of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the 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
{
  "repricingProductReports": [
    {
      object (RepricingProductReport)
    }
  ],
  "nextPageToken": string
}
Fields
repricingProductReports[]

object (RepricingProductReport)

Periodic reports for the given Repricing product.

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.

RepricingProductReport

Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the ruleId in the request.

JSON representation
{
  "ruleIds": [
    string
  ],
  "type": enum (RepricingRuleType),
  "date": {
    object (Date)
  },
  "applicationCount": string,
  "inapplicabilityDetails": [
    {
      object (InapplicabilityDetails)
    }
  ],
  "orderItemCount": integer,
  "totalGmv": {
    object (PriceAmount)
  },
  "highWatermark": {
    object (PriceAmount)
  },
  "lowWatermark": {
    object (PriceAmount)
  },
  "buyboxWinningProductStats": {
    object (BuyboxWinningProductStats)
  }
}
Fields
ruleIds[]

string

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

applicationCount

string (int64 format)

Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period.

inapplicabilityDetails[]

object (InapplicabilityDetails)

accounts.list of all reasons the rule did not apply to the product 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.

highWatermark

object (PriceAmount)

Maximum displayed price after repriced during this reporting period.

lowWatermark

object (PriceAmount)

Minimum displayed price after repriced during this reporting period.

buyboxWinningProductStats
(deprecated)

object (BuyboxWinningProductStats)

Stats specific to buybox winning rules for product report (deprecated).

BuyboxWinningProductStats

Stats specific to buybox winning rules for product report.

JSON representation
{
  "buyboxWinsCount": integer
}
Fields
buyboxWinsCount

integer

Number of times this product won the buybox with these rules during this time period.