Content API for Shopping . repricingrules . repricingreports

close()

Close httplib2 connections.

list(merchantId, ruleId, endDate=None, pageSize=None, pageToken=None, startDate=None, x__xgafv=None)

Lists the metrics report for a given Repricing rule.

Args:
  merchantId: string, Required. Id of the merchant who owns the Repricing rule. (required)
  ruleId: string, Required. Id of the Repricing rule. (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: 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.
  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.
  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 ListRepricingRuleReports method.
  "nextPageToken": "A String", # A token for retrieving the next page. Its absence means there is no subsequent page.
  "repricingRuleReports": [ # Daily reports for the given Repricing rule.
    { # Resource that represents a daily Repricing rule report. Next ID: 11
      "buyboxWinningRuleStats": { # Stats specific to buybox winning rules for rule report. # Stats specific to buybox winning rules for rule report (deprecated).
        "buyboxWonProductCount": 42, # Number of unique products that won the buybox with this rule during this period of time.
      },
      "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.
      },
      "impactedProducts": [ # 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.
        "A String",
      ],
      "inapplicabilityDetails": [ # List of all reasons the rule did not apply to the inapplicable products 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.
        },
      ],
      "inapplicableProducts": [ # 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.
        "A String",
      ],
      "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.
      "ruleId": "A String", # Id of the Repricing rule for this report.
      "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.
    },
  ],
}

list_next(previous_request, previous_response)

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.