AmzSpApi::AplusContentApiModel::AplusContentApi
¶ ↑
All URIs are relative to https://sellingpartnerapi-na.amazon.com/
Method | HTTP request | Description ————- | ————- | ————- {create_content_document} | POST /aplus/2020-11-01/contentDocuments | {get_content_document} | GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey} | {list_content_document_asin_relations} | GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins | {post_content_document_approval_submission} | POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions | {post_content_document_asin_relations} | POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins | {post_content_document_suspend_submission} | POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions | {search_content_documents} | GET /aplus/2020-11-01/contentDocuments | {search_content_publish_records} | GET /aplus/2020-11-01/contentPublishRecords | {update_content_document} | POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey} | {validate_content_document_asin_relations} | POST /aplus/2020-11-01/contentAsinValidations |
create_content_document¶ ↑
PostContentDocumentResponse create_content_document(bodymarketplace_id)
Creates a new A+ Content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new body = AmzSpApi::AplusContentApiModel::PostContentDocumentRequest.new # PostContentDocumentRequest | The content document request details. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. begin result = api_instance.create_content_document(bodymarketplace_id) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->create_content_document: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {PostContentDocumentRequest}| The content document request details. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. |
Return type¶ ↑
{PostContentDocumentResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/json
get_content_document¶ ↑
GetContentDocumentResponse get_content_document(content_reference_key, marketplace_id, included_data_set)
Returns an A+ Content document, if available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. included_data_set = ['included_data_set_example'] # Array<String> | The set of A+ Content data types to include in the response. begin result = api_instance.get_content_document(content_reference_key, marketplace_id, included_data_set) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->get_content_document: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | included_data_set | {Array<String>}| The set of A+ Content data types to include in the response. |
Return type¶ ↑
{GetContentDocumentResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
list_content_document_asin_relations¶ ↑
ListContentDocumentAsinRelationsResponse list_content_document_asin_relations(content_reference_key, marketplace_id, opts)
Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. opts = { included_data_set: ['included_data_set_example'], # Array<String> | The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata. asin_set: ['asin_set_example'], # Array<String> | The set of ASINs. page_token: 'page_token_example' # String | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. } begin result = api_instance.list_content_document_asin_relations(content_reference_key, marketplace_id, opts) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->list_content_document_asin_relations: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | included_data_set | {Array<String>}| The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata. | [optional] asin_set | {Array<String>}| The set of ASINs. | [optional] page_token | String| A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. | [optional]
Return type¶ ↑
{ListContentDocumentAsinRelationsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
post_content_document_approval_submission¶ ↑
PostContentDocumentApprovalSubmissionResponse post_content_document_approval_submission(content_reference_key, marketplace_id)
Submits an A+ Content document for review, approval, and publishing. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. begin result = api_instance.post_content_document_approval_submission(content_reference_key, marketplace_id) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->post_content_document_approval_submission: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. |
Return type¶ ↑
{PostContentDocumentApprovalSubmissionResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
post_content_document_asin_relations¶ ↑
PostContentDocumentAsinRelationsResponse post_content_document_asin_relations(bodymarketplace_idcontent_reference_key)
Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new body = AmzSpApi::AplusContentApiModel::PostContentDocumentAsinRelationsRequest.new # PostContentDocumentAsinRelationsRequest | The content document ASIN relations request details. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. begin result = api_instance.post_content_document_asin_relations(bodymarketplace_idcontent_reference_key) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->post_content_document_asin_relations: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {PostContentDocumentAsinRelationsRequest}| The content document ASIN relations request details. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. |
Return type¶ ↑
{PostContentDocumentAsinRelationsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/json
post_content_document_suspend_submission¶ ↑
PostContentDocumentSuspendSubmissionResponse post_content_document_suspend_submission(content_reference_key, marketplace_id)
Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. begin result = api_instance.post_content_document_suspend_submission(content_reference_key, marketplace_id) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->post_content_document_suspend_submission: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. |
Return type¶ ↑
{PostContentDocumentSuspendSubmissionResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
search_content_documents¶ ↑
SearchContentDocumentsResponse search_content_documents(marketplace_id, opts)
Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. opts = { page_token: 'page_token_example' # String | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. } begin result = api_instance.search_content_documents(marketplace_id, opts) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->search_content_documents: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | page_token | String| A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. | [optional]
Return type¶ ↑
{SearchContentDocumentsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
search_content_publish_records¶ ↑
SearchContentPublishRecordsResponse search_content_publish_records(marketplace_id, asin, opts)
Searches for A+ Content publishing records, if available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. asin = 'asin_example' # String | The Amazon Standard Identification Number (ASIN). opts = { page_token: 'page_token_example' # String | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. } begin result = api_instance.search_content_publish_records(marketplace_id, asin, opts) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->search_content_publish_records: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | asin | String| The Amazon Standard Identification Number (ASIN). | page_token | String| A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations. | [optional]
Return type¶ ↑
{SearchContentPublishRecordsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/json
update_content_document¶ ↑
PostContentDocumentResponse update_content_document(bodymarketplace_idcontent_reference_key)
Updates an existing A+ Content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new body = AmzSpApi::AplusContentApiModel::PostContentDocumentRequest.new # PostContentDocumentRequest | The content document request details. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. content_reference_key = 'content_reference_key_example' # String | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. begin result = api_instance.update_content_document(bodymarketplace_idcontent_reference_key) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->update_content_document: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {PostContentDocumentRequest}| The content document request details. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | content_reference_key | String| The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier. |
Return type¶ ↑
{PostContentDocumentResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/json
validate_content_document_asin_relations¶ ↑
ValidateContentDocumentAsinRelationsResponse validate_content_document_asin_relations(bodymarketplace_id, opts)
Checks if the A+ Content document is valid for use on a set of ASINs. Usage Plans: | Plan type | Rate (requests per second) | Burst | | —- | —- | —- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
Example¶ ↑
# load the gem require 'aplus-content-api-model' api_instance = AmzSpApi::AplusContentApiModel::AplusContentApi.new body = AmzSpApi::AplusContentApiModel::PostContentDocumentRequest.new # PostContentDocumentRequest | The content document request details. marketplace_id = 'marketplace_id_example' # String | The identifier for the marketplace where the A+ Content is published. opts = { asin_set: ['asin_set_example'] # Array<String> | The set of ASINs. } begin result = api_instance.validate_content_document_asin_relations(bodymarketplace_id, opts) p result rescue AmzSpApi::AplusContentApiModel::ApiError => e puts "Exception when calling AplusContentApi->validate_content_document_asin_relations: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {PostContentDocumentRequest}| The content document request details. | marketplace_id | String| The identifier for the marketplace where the A+ Content is published. | asin_set | {Array<String>}| The set of ASINs. | [optional]
Return type¶ ↑
{ValidateContentDocumentAsinRelationsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/json