Module: Peddler::DataKiosk::SalesAndTraffic20240424

Defined in:: lib/peddler/data_kiosk/sales_and_traffic20240424.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/amount.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/by_asin_sales.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_sales.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/by_asin_traffic.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_traffic.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/sales_and_traffic_trends.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/sales_and_traffic_by_asin.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/sales_and_traffic_by_date.rb,
lib/peddler/data_kiosk/sales_and_traffic20240424/analytics_salesandtraffic20240424.rb

Constant Summary collapse

Amount = Monetary amount with the corresponding currency code.

Structure.new do
  # @return [Float] The amount.
  attribute?(:amount, Float, null: false)

  # @return [String] Currency code of the amount in ISO 4217 format.
  attribute?(:currency_code, String, null: false, from: "currencyCode")
end

ByASINSales = The sales data for the seller's account aggregated by ASIN.

Structure.new do
  # @return [Amount] The amount of ordered product sales, calculated by multiplying the price of products and the
  #   number of units sold for the selected time period.
  attribute?(:ordered_product_sales, Amount, null: false, from: "orderedProductSales")

  # @return [Amount] The amount of ordered product sales to Amazon Business customers, calculated by multiplying
  #   the price of products and the number of units sold for the selected time period. Note: This field is only
  #   populated when the seller is a B2B seller.
  attribute?(:ordered_product_sales_b2b, Amount, from: "orderedProductSalesB2B")

  # @return [String] The number of items that were ordered for the selected time period.
  attribute?(:total_order_items, String, null: false, from: "totalOrderItems")

  # @return [String] The number of items that were ordered by Amazon Business customers for the selected time
  #   period. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:total_order_items_b2b, String, from: "totalOrderItemsB2B")

  # @return [String] The number of units ordered.
  attribute?(:units_ordered, String, null: false, from: "unitsOrdered")

  # @return [String] The number of units ordered by Amazon Business customers. Note: This field is only populated
  #   when the seller is a B2B seller.
  attribute?(:units_ordered_b2b, String, from: "unitsOrderedB2B")
end

ByDateSales = The sales data for the seller's account aggregated by date.

Structure.new do
  # @return [Amount] The average ordered product sales, calculated by dividing orderedProductSales by
  #   totalOrderItems for the selected time period.
  attribute?(:average_sales_per_order_item, Amount, null: false, from: "averageSalesPerOrderItem")

  # @return [Amount] The average ordered product sales to Amazon Business customers, calculated by dividing
  #   orderedProductSalesB2B by totalOrderItemsB2B for the selected time period. Note: This field is only
  #   populated when the seller is a B2B seller.
  attribute?(:average_sales_per_order_item_b2b, Amount, from: "averageSalesPerOrderItemB2B")

  # @return [Amount] The average price of the units sold in the selected time period, calculated by dividing the
  #   orderedProductSales by unitsOrdered for the selected time period.
  attribute?(:average_selling_price, Amount, null: false, from: "averageSellingPrice")

  # @return [Amount] The average price of the units sold to Amazon Business customers, calculated by dividing the
  #   orderedProductSalesB2B by unitsOrderedB2B for the selected time period. Note: This field is only populated
  #   when the seller is a B2B seller.
  attribute?(:average_selling_price_b2b, Amount, from: "averageSellingPriceB2B")

  # @return [Float] The average number of units in each order item for the selected time period.
  attribute?(:average_units_per_order_item, Float, null: false, from: "averageUnitsPerOrderItem")

  # @return [Float] The average number of units in each order item ordered by Amazon Business customers for the
  #   selected time period. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:average_units_per_order_item_b2b, Float, from: "averageUnitsPerOrderItemB2B")

  # @return [Amount] Monetary amount of filed A-to-z guarantee claims.
  attribute?(:claims_amount, Amount, null: false, from: "claimsAmount")

  # @return [String] The number of A-to-z guarantee claims granted.
  attribute?(:claims_granted, String, null: false, from: "claimsGranted")

  # @return [Amount] The amount of ordered product sales, calculated by multiplying the price of products and the
  #   number of units sold for the selected time period.
  attribute?(:ordered_product_sales, Amount, null: false, from: "orderedProductSales")

  # @return [Amount] The amount of ordered product sales to Amazon Business customers, calculated by multiplying
  #   the price of products and the number of units sold for the selected time period.
  attribute?(:ordered_product_sales_b2b, Amount, from: "orderedProductSalesB2B")

  # @return [String] The number of orders shipped in the selected time period.
  attribute?(:orders_shipped, String, null: false, from: "ordersShipped")

  # @return [Float] The percentage conversion metric indicating how many orders were refunded by the seller,
  #   calculated by dividing unitsOrdered by unitsRefunded in the selected time period.
  attribute?(:refund_rate, Float, null: false, from: "refundRate")

  # @return [Amount] The amount of ordered product sales shipped for the selected time period.
  attribute?(:shipped_product_sales, Amount, null: false, from: "shippedProductSales")

  # @return [String] The number of items that were ordered for the selected time period. Example:
  # For an order containing 2 copies of book A and 3 copies of book B, the number of orders is 1, the number of
  #   order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
  attribute?(:total_order_items, String, null: false, from: "totalOrderItems")

  # @return [String] The number of items that were ordered by Amazon Business customers for the selected time
  #   period. Example: For an order containing 2 copies of book A and 3 copies of book B, the number of orders is
  #   1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
  attribute?(:total_order_items_b2b, String, from: "totalOrderItemsB2B")

  # @return [String] The number of units ordered for the selected time period. Example: For an order containing 2
  #   copies of book A and 3 copies of book B, the number of orders is 1, the number of order items is 2 (book A
  #   and book B), and the number of units is 5 (2 + 3).
  attribute?(:units_ordered, String, null: false, from: "unitsOrdered")

  # @return [String] The number of units ordered by Amazon Business customers for the selected time period.
  #   Example: For an order containing 2 copies of book A and 3 copies of book B, the number of orders is 1, the
  #   number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
  attribute?(:units_ordered_b2b, String, from: "unitsOrderedB2B")

  # @return [String] The number of units refunded in the selected time period.
  attribute?(:units_refunded, String, null: false, from: "unitsRefunded")

  # @return [String] The number of units shipped in the selected time period.
  attribute?(:units_shipped, String, null: false, from: "unitsShipped")
