Module: Peddler::Reports::VendorRealTimeTraffic

Defined in:
lib/peddler/reports/vendor_real_time_traffic.rb,
lib/peddler/reports/vendor_real_time_traffic/report.rb,
lib/peddler/reports/vendor_real_time_traffic/report_data.rb,
lib/peddler/reports/vendor_real_time_traffic/report_specification.rb

Overview

This report shares data on the customer traffic to the detail pages of the vendor's items with an hourly granularity. Requests can span multiple date range periods. For example, if the customer specified dataStartTime and dataEndTime span three hours, the report would contain data for each complete hour within the time span.

Constant Summary collapse

Report =

This report shares data on the customer traffic to the detail pages of the vendor's items with an hourly granularity. Requests can span multiple date range periods. For example, if the customer specified dataStartTime and dataEndTime span three hours, the report would contain data for each complete hour within the time span.

Structure.new do
  # @return [Array<ReportData>] List of hour and ASIN combinations.
  attribute(:report_data, [ReportData], from: "reportData")

  # @return [Hash] Summarizes the original report request.
  attribute(:report_specification, ReportSpecification, from: "reportSpecification")
end
ReportData =

Contains details about hour and ASIN combinations for the specified time range.

Structure.new do
  # @return [String] The Amazon Standard Identification Number (ASIN).
  attribute(:asin, String)

  # @return [Time] The end of a date-time range in UTC representing the end of the hour for this object.
  attribute(:end_time, Time, from: "endTime")

  # @return [Integer] The number of customer views of the product detail page for this ASIN.
  attribute(:glance_views, Integer, from: "glanceViews")

  # @return [Time] The start of a date-time range in UTC representing the beginning of the hour for this object.
  attribute(:start_time, Time, from: "startTime")
end
ReportSpecification =

Summarizes the original report request.

Structure.new do
  # @return [Time] The end of a date-time range in UTC used to determine hours to report on. Output will include
  # all full hours that fall within the range. End time should be at least 60 minutes earlier than the time of the
  # request.
  attribute(:data_end_time, Time, from: "dataEndTime")

  # @return [Time] The start of a date-time range in UTC used to determine hours to report on. Output will include
  # all full hours that fall within the range.
  attribute(:data_start_time, Time, from: "dataStartTime")

  # @return [Array<String>] Marketplace IDs as specified in the report request.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [String] The type of the report.
  attribute(:report_type, String, from: "reportType")
end

Class Method Summary collapse

Class Method Details

.parse(hash) ⇒ Object 



14
15
16
 
# File 'lib/peddler/reports/vendor_real_time_traffic.rb', line 14

def parse(hash)
  Report.parse(hash)
end