| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.productstatuses.html">productstatuses</a> . <a href="content_v2_1.productstatuses.repricingreports.html">repricingreports</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(merchantId, productId, endDate=None, pageSize=None, pageToken=None, ruleId=None, startDate=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the metrics report for a given Repricing product.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(merchantId, productId, endDate=None, pageSize=None, pageToken=None, ruleId=None, startDate=None, x__xgafv=None)</code> |
| <pre>Lists the metrics report for a given Repricing product. |
| |
| Args: |
| merchantId: string, Required. Id of the merchant who owns the Repricing rule. (required) |
| productId: string, Required. Id of the Repricing product. Also known as the [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id) (required) |
| 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 page_size 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. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for the ListRepricingProductReports method. |
| "nextPageToken": "A String", # A token for retrieving the next page. Its absence means there is no subsequent page. |
| "repricingProductReports": [ # Periodic reports for the given Repricing product. |
| { # 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 rule_id in the request. |
| "applicationCount": "A String", # 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. |
| "buyboxWinningProductStats": { # Stats specific to buybox winning rules for product report. # Stats specific to buybox winning rules for product report (deprecated). |
| "buyboxWinsCount": 42, # Number of times this product won the buybox with these rules during this time period. |
| }, |
| "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Date of the stats in this report. The report starts and ends according to the merchant's timezone. |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| }, |
| "highWatermark": { # The price represented as a number and currency. # Maximum displayed price after repriced during this reporting period. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "inapplicabilityDetails": [ # List of all reasons the rule did not apply to the product during the specified reporting period. |
| { # Map of inapplicability details. |
| "inapplicableCount": "A String", # Count of this inapplicable reason code. |
| "inapplicableReason": "A String", # Reason code this rule was not applicable. |
| }, |
| ], |
| "lowWatermark": { # The price represented as a number and currency. # Minimum displayed price after repriced during this reporting period. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "orderItemCount": 42, # 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. |
| "ruleIds": [ # Ids of the Repricing rule for this report. |
| "A String", |
| ], |
| "totalGmv": { # The price represented as a number and currency. # 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. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "type": "A String", # Type of the rule. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