end

ByASINTraffic = The traffic data for the seller's account aggregated by ASIN.

Structure.new do
  # @return [String] Browser page views are the number of times a user visited your Amazon.com browser pages for
  #   the selected time period.
  attribute?(:browser_page_views, String, null: false, from: "browserPageViews")

  # @return [String] Browser B2B page views are the number of times an Amazon Business customer visited your
  #   Amazon.com browser pages for the selected time period. Note: This field is only populated when the seller is
  #   a B2B seller.
  attribute?(:browser_page_views_b2b, String, from: "browserPageViewsB2B")

  # @return [Float] The percentage of browser page views that a particular SKU/ASIN receives relative to the total
  #   number of browser page views for all products.
  attribute?(:browser_page_views_percentage, Float, null: false, from: "browserPageViewsPercentage")

  # @return [Float] The percentage of browser views by Amazon Business customers that a particular SKU/ASIN
  #   receives relative to the total number of mobile page views by Amazon Business customers for all products.
  #   Note: This field is only populated when the seller is a B2B seller.
  attribute?(:browser_page_views_percentage_b2b, Float, from: "browserPageViewsPercentageB2B")

  # @return [Float] The percentage of browser sessions that contain at least one page view for a particular
  #   SKU/ASIN relative to the total number of browser sessions for all products.
  attribute?(:browser_session_percentage, Float, null: false, from: "browserSessionPercentage")

  # @return [Float] The percentage of browser sessions that contain at least one page view by an Amazon Business
  #   customer for a particular SKU/ASIN relative to the total number of browser sessions by Amazon Business
  #   customers for all products.
  # Note: This field is only populated when the seller is a B2B seller.
  attribute?(:browser_session_percentage_b2b, Float, from: "browserSessionPercentageB2B")

  # @return [String] Browser sessions are visits to your Amazon.com browser pages by a user. All browser activity
  #   within a 24-hour period is considered a browser session. For example, if a user visits your pages using a
  #   browser multiple times within a 24 hour period it is counted as a single browser session.
  attribute?(:browser_sessions, String, null: false, from: "browserSessions")

  # @return [String] Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Business
  #   customer. All activity within a 24-hour period is considered a browser session. For example, if an Amazon
  #   Business customer visits your pages using browser multiple times within a 24 hour period it is counted as a
  #   single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:browser_sessions_b2b, String, from: "browserSessionsB2B")

  # @return [Float] The percentage of page views where the buy box (the add to shopping cart link) appeared on the
  #   page for customers to add your product to their cart.
  attribute?(:buy_box_percentage, Float, null: false, from: "buyBoxPercentage")

  # @return [Float] The percentage of page views by Amazon Business customers where the buy box (the add to
  #   shopping cart link) appeared on the page for customers to add your product to their cart. Note: This field
  #   is only populated when the seller is a B2B seller.
  attribute?(:buy_box_percentage_b2b, Float, from: "buyBoxPercentageB2B")

  # @return [String] Mobile app page views are the number of times a user visited your Amazon.com mobile app pages
  #   for the selected time period.
  attribute?(:mobile_app_page_views, String, null: false, from: "mobileAppPageViews")

  # @return [String] Mobile app B2B page views are the number of times an Amazon Business customer visited your
  #   Amazon.com mobile app pages for the selected time period. Note:
  # This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_page_views_b2b, String, from: "mobileAppPageViewsB2B")

  # @return [Float] The percentage of mobile app page views that a particular SKU/ASIN receives relative to the
  #   total number of mobile app page views for all products.
  attribute?(:mobile_app_page_views_percentage, Float, null: false, from: "mobileAppPageViewsPercentage")

  # @return [Float] The percentage of mobile page views by Amazon Business customers that a particular SKU/ASIN
  #   receives relative to the total number of mobile page views by Amazon Business customers for all products.
  #   Note: This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_page_views_percentage_b2b, Float, from: "mobileAppPageViewsPercentageB2B")

  # @return [Float] The percentage of mobile app sessions that contain at least one page view for a particular
  #   SKU/ASIN relative to the total number of mobile app sessions for all products.
  attribute?(:mobile_app_session_percentage, Float, null: false, from: "mobileAppSessionPercentage")

  # @return [Float] The percentage of mobile app sessions that contain at least one page view by an Amazon
  #   Business customer for a particular SKU/ASIN relative to the total number of mobile app sessions by Amazon
  #   Business customers for all products.
  # Note: This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_session_percentage_b2b, Float, from: "mobileAppSessionPercentageB2B")

  # @return [String] Mobile app sessions are visits to your Amazon.com mobile app pages by a user.
  # All mobile app activity within a 24-hour period is considered a mobile app session. For example, if a user
  #   visits your pages using a mobile app multiple times within a 24 hour period it is counted as a single mobile
  #   app session.
  attribute?(:mobile_app_sessions, String, null: false, from: "mobileAppSessions")

  # @return [String] Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Amazon Business
  #   customer. All activity within a 24-hour period is considered a mobile app session. For example, if an Amazon
  #   Business customer visits your pages using mobile app multiple times within a 24 hour period it is counted as
  #   a single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_sessions_b2b, String, from: "mobileAppSessionsB2B")

  # @return [String] Page views are the number of times a user visited your Amazon.com browser or mobile app pages
  #   for the selected time period. It is calculated as the sum of browserPageViews and mobileAppPageViews.
  attribute?(:page_views, String, null: false, from: "pageViews")

  # @return [String] B2B page views are the number of times an Amazon Business customer visited your Amazon.com
  #   pages using browser or mobile app for the selected time period. Note: This field is only populated when the
  #   seller is a B2B seller.
  attribute?(:page_views_b2b, String, from: "pageViewsB2B")

  # @return [Float] The percentage of browser and mobile app page views that a particular SKU/ASIN receives
  #   relative to the total number of browser and mobile app page views for all products.
  attribute?(:page_views_percentage, Float, null: false, from: "pageViewsPercentage")

  # @return [Float] The percentage of page views by Amazon Business customers that a particular SKU/ASIN receives
  #   relative to the total number of page views by Amazon Business customers for all products. Note: This field
  #   is only populated when the seller is a B2B seller.
  attribute?(:page_views_percentage_b2b, Float, from: "pageViewsPercentageB2B")

  # @return [Float] The percentage of sessions that contain at least one page view for a particular SKU/ASIN
  #   relative to the total number of sessions for all products.
  attribute?(:session_percentage, Float, null: false, from: "sessionPercentage")

  # @return [Float] The percentage of sessions that contain at least one page view by an Amazon Business customer
  #   for a particular SKU/ASIN relative to the total number of sessions by Amazon Business customers for all
  #   products. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:session_percentage_b2b, Float, from: "sessionPercentageB2B")

  # @return [String] Sessions are visits to your Amazon.com browser or mobile app pages by a user.
  # All browser and mobile app activity within a 24-hour period is considered a session. It is calculated as the
  #   sum of browserSessions and mobileAppSessions.
  attribute?(:sessions, String, null: false)

  # @return [String] B2B sessions are visits to your Amazon.com pages using browser or mobile app by an Amazon
  #   Business customer. All activity within a 24-hour period is considered a session. For example, if an Amazon
  #   Business customer visits your pages multiple times using mobile app or browser within a 24 hour period it is
  #   counted as a single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:sessions_b2b, String, from: "sessionsB2B")

  # @return [Float] The percentage conversion metric indicating how many units were purchased relative to the
  #   number of people who viewed the products, calculated by dividing unitsOrdered by sessions.
  attribute?(:unit_session_percentage, Float, null: false, from: "unitSessionPercentage")

  # @return [Float] The percentage conversion metric indicating how many units were purchased by Amazon Business
  #   customers relative to the number of Amazon Business customers who viewed the products, calculated by
  #   dividing unitsOrderedB2B by sessions.
  # Note: This field is only populated when the seller is a B2B seller.
  attribute?(:unit_session_percentage_b2b, Float, from: "unitSessionPercentageB2B")
end

ByDateTraffic = The traffic data for the seller's account aggregated by date.

Structure.new do
  # @return [String] The average number of offers listed for sale in the selected time period. It is calculated
  #   from the total number of offers and the total number of days in the selected time period.
  attribute?(:average_offer_count, String, null: false, from: "averageOfferCount")

  # @return [String] The average number of parent items listed for sale in the selected time period.
  attribute?(:average_parent_items, String, null: false, from: "averageParentItems")

  # @return [String] Browser page views are the number of times a user visited your Amazon.com browser pages for
  #   the selected time period.
  attribute?(:browser_page_views, String, null: false, from: "browserPageViews")

  # @return [String] Browser B2B page views are the number of times an Amazon Business customer visited your
  #   Amazon.com browser pages for the selected time period. Note: This field is only populated when the seller is
  #   a B2B seller.
  attribute?(:browser_page_views_b2b, String, from: "browserPageViewsB2B")

  # @return [String] Browser sessions are visits to your Amazon.com browser pages by a user. All browser activity
  #   within a 24-hour period is considered a browser session. For example, if a user visits your pages using a
  #   browser multiple times within a 24 hour period it is counted as a single browser session.
  attribute?(:browser_sessions, String, null: false, from: "browserSessions")

  # @return [String] Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Business
  #   customer. All activity within a 24-hour period is considered a browser session. For example, if an Amazon
  #   Business customer visits your pages using browser multiple times within a 24 hour period it is counted as a
  #   single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:browser_sessions_b2b, String, from: "browserSessionsB2B")

  # @return [Float] The percentage of page views where the buy box (the add to shopping cart link) appeared on the
  #   page for customers to add your product to their cart.
  attribute?(:buy_box_percentage, Float, null: false, from: "buyBoxPercentage")

  # @return [Float] The percentage of page views by Amazon Business customers where the buy box (the add to
  #   shopping cart link) appeared on the page for customers to add your product to their cart. Note: This field
  #   is only populated when the seller is a B2B seller.
  attribute?(:buy_box_percentage_b2b, Float, from: "buyBoxPercentageB2B")

  # @return [String] The number of times customers left feedback in the selected time period.
  attribute?(:feedback_received, String, null: false, from: "feedbackReceived")

  # @return [String] Mobile app page views are the number of times a user visited your Amazon.com mobile app pages
  #   for the selected time period.
  attribute?(:mobile_app_page_views, String, null: false, from: "mobileAppPageViews")

  # @return [String] Mobile app B2B page views are the number of times an Amazon Business customer visited your
  #   Amazon.com mobile app pages for the selected time period. Note:
  # This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_page_views_b2b, String, from: "mobileAppPageViewsB2B")

  # @return [String] Mobile app sessions are visits to your Amazon.com mobile app pages by a user.
  # All mobile app activity within a 24-hour period is considered a mobile app session. For example, if a user
  #   visits your pages using a mobile app multiple times within a 24 hour period it is counted as a single mobile
  #   app session.
  attribute?(:mobile_app_sessions, String, null: false, from: "mobileAppSessions")

  # @return [String] Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Amazon Business
  #   customer. All activity within a 24-hour period is considered a mobile app session. For example, if an Amazon
  #   Business customer visits your pages using mobile app multiple times within a 24 hour period it is counted as
  #   a single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:mobile_app_sessions_b2b, String, from: "mobileAppSessionsB2B")

  # @return [String] The number of times customers left negative feedback in the selected time period.
  attribute?(:negative_feedback_received, String, null: false, from: "negativeFeedbackReceived")

  # @return [Float] The percentage conversion metric indicating how many order items were generated relative to
  #   the number of people who viewed the products.
  attribute?(:order_item_session_percentage, Float, null: false, from: "orderItemSessionPercentage")

  # @return [Float] The percentage conversion metric indicating how many order items were generated by Amazon
  #   Business customers relative to the number of Amazon Business customers who viewed the products. Note: This
  #   field is only populated when the seller is a B2B seller.
  attribute?(:order_item_session_percentage_b2b, Float, from: "orderItemSessionPercentageB2B")

  # @return [String] Page views are the number of times a user visited your Amazon.com browser or mobile app pages
  #   for the selected time period. It is calculated as the sum of browserPageViews and mobileAppPageViews.
  attribute?(:page_views, String, null: false, from: "pageViews")

  # @return [String] B2B page views are the number of times an Amazon Business customer visited your Amazon.com
  #   pages using browser or mobile app for the selected time period. Note: This field is only populated when the
  #   seller is a B2B seller.
  attribute?(:page_views_b2b, String, from: "pageViewsB2B")

  # @return [Float] The negative feedback rate is the number of orders that have received negative feedback
  #   divided by the number of orders in the selected time period.
  attribute?(:received_negative_feedback_rate, Float, null: false, from: "receivedNegativeFeedbackRate")

  # @return [String] Sessions are visits to your Amazon.com browser or mobile app pages by a user.
  # All browser and mobile app activity within a 24-hour period is considered a session. It is calculated as the
  #   sum of browserSessions and mobileAppSessions.
  attribute?(:sessions, String, null: false)

  # @return [String] B2B sessions are visits to your Amazon.com pages using browser or mobile app by an Amazon
  #   Business customer. All activity within a 24-hour period is considered a session. For example, if an Amazon
  #   Business customer visits your pages multiple times using mobile app or browser within a 24 hour period it is
  #   counted as a single session. Note: This field is only populated when the seller is a B2B seller.
  attribute?(:sessions_b2b, String, from: "sessionsB2B")

  # @return [Float] The percentage conversion metric indicating how many units were purchased relative to the
  #   number of people who viewed the products.
  attribute?(:unit_session_percentage, Float, null: false, from: "unitSessionPercentage")

  # @return [Float] The percentage conversion metric indicating how many units were purchased by Amazon Business
  #   customers relative to number of Amazon Business customers who viewed the products. Note: This field is only
  #   populated when the seller is a B2B seller.
  attribute?(:unit_session_percentage_b2b, Float, from: "unitSessionPercentageB2B")
end

SalesAndTrafficTrends =

Structure.new do
  # @return [String] Indicates the ASIN level at which the data is aggregated. Currently only CHILD is supported.
  attribute?(:asin_aggregation, String, null: false, from: "asinAggregation")

  # @return [String] The Amazon Standard Identification Number of the child product. Child products are unique,
  #   sellable products that are related in our catalog to a single, non-sellable parent product. Note: This field
  #   is only present when ASIN aggregation is CHILD or SKU.
  attribute?(:child_asin, String, from: "childAsin")

  # @return [String] The end date of the period of the aggregated sales and traffic data.
  attribute?(:end_date, String, null: false, from: "endDate")

  # @return [String] The marketplace identifier of the sales and traffic data.
  attribute?(:marketplace_id, String, null: false, from: "marketplaceId")

  # @return [String] The Amazon Standard Identification Number of the parent product. A parent product appears in
  #   our catalog as a non-buyable, generic identifier for a product that has buyable variations (child products).
  attribute?(:parent_asin, String, null: false, from: "parentAsin")

  # @return [ByASINSales] The sales data for the parentAsin/childAsin/sku within the specified date range.
  attribute?(:sales, ByASINSales, null: false)

  # @return [String] The Stock Keeping Unit of the product. The SKU is a seller specific product identifier. Note:
  #   This field is only present when ASIN aggregation is SKU.
  attribute?(:sku, String)

  # @return [String] The start date of the period of the aggregated sales and traffic data.
  attribute?(:start_date, String, null: false, from: "startDate")

  # @return [ByASINTraffic] The traffic data for the parentAsin/childAsin/sku within the specified date range.
  attribute?(:traffic, ByASINTraffic, null: false)
end

SalesAndTrafficByASIN = The sales and traffic data for the seller's account aggregated by ASIN.

Structure.new do
  # @return [String] The Amazon Standard Identification Number of the child product. Child products are unique,
  #   sellable products that are related in our catalog to a single, non-sellable parent product. Note: This field
  #   is only present when ASIN aggregation is CHILD or SKU.
  attribute?(:child_asin, String, from: "childAsin")

  # @return [String] The end date of the period of the aggregated data.
  attribute?(:end_date, String, null: false, from: "endDate")

  # @return [String] The marketplace identifier of the sales and traffic data.
  attribute?(:marketplace_id, String, null: false, from: "marketplaceId")

  # @return [String] The Amazon Standard Identification Number of the parent product. A parent product appears in
  #   our catalog as a non-buyable, generic identifier for a product that has buyable variations (child products).
  attribute?(:parent_asin, String, null: false, from: "parentAsin")

  # @return [ByASINSales] The sales data for the parentAsin/childAsin/sku within the specified date range.
  attribute?(:sales, ByASINSales, null: false)

  # @return [String] The Stock Keeping Unit of the product. The SKU is a seller specific product identifier. Note:
  #   This field is only present when ASIN aggregation is SKU.
  attribute?(:sku, String)

  # @return [String] The start date of the period of the aggregated data.
  attribute?(:start_date, String, null: false, from: "startDate")

  # @return [ByASINTraffic] The traffic data for the parentAsin/childAsin/sku within the specified date range.
  attribute?(:traffic, ByASINTraffic, null: false)
end

SalesAndTrafficByDate = The sales and traffic data for the seller's account aggregated by date.

Structure.new do
  # @return [String] The end date of the sales and traffic data.
  attribute?(:end_date, String, null: false, from: "endDate")

  # @return [String] The marketplace identifier of the sales and traffic data.
  attribute?(:marketplace_id, String, null: false, from: "marketplaceId")

  # @return [ByDateSales] The sales data for the seller's account.
  attribute?(:sales, ByDateSales, null: false)

  # @return [String] The start date of the sales and traffic data.
  attribute?(:start_date, String, null: false, from: "startDate")

  # @return [ByDateTraffic] The traffic data for the seller's account.
  attribute?(:traffic, ByDateTraffic, null: false)
end

AnalyticsSalesandtraffic20240424 = A root type for Analytics Sales and Traffic queries version 2024_04_24.

Structure.new do
  # @return [Array<SalesAndTrafficByAsin>] A query to retrieve sales and traffic data for the seller's account
  #   aggregated by ASIN.
  attribute?(:sales_and_traffic_by_asin, [SalesAndTrafficByASIN], from: "salesAndTrafficByAsin")

  # @return [Array<SalesAndTrafficByDate>] A query to retrieve sales and traffic data for the seller's account
  #   aggregated by date.
  attribute?(:sales_and_traffic_by_date, [SalesAndTrafficByDate], from: "salesAndTrafficByDate")

  # @return [Array<SalesAndTrafficTrends>] This query retrieves sales and traffic trend data for a specified list
  #   of ASINs within a date range. The data can be aggregated at different time intervals to support various
  #   analytical needs.
  attribute?(:sales_and_traffic_trends, [SalesAndTrafficTrends], from: "salesAndTrafficTrends")
end

Class Method Summary collapse

.schema ⇒ Hash
GraphQL schema introspection data.

Class Method Details

.schema ⇒ `Hash`

Returns GraphQL schema introspection data.

Returns:

(Hash) —
GraphQL schema introspection data

# File 'lib/peddler/data_kiosk/sales_and_traffic20240424.rb', line 10

def schema
  path = File.expand_path("sales_and_traffic20240424.json", __dir__.to_s)
  JSON.load_file(path)
end

Module: Peddler::DataKiosk::SalesAndTraffic20240424

Constant Summary collapse

Class Method Summary collapse

Class Method Details

.schema ⇒ Hash

.schema ⇒ `Hash`