Class: Peddler::APIs::AplusContent20201101

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/aplus_content_2020_11_01.rb,
lib/peddler/apis/aplus_content_2020_11_01/error.rb,
lib/peddler/apis/aplus_content_2020_11_01/asin_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/decorator.rb,
lib/peddler/apis/aplus_content_2020_11_01/text_item.rb,
lib/peddler/apis/aplus_content_2020_11_01/error_list.rb,
lib/peddler/apis/aplus_content_2020_11_01/message_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/asin_metadata.rb,
lib/peddler/apis/aplus_content_2020_11_01/decorator_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/image_offsets.rb,
lib/peddler/apis/aplus_content_2020_11_01/aplus_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/asin_badge_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_record.rb,
lib/peddler/apis/aplus_content_2020_11_01/publish_record.rb,
lib/peddler/apis/aplus_content_2020_11_01/text_component.rb,
lib/peddler/apis/aplus_content_2020_11_01/image_component.rb,
lib/peddler/apis/aplus_content_2020_11_01/plain_text_item.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_document.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_metadata.rb,
lib/peddler/apis/aplus_content_2020_11_01/image_dimensions.rb,
lib/peddler/apis/aplus_content_2020_11_01/asin_metadata_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_badge_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/integer_with_units.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_module_list.rb,
lib/peddler/apis/aplus_content_2020_11_01/paragraph_component.rb,
lib/peddler/apis/aplus_content_2020_11_01/publish_record_list.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_text_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_text_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_metadata_record.rb,
lib/peddler/apis/aplus_content_2020_11_01/aplus_paginated_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/image_crop_specification.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_text_list_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_text_pair_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_reference_key_set.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_image_text_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_tech_specs_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/content_metadata_record_list.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_company_logo_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_image_caption_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/get_content_document_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_request.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_image_sidebar_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_four_image_text_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_header_text_list_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_comparison_table_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_three_image_text_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/search_content_documents_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_comparison_product_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_header_image_text_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_image_text_caption_block.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_single_side_image_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_image_text_overlay_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_multiple_image_text_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_product_description_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/search_content_publish_records_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_single_image_highlights_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_four_image_text_quadrant_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/standard_single_image_specs_detail_module.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_asin_relations_request.rb,
lib/peddler/apis/aplus_content_2020_11_01/list_content_document_asin_relations_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_asin_relations_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_suspend_submission_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/validate_content_document_asin_relations_response.rb,
lib/peddler/apis/aplus_content_2020_11_01/post_content_document_approval_submission_response.rb,
sig/peddler/apis/aplus_content_2020_11_01.rbs

Overview

Selling Partner API for A+ Content Management

Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.

See Also:

Defined Under Namespace

Classes: ASINBadgeSet, ASINMetadata, ASINMetadataSet, ASINSet, AplusPaginatedResponse, AplusResponse, ContentBadgeSet, ContentDocument, ContentMetadata, ContentMetadataRecord, ContentMetadataRecordList, ContentModule, ContentModuleList, ContentRecord, ContentReferenceKeySet, Decorator, DecoratorSet, Error, ErrorList, GetContentDocumentResponse, ImageComponent, ImageCropSpecification, ImageDimensions, ImageOffsets, IntegerWithUnits, ListContentDocumentASINRelationsResponse, MessageSet, ParagraphComponent, PlainTextItem, PostContentDocumentASINRelationsRequest, PostContentDocumentASINRelationsResponse, PostContentDocumentApprovalSubmissionResponse, PostContentDocumentRequest, PostContentDocumentResponse, PostContentDocumentSuspendSubmissionResponse, PublishRecord, PublishRecordList, SearchContentDocumentsResponse, SearchContentPublishRecordsResponse, StandardCompanyLogoModule, StandardComparisonProductBlock, StandardComparisonTableModule, StandardFourImageTextModule, StandardFourImageTextQuadrantModule, StandardHeaderImageTextModule, StandardHeaderTextListBlock, StandardImageCaptionBlock, StandardImageSidebarModule, StandardImageTextBlock, StandardImageTextCaptionBlock, StandardImageTextOverlayModule, StandardMultipleImageTextModule, StandardProductDescriptionModule, StandardSingleImageHighlightsModule, StandardSingleImageSpecsDetailModule, StandardSingleSideImageModule, StandardTechSpecsModule, StandardTextBlock, StandardTextListBlock, StandardTextModule, StandardTextPairBlock, StandardThreeImageTextModule, TextComponent, TextItem, ValidateContentDocumentASINRelationsResponse

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#create_content_document(marketplace_id, post_content_document_request, rate_limit: 10.0) ⇒ Peddler::Response

Creates a new A+ Content document.

Parameters:

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • post_content_document_request (Hash) —

    The content document request details.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 45

