Class: MWS::Recommendations::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/recommendations/client.rb

Overview

The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance.

Instance Attribute Summary

Attributes inherited from Peddler::Client

#auth_token, #body, #marketplace_id, #merchant_id, #path

Instance Method Summary collapse

Methods inherited from Peddler::Client

#aws_endpoint, #defaults, #headers, inherited, #initialize, #marketplace, #on_error, #operation, parser, parser=, path, #run

Constructor Details

This class inherits a constructor from Peddler::Client

Instance Method Details

#get_last_updated_time_for_recommendations(marketplace_id = marketplace_id()) ⇒ Peddler::XMLParser

Checks whether there are active recommendations for each category for the given marketplace, and if there are, returns the time when recommendations were last updated for each category

Parameters:

  • marketplace_id (String) (defaults to: marketplace_id())

Returns:

See Also:



19
20
21
22
23
24
 
# File 'lib/mws/recommendations/client.rb', line 19

def get_last_updated_time_for_recommendations(marketplace_id = marketplace_id())
  operation('GetLastUpdatedTimeForRecommendations')
    .add('MarketplaceId' => marketplace_id)

  run
end

#get_service_status ⇒ Peddler::XMLParser

Gets the service status of the API

Returns:

See Also:



65
66
67
68
 
# File 'lib/mws/recommendations/client.rb', line 65

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_recommendations(opts = { marketplace_id: marketplace_id }) ⇒ Peddler::XMLParser

Lists active recommendations for a specific category or for all categories for a specific marketplace

Parameters:

  • opts (Hash) (defaults to: { marketplace_id: marketplace_id })

Options Hash (opts):

  • :marketplace_id (String)
  • :recommendation_category (String)
  • :category_query_list (Array<Struct, Hash>)

Returns:

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mws/recommendations/client.rb', line 36

def list_recommendations(opts = {})
  opts[:marketplace_id] ||= marketplace_id

  operation('ListRecommendations')
    .add(opts)
    .structure!(
      'CategoryQueryList', 'CategoryQuery', '1', 'FilterOptions',
      'FilterOption'
    )

  run
end

#list_recommendations_by_next_token(next_token) ⇒ Peddler::XMLParser

Lists the next page of active recommendations

Parameters:

  • next_token (String)

Returns:

See Also:



54
55
56
57
58
59
 
# File 'lib/mws/recommendations/client.rb', line 54

def list_recommendations_by_next_token(next_token)
  operation('ListRecommendationsByNextToken')
    .add('NextToken' => next_token)

  run
end