Class: Peddler::APIs::CustomerFeedback20240601

Inherits:

Peddler::API

Object
Peddler::API
Peddler::APIs::CustomerFeedback20240601

show all

Defined in:: lib/peddler/apis/customer_feedback_2024_06_01.rb,
lib/peddler/apis/customer_feedback_2024_06_01/error.rb,
lib/peddler/apis/customer_feedback_2024_06_01/date_range.rb,
lib/peddler/apis/customer_feedback_2024_06_01/error_list.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/child_asin_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trends.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_subtopic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_subtopic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/review_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_occurrence.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trends.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_all_occurrence.rb,
lib/peddler/apis/customer_feedback_2024_06_01/child_asin_mention_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_subtopic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_star_rating_impact.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_browse_node_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_all_star_rating_impact.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_subtopic_metrics.rb

Overview

The Selling Partner API for CustomerFeedback

The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.

Constant Summary collapse

Error = Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute?(:details, String)
end

DateRange = A date range.

Structure.new do
  # @return [Time] The end date of the date range in ISO-8601 date/time format.
  attribute(:end_date, Time, from: "endDate")

  # @return [Time] The start date of the date range in ISO-8601 date/time format.
  attribute(:start_date, Time, from: "startDate")
end

ErrorList = A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] List of errors.
  attribute(:errors, [Error])
end

ItemReviewTopic = Details of item review topic.

Structure.new do
  # @return [ItemReviewTopicMetrics] The ASIN's review topic metrics.
  attribute(:asin_metrics, ItemReviewTopicMetrics, from: "asinMetrics")

  # @return [String] The name of the item review topic.
  attribute(:topic, String)

  # @return [ItemReviewBrowseNodeMetrics] The browse node's review topic metrics. This value is `null` if there
  # isn't enough topic data for the browse node.
  attribute?(:browse_node_metrics, ItemReviewBrowseNodeMetrics, from: "browseNodeMetrics")

  # @return [ChildASINMetrics] The review topic metrics for other child ASINs that have the same parent ASIN. This
  # value is `null` if there isn't any child ASIN metric data.
  attribute?(:child_asin_metrics, ChildASINMetrics, from: "childAsinMetrics")

  # @return [ItemReviewTopicMetrics] The parent ASIN's review topic metrics. This value is `null` if there isn't
  # enough topic data for the parent ASIN.
  attribute?(:parent_asin_metrics, ItemReviewTopicMetrics, from: "parentAsinMetrics")

  # @return [Array<String>] A list of up to three snippets from reviews that contain the topic. This value is
  # `null` if there aren't enough review snippets for the topic.
  attribute?(:review_snippets, [String], from: "reviewSnippets")

  # @return [Array<ItemReviewSubtopic>] A list of up to five top subtopics for the topic. The percentage of
  # customer reviews that mention the subtopic determine the topic's placement in the list. This value is `null`
  # if there are no subtopics.
  attribute?(:subtopics, [ItemReviewSubtopic])
end

ItemReviewTrend = The trend of review topic metrics for the requested item.

Structure.new do
  # @return [String] The name of the item review topic.
  attribute(:topic, String)

  # @return [Array<ItemReviewTrendPoint>] The item's review trend metrics for the past six months.
  attribute(:trend_metrics, [ItemReviewTrendPoint], from: "trendMetrics")
end

ChildASINMetrics = The review topic metrics for other child ASINs that have the same parent ASIN. This value is null if there isn't any child ASIN metric data.

Structure.new do
  # @return [ChildASINMentionMetrics] The child ASIN for which reviews mention the topic the least number of
  # times, and the number of times reviews mention the topic. This value is `null` if there are no child ASIN
  # metrics.
  attribute?(:least_mentions, ChildASINMentionMetrics, from: "leastMentions")

  # @return [ChildASINMentionMetrics] The child ASIN for which reviews mention the topic the greatest number of
  # times, and the number of times reviews mention the topic. This value is `null` if there are no child ASIN
  # metrics.
  attribute?(:most_mentions, ChildASINMentionMetrics, from: "mostMentions")
end

ItemReviewTopics = The top 10 positive and negative item review topics.

Structure.new do
  # @return [Array<ItemReviewTopic>] A list of the most negative review topics. When the `sortBy` query parameter
  # is set to `MENTIONS`, the number of reviews that mention the topic determines the topic's placement in the
  # list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the
  # item determines placement in the list. This value is `null` if there are not enough negative reviews for the
  # specified ASIN.
  #
  # **Max length:** 10
  attribute?(:negative_topics, [ItemReviewTopic], from: "negativeTopics")

  # @return [Array<ItemReviewTopic>] A list of the most positive review topics. When the `sortBy` query parameter
  # is set to `MENTIONS`, the number of reviews that mention the topic determines the topic's placement in the
  # list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the
  # item determines placement in the list. This value is `null` if there are not enough positive reviews for the
  # specified ASIN.
  #
  # **Max length:** 10
  attribute?(:positive_topics, [ItemReviewTopic], from: "positiveTopics")
end

ItemReviewTrends = The 10 most positive and most negative review topics for all items in a browse node.

Structure.new do
  # @return [Array<ItemReviewTrend>] A list of the most negative review topics. The percentage of reviews that
  # contain the topic determines the topic's placement in the list. This value is `null` if there are not enough
  # negative reviews for the specified ASIN.
  #
  # **Max length:** 10
  attribute?(:negative_topics, [ItemReviewTrend], from: "negativeTopics")

  # @return [Array<ItemReviewTrend>] A list of the most positive review topics. The percentage of reviews that
  # contain the topic determines the topic's placement in the list. This value is `null` if there are not enough
  # positive reviews for the specified ASIN.
  #
  # **Max length:** 10
  attribute?(:positive_topics, [ItemReviewTrend], from: "positiveTopics")
end

BrowseNodeResponse = The response for the getItemBrowseNode operation.

Structure.new do
  # @return [String] A browse node id is the unique identifier of a given browse node. A browse node is a location
  # in a browse tree that is used for navigation, product classification, and website content.
  attribute(:browse_node_id, String, from: "browseNodeId")

  # @return [String] The display name of the browse node as visible on the Amazon retail website.
  attribute(:display_name, String, from: "displayName")
end

BrowseNodeSubtopic = The browse node review subtopic.

Structure.new do
  # @return [BrowseNodeReviewSubtopicMetrics] The browse node review subtopic metrics.
  attribute(:metrics, BrowseNodeReviewSubtopicMetrics)

  # @return [String] The name of the browse node review subtopic.
  attribute(:subtopic, String)

  # @return [Array<String>] A list of up to three snippets from reviews that contain the topic. This value is
  # `null` if there aren't enough review snippets for the subtopic.
  attribute?(:review_snippets, [String], from: "reviewSnippets")
end

ItemReviewSubtopic = Details of the subtopic for an item review topic.

Structure.new do
  # @return [ItemReviewSubtopicMetrics] The subtopic metrics.
  attribute(:metrics, ItemReviewSubtopicMetrics)

  # @return [String] The name of the subtopic.
  attribute(:subtopic, String)

  # @return [Array<String>] A list of up to three snippets from reviews that contain the subtopic. This value is
  # `null` if there aren't enough review snippets for the subtopic.
  attribute?(:review_snippets, [String], from: "reviewSnippets")
end

ReviewTrendMetrics = The item review trend metrics.

Structure.new do
  # @return [Float] The percentage of reviews that mention the topic.
  attribute(:occurrence_percentage, Float, from: "occurrencePercentage")
end

BrowseNodeOccurrence = The browse node review trend occurrence metrics.

Structure.new do
  # @return [Float] The percentage of reviews of products in the browse node that mention a topic.
  attribute(:all_products, Float, from: "allProducts")
end

ItemReviewTrendPoint = The review metrics for a certain month.

Structure.new do
  # @return [ReviewTrendMetrics] The ASIN's review trend metrics.
  attribute(:asin_metrics, ReviewTrendMetrics, from: "asinMetrics")

  # @return [DateRange] The date range of the item review trend metric.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [BrowseNodeTrendMetrics] The browse node's review trend metrics. This value is `null` if there isn't
  # enough topic data for the browse node.
  attribute?(:browse_node_metrics, BrowseNodeTrendMetrics, from: "browseNodeMetrics")

  # @return [ReviewTrendMetrics] The parent ASIN's review trend metrics. This value is `null` if there isn't
  # enough topic data for the parent ASIN.
  attribute?(:parent_asin_metrics, ReviewTrendMetrics, from: "parentAsinMetrics")
end

BrowseNodeReturnTrend = The trend of return topic metrics for all items in the requested browse node.

Structure.new do
  # @return [String] The name of the topic.
  attribute(:topic, String)

  # @return [Array<BrowseNodeReturnTrendPoint>] The browse node return trend metrics.
  attribute(:trend_metrics, [BrowseNodeReturnTrendPoint], from: "trendMetrics")
end

BrowseNodeReviewTopic = The browse node review topic.

Structure.new do
  # @return [BrowseNodeReviewTopicMetrics] The percentage of browse node reviews that mention the topic, and the
  # effect the topic has on the star rating.
  attribute(:browse_node_metrics, BrowseNodeReviewTopicMetrics, from: "browseNodeMetrics")

  # @return [String] The name browse node review topic.
  attribute(:topic, String)

  # @return [Array<String>] A list of up to three snippets from reviews that contain the topic. This value is
  # `null` if there aren't enough review snippets for the topic.
  attribute?(:review_snippets, [String], from: "reviewSnippets")

  # @return [Array<BrowseNodeSubtopic>] A list of the five subtopics that occur most frequently. This value is
  # `null` if there are no subtopics.
  attribute?(:subtopics, [BrowseNodeSubtopic])
end

BrowseNodeReviewTrend = The trend of review topic metrics for all items in the requested browse node.

Structure.new do
  # @return [String] The name of the topic.
  attribute(:topic, String)

  # @return [Array<BrowseNodeReviewTrendPoint>] The browse node's review trend metrics for the past six months.
  attribute(:trend_metrics, [BrowseNodeReviewTrendPoint], from: "trendMetrics")
end

BrowseNodeReturnTopics = Topics from returns for all items in a browse node.

Structure.new do
  # @return [BrowseNodeTrendMetrics] The browse node return topic metrics.
  attribute(:browse_node_metrics, BrowseNodeTrendMetrics, from: "browseNodeMetrics")

  # @return [String] The name of the return feedback topic .
  attribute(:topic, String)
end

BrowseNodeReviewTopics = The 10 most positive and most negative review topics for all items in a browse node.

Structure.new do
  # @return [Array<BrowseNodeReviewTopic>] A list of the most negative review topics. When the `sortBy` query
  # parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention
  # the topic determine the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the
  # effect that the topic has on the star rating of items within the requested browse node determine placement in
  # the list. This value is `null` if there are not enough negative reviews for the requested browse node.
  #
  # **Max length:** 10
  attribute?(:negative_topics, [BrowseNodeReviewTopic], from: "negativeTopics")

  # @return [Array<BrowseNodeReviewTopic>] A list of the most positive review topics. When the `sortBy` query
  # parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention
  # the topic determine the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the
  # effect that the topic has on the star rating of items within the requested browse node determine placement in
  # the list. This value is `null` if there are not enough positive reviews for the requested browse node.
  #
  # **Max length:** 10
  attribute?(:positive_topics, [BrowseNodeReviewTopic], from: "positiveTopics")
end

BrowseNodeReviewTrends = The 10 most positive and most negative review topics for all items in a browse node.

Structure.new do
  # @return [Array<BrowseNodeReviewTrend>] The trends of the most negative review topics. The percentage of
  # reviews that contain the topic across all products in the requested browse node determine the topic's
  # placement in the list. This value is `null` if there aren't enough positive reviews for the requested browse
  # node.
  #
  # **Max length:** 10
  attribute?(:negative_topics, [BrowseNodeReviewTrend], from: "negativeTopics")

  # @return [Array<BrowseNodeReviewTrend>] The trends of the most positive review topics. The percentage of
  # reviews that contain the topic across all products in the requested browse node determine the topic's
  # placement in the list. This value is `null` if there aren't enough positive reviews for the requested browse
  # node.
  #
  # **Max length:** 10
  attribute?(:positive_topics, [BrowseNodeReviewTrend], from: "positiveTopics")
end

BrowseNodeTrendMetrics = A single browse node review or return trend metric.

Structure.new do
  # @return [BrowseNodeOccurrence] The percentage of feedback that mentions the topic.
  attribute(:occurrence_percentage, BrowseNodeOccurrence, from: "occurrencePercentage")
end

ItemReviewTopicMetrics = The item review topic metrics.

Structure.new do
  # @return [Integer] The number of times that reviews mention the topic. This value is `null` if reviews do not
  # mention the topic frequently enough.
  attribute?(:number_of_mentions, Integer, from: "numberOfMentions")

  # @return [Float] The percentage of customer reviews that mention the topic. This value is `null` if reviews do
  # not mention the topic frequently enough.
  attribute?(:occurrence_percentage, Float, from: "occurrencePercentage")

  # @return [Float] The effect of the topic on the star rating of the ASIN. This value can be positive or
  # negative. This value is `null` if the topic does't affect the star rating of the ASIN.
  attribute?(:star_rating_impact, Float, from: "starRatingImpact")
end

BrowseNodeAllOccurrence = The browse node review occurrence metrics.

Structure.new do
  # @return [Float] The percentage of reviews of products in the browse node that mention the topic.
  attribute(:all_products, Float, from: "allProducts")

  # @return [Float] The percentage of reviews of the top 25 percent of products in the browse node that mention
  # the topic.
  attribute(:top_twenty_five_percent_products, Float, from: "topTwentyFivePercentProducts")
end

ChildASINMentionMetrics = The child ASIN review topic mention metrics.

Structure.new do
  # @return [String] The child ASIN of the requested item.
  attribute(:asin, String)

  # @return [Integer] The number of times reviews of the child ASIN mention the topic.
  attribute(:number_of_mentions, Integer, from: "numberOfMentions")
end

ItemReviewTopicsResponse = The response for the getItemReviewTopics operation.

Structure.new do
  # @return [String] The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier
  # of a product within a marketplace.
  attribute(:asin, String)

  # @return [String] The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The date range of the item review topics.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The product title of the requested ASIN.
  attribute(:item_name, String, from: "itemName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [ItemReviewTopics] The item review topics for the requested ASIN.
  attribute(:topics, ItemReviewTopics)
end

ItemReviewTrendsResponse = The response for the getItemReviewTrends operation.

Structure.new do
  # @return [String] The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier
  # of a product within a marketplace.
  attribute(:asin, String)

  # @return [String] The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The range of dates in which the reviews were made.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The product title of the requested ASIN.
  attribute(:item_name, String, from: "itemName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [ItemReviewTrends] The item review trends.
  attribute(:review_trends, ItemReviewTrends, from: "reviewTrends")
end

ItemReviewSubtopicMetrics = The item review subtopic metrics.

Structure.new do
  # @return [Integer] The number of times that reviews mention the subtopic.
  attribute(:number_of_mentions, Integer, from: "numberOfMentions")

  # @return [Float] The percentage of reviews that mention the subtopic.
  attribute(:occurrence_percentage, Float, from: "occurrencePercentage")
end

BrowseNodeReturnTrendPoint = The return metrics for a certain month.

Structure.new do
  # @return [BrowseNodeTrendMetrics] The browse node return metrics.
  attribute(:browse_node_metrics, BrowseNodeTrendMetrics, from: "browseNodeMetrics")

  # @return [DateRange] The range of dates during which the returns were made.
  attribute(:date_range, DateRange, from: "dateRange")
end

BrowseNodeReviewTrendPoint = The browse node's review metrics for a certain month.

Structure.new do
  # @return [BrowseNodeReviewTrendMetrics] The browse node review trend metrics.
  attribute(:browse_node_metrics, BrowseNodeReviewTrendMetrics, from: "browseNodeMetrics")

  # @return [DateRange] The date range of the browse node review trend metric.
  attribute(:date_range, DateRange, from: "dateRange")
end

BrowseNodeStarRatingImpact = The effects of a topic on a browse node's star rating.

Structure.new do
  # @return [Float] The effect of the topic on the star rating for all products in this browse node. This value
  # can be positive or negative.
  attribute(:all_products, Float, from: "allProducts")
end

ItemReviewBrowseNodeMetrics = The browse node review topic metrics.

Structure.new do
  # @return [BrowseNodeOccurrence] The percentage of reviews that mention the topic. This value is `null` if
  # reviews do not mention the topic frequently enough.
  attribute?(:occurrence_percentage, BrowseNodeOccurrence, from: "occurrencePercentage")

  # @return [BrowseNodeStarRatingImpact] The effect of the topic on the star rating of items in the browse node.
  # This value is `null` if the topic does not affect the star rating of the browse node.
  attribute?(:star_rating_impact, BrowseNodeStarRatingImpact, from: "starRatingImpact")
end

BrowseNodeReviewTopicMetrics = The browse node review topic metrics.

Structure.new do
  # @return [BrowseNodeAllOccurrence] The percentage of reviews that mention a topic. This value is `null` if the
  # topic isn't mentioned enough in the reviews.
  attribute?(:occurrence_percentage, BrowseNodeAllOccurrence, from: "occurrencePercentage")

  # @return [BrowseNodeAllStarRatingImpact] The effect a topic has on the browse node's star rating. This value is
  # `null` if the topic doesn't affect the star rating of the browse node.
  attribute?(:star_rating_impact, BrowseNodeAllStarRatingImpact, from: "starRatingImpact")
end

BrowseNodeReviewTrendMetrics = The browse node review topic metrics.

Structure.new do
  # @return [BrowseNodeAllOccurrence] The percent of reviews that mention the topic.
  attribute(:occurrence_percentage, BrowseNodeAllOccurrence, from: "occurrencePercentage")
end

BrowseNodeAllStarRatingImpact = The effects of a topic on the star ratings in a browse node.

Structure.new do
  # @return [Float] The effect of the topic on the star rating of all products in the browse node. This value can
  # be positive or negative.
  attribute(:all_products, Float, from: "allProducts")

  # @return [Float] The effect of the topic on the star rating of the top 25 percent of products in the browse
  # node. This value can be positive or negative.
  attribute(:top_twenty_five_percent_products, Float, from: "topTwentyFivePercentProducts")
end

BrowseNodeReturnTopicsResponse = The response for the getBrowseNodeReturnTopics operation.

Structure.new do
  # @return [String] The requested browse node id. A browse node id is the unique identifier of a given browse
  # node.
  attribute(:browse_node_id, String, from: "browseNodeId")

  # @return [String] The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The range of dates during which the returns were made.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The display name of the browse node, as visible on the Amazon retail website.
  attribute(:display_name, String, from: "displayName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<BrowseNodeReturnTopics>] The list of browse node return topics.
  attribute(:topics, [BrowseNodeReturnTopics])
end

BrowseNodeReturnTrendsResponse = The response for the getBrowseNodeReturnTrends operation.

Structure.new do
  # @return [String] The requested browse node id. A browse node id is the unique identifier of a given browse
  # node.
  attribute(:browse_node_id, String, from: "browseNodeId")

  # @return [String] The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The range of dates during which the returns were made.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The display name of the browse node, as visible on the Amazon retail website.
  attribute(:display_name, String, from: "displayName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<BrowseNodeReturnTrend>] The browse node return trends.
  attribute(:return_trends, [BrowseNodeReturnTrend], from: "returnTrends")
end

BrowseNodeReviewTopicsResponse = The response for the getBrowseNodeReviewTopics operation.

Structure.new do
  # @return [String] The requested browse node id. A browse node id is the unique identifier of a given browse
  # node.
  attribute(:browse_node_id, String, from: "browseNodeId")

  # @return [String] The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The range of dates in which the reviews were made.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The display name of the requested browse node id. The display name of the browse node as
  # visible on the Amazon retail website.
  attribute(:display_name, String, from: "displayName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [BrowseNodeReviewTopics] The most positive and most negative topics for all items in the browse node.
  attribute(:topics, BrowseNodeReviewTopics)
end

BrowseNodeReviewTrendsResponse = The response for the getBrowseNodeReviewTrends operation.

Structure.new do
  # @return [String] The requested browse node id. A browse node id is the unique identifier of a given browse
  # node.
  attribute(:browse_node_id, String, from: "browseNodeId")

  # @return [String] The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [DateRange] The range of dates during which the reviews were made.
  attribute(:date_range, DateRange, from: "dateRange")

  # @return [String] The display name of the requested browse node id. The display name of the browse node as
  # visible on the Amazon retail website.
  attribute(:display_name, String, from: "displayName")

  # @return [String] The requested marketplace id.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [BrowseNodeReviewTrends] Browse Node review trends.
  attribute(:review_trends, BrowseNodeReviewTrends, from: "reviewTrends")
end

BrowseNodeReviewSubtopicMetrics = The browse node review subtopic metrics.

Structure.new do
  # @return [Float] The percentage of reviews that mention the subtopic.
  attribute(:occurrence_percentage, Float, from: "occurrencePercentage")
end

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

#get_browse_node_return_topics(browse_node_id, marketplace_id) ⇒ Peddler::Response
Retrieve the topics that customers mention when they return items in a browse node.
#get_browse_node_return_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response
Retrieve the trends of topics that customers mention when they return items in a browse node.
#get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by) ⇒ Peddler::Response
Retrieve a browse node's ten most positive and ten most negative review topics.
#get_browse_node_review_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response
Retrieve the positive and negative review trends of items in a browse node for the past six months.
#get_item_browse_node(asin, marketplace_id) ⇒ Peddler::Response
This API returns the associated browse node of the requested ASIN.
#get_item_review_topics(asin, marketplace_id, sort_by) ⇒ Peddler::Response
Retrieve an item's ten most positive and ten most negative review topics.
#get_item_review_trends(asin, marketplace_id) ⇒ Peddler::Response
Retrieve an item's positive and negative review trends for the past six months.

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_browse_node_return_topics(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve the topics that customers mention when they return items in a browse node.

named location in a browse tree that is used for navigation, product classification, and website content. refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

Parameters:

browse_node_id (String) —
A browse node ID is a unique identifier for a browse node. A browse node is a
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 112

def get_browse_node_return_topics(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/returns/topics"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReturnTopicsResponse }
  get(path, params:, parser:)
end

#get_browse_node_return_trends(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve the trends of topics that customers mention when they return items in a browse node.

Parameters:

browse_node_id (String) —
A browse node ID is a unique identifier of a browse node. A browse node is a
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 129

def get_browse_node_return_trends(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/returns/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReturnTrendsResponse }
  get(path, params:, parser:)
end

#get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve a browse node's ten most positive and ten most negative review topics.

is used for navigation, product classification, and website content. refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

Parameters:

browse_node_id (String) —
The ID of a browse node. A browse node is a named location in a browse tree that
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can
sort_by (String) —
The metric by which to sort the data in the response.

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 60

def get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/reviews/topics"
  params = {
    "marketplaceId" => marketplace_id,
    "sortBy" => sort_by,
  }.compact
  parser = -> { BrowseNodeReviewTopicsResponse }
  get(path, params:, parser:)
end

#get_browse_node_review_trends(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve the positive and negative review trends of items in a browse node for the past six months.

named location in a browse tree that is used for navigation, product classification, and website content. information, refer to Marketplace IDs.

Parameters:

browse_node_id (String) —
A browse node ID is a unique identifier of a browse node. A browse node is a
marketplace_id (String) —
The marketplace ID is the globally unique identifier of a marketplace. For more

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 95

def get_browse_node_review_trends(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/reviews/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReviewTrendsResponse }
  get(path, params:, parser:)
end

#get_item_browse_node(asin, marketplace_id) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.

within a marketplace. refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

Parameters:

asin (String) —
The Amazon Standard Identification Number (ASIN) is the unique identifier of a product
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 42

def get_item_browse_node(asin, marketplace_id)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/browseNode"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeResponse }
  get(path, params:, parser:)
end

#get_item_review_topics(asin, marketplace_id, sort_by) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve an item's ten most positive and ten most negative review topics.

within a marketplace. The value must be a child ASIN. refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

Parameters:

asin (String) —
The Amazon Standard Identification Number (ASIN) is the unique identifier of a product
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can
sort_by (String) —
The metric by which to sort data in the response.

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 23

def get_item_review_topics(asin, marketplace_id, sort_by)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/reviews/topics"
  params = {
    "marketplaceId" => marketplace_id,
    "sortBy" => sort_by,
  }.compact
  parser = -> { ItemReviewTopicsResponse }
  get(path, params:, parser:)
end

#get_item_review_trends(asin, marketplace_id) ⇒ `Peddler::Response`

Note:

This operation can make a static sandbox call.

Retrieve an item's positive and negative review trends for the past six months.

within a marketplace. This API takes child ASIN as an input. refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

Parameters:

asin (String) —
The Amazon Standard Identification Number (ASIN) is the unique identifier of a product
marketplace_id (String) —
The MarketplaceId is the globally unique identifier of a marketplace, you can

Returns:

(Peddler::Response) —
The API response

# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 78

def get_item_review_trends(asin, marketplace_id)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/reviews/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { ItemReviewTrendsResponse }
  get(path, params:, parser:)
end

Class: Peddler::APIs::CustomerFeedback20240601

Overview

Constant Summary collapse

Instance Attribute Summary

Attributes inherited from Peddler::API

Instance Method Summary collapse

Methods inherited from Peddler::API

Constructor Details

Instance Method Details

#get_browse_node_return_topics(browse_node_id, marketplace_id) ⇒ Peddler::Response

#get_browse_node_return_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response

#get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by) ⇒ Peddler::Response

#get_browse_node_review_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response

#get_item_browse_node(asin, marketplace_id) ⇒ Peddler::Response

#get_item_review_topics(asin, marketplace_id, sort_by) ⇒ Peddler::Response

#get_item_review_trends(asin, marketplace_id) ⇒ Peddler::Response

#get_browse_node_return_topics(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

#get_browse_node_return_trends(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

#get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by) ⇒ `Peddler::Response`

#get_browse_node_review_trends(browse_node_id, marketplace_id) ⇒ `Peddler::Response`

#get_item_browse_node(asin, marketplace_id) ⇒ `Peddler::Response`

#get_item_review_topics(asin, marketplace_id, sort_by) ⇒ `Peddler::Response`

#get_item_review_trends(asin, marketplace_id) ⇒ `Peddler::Response`