def create_content_document(marketplace_id, post_content_document_request, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments"
  body = post_content_document_request
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { PostContentDocumentResponse }
  post(path, body:, params:, rate_limit:, parser:)
end

#get_content_document(content_reference_key, marketplace_id, included_data_set, rate_limit: 10.0) ⇒ Peddler::Response

Returns an A+ Content document, if available.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • included_data_set (Array<String>) —

    The set of A+ Content data types to include in the response.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • (Array[String])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 68

def get_content_document(content_reference_key, marketplace_id, included_data_set, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}"
  params = {
    "marketplaceId" => marketplace_id,
    "includedDataSet" => stringify_array(included_data_set),
  }.compact
  parser = -> { GetContentDocumentResponse }
  get(path, params:, rate_limit:, parser:)
end

#list_content_document_asin_relations(content_reference_key, marketplace_id, included_data_set: nil, asin_set: nil, page_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don't include the asinSet parameter, this operation returns all ASINs related to the content document.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • included_data_set (Array<String>) (defaults to: nil) —

    The set of A+ Content data types to include in the response. If you don't include this parameter, the operation returns the related ASINs without metadata.

  • asin_set (Array<String>) (defaults to: nil) —

    The set of ASINs.

  • page_token (String) (defaults to: nil) —

    A token that you use to fetch a specific page when there are multiple pages of results.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • included_data_set: (Array[String], nil) (defaults to: nil)
  • asin_set: (Array[String], nil) (defaults to: nil)
  • page_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 120

def list_content_document_asin_relations(content_reference_key, marketplace_id, included_data_set: nil,
  asin_set: nil, page_token: nil, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}/asins"
  params = {
    "marketplaceId" => marketplace_id,
    "includedDataSet" => stringify_array(included_data_set),
    "asinSet" => stringify_array(asin_set),
    "pageToken" => page_token,
  }.compact
  parser = -> { ListContentDocumentASINRelationsResponse }
  get(path, params:, rate_limit:, parser:)
end

#post_content_document_approval_submission(content_reference_key, marketplace_id, rate_limit: 10.0) ⇒ Peddler::Response

Submits an A+ Content document for review, approval, and publishing.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 219

def post_content_document_approval_submission(content_reference_key, marketplace_id, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}/approvalSubmissions"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { PostContentDocumentApprovalSubmissionResponse }
  post(path, params:, rate_limit:, parser:)
end

#post_content_document_asin_relations(content_reference_key, marketplace_id, post_content_document_asin_relations_request, rate_limit: 10.0) ⇒ Peddler::Response

Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • post_content_document_asin_relations_request (Hash) —

    The request details for the content document ASIN relations.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 149

def post_content_document_asin_relations(content_reference_key, marketplace_id,
  post_content_document_asin_relations_request, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}/asins"
  body = post_content_document_asin_relations_request
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { PostContentDocumentASINRelationsResponse }
  post(path, body:, params:, rate_limit:, parser:)
end

#post_content_document_suspend_submission(content_reference_key, marketplace_id, rate_limit: 10.0) ⇒ Peddler::Response

Submits a request to suspend visible A+ Content. This doesn't delete the content document or the ASIN relations.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 240

def post_content_document_suspend_submission(content_reference_key, marketplace_id, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}/suspendSubmissions"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { PostContentDocumentSuspendSubmissionResponse }
  post(path, params:, rate_limit:, parser:)
end

#search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the getContentDocument operation.

Parameters:

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • page_token (String) (defaults to: nil) —

    A token that you use to fetch a specific page when there are multiple pages of results.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • page_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 25

def search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments"
  params = {
    "marketplaceId" => marketplace_id,
    "pageToken" => page_token,
  }.compact
  parser = -> { SearchContentDocumentsResponse }
  get(path, params:, rate_limit:, parser:)
end

#search_content_publish_records(marketplace_id, asin, page_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Searches for A+ Content publishing records, if available.

Parameters:

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.

  • page_token (String) (defaults to: nil) —

    A token that you use to fetch a specific page when there are multiple pages of results.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • page_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 196

def search_content_publish_records(marketplace_id, asin, page_token: nil, rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentPublishRecords"
  params = {
    "marketplaceId" => marketplace_id,
    "asin" => asin,
    "pageToken" => page_token,
  }.compact
  parser = -> { SearchContentPublishRecordsResponse }
  get(path, params:, rate_limit:, parser:)
end

#update_content_document(content_reference_key, marketplace_id, post_content_document_request, rate_limit: 10.0) ⇒ Peddler::Response

Updates an existing A+ Content document.

Parameters:

  • content_reference_key (String) —

    The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • post_content_document_request (Hash) —

    The content document request details.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (String)
  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 91

def update_content_document(content_reference_key, marketplace_id, post_content_document_request,
  rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentDocuments/#{percent_encode(content_reference_key)}"
  body = post_content_document_request
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { PostContentDocumentResponse }
  post(path, body:, params:, rate_limit:, parser:)
end

#validate_content_document_asin_relations(marketplace_id, post_content_document_request, asin_set: nil, rate_limit: 10.0) ⇒ Peddler::Response

Checks if the A+ Content document is valid for use on a set of ASINs.

Parameters:

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

  • asin_set (Array<String>) (defaults to: nil) —

    The set of ASINs.

  • post_content_document_request (Hash) —

    The content document request details.

  • rate_limit (Float) (defaults to: 10.0) —

    Requests per second

  • (String)
  • (Hash[untyped, untyped])
  • asin_set: (Array[String], nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/peddler/apis/aplus_content_2020_11_01.rb', line 171

def validate_content_document_asin_relations(marketplace_id, post_content_document_request, asin_set: nil,
  rate_limit: 10.0)
  cannot_sandbox!

  path = "/aplus/2020-11-01/contentAsinValidations"
  body = post_content_document_request
  params = {
    "marketplaceId" => marketplace_id,
    "asinSet" => stringify_array(asin_set),
  }.compact
  parser = -> { ValidateContentDocumentASINRelationsResponse }
  post(path, body:, params:, rate_limit:, parser:)
end