swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

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

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2020-11-01
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request
AplusContentApi	CreateContentDocument	Post /aplus/2020-11-01/contentDocuments
AplusContentApi	GetContentDocument	Get /aplus/2020-11-01/contentDocuments/{contentReferenceKey}
AplusContentApi	ListContentDocumentAsinRelations	Get /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins
AplusContentApi	PostContentDocumentApprovalSubmission	Post /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions
AplusContentApi	PostContentDocumentAsinRelations	Post /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins
AplusContentApi	PostContentDocumentSuspendSubmission	Post /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions
AplusContentApi	SearchContentDocuments	Get /aplus/2020-11-01/contentDocuments
AplusContentApi	SearchContentPublishRecords	Get /aplus/2020-11-01/contentPublishRecords
AplusContentApi	UpdateContentDocument	Post /aplus/2020-11-01/contentDocuments/{contentReferenceKey}
AplusContentApi	ValidateContentDocumentAsinRelations	Post /aplus/2020-11-01/contentAsinValidations

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for A+ Content Management * * With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text. * * API version: 2020-11-01 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AplusContentApiListContentDocumentAsinRelationsOpts
type AplusContentApiSearchContentDocumentsOpts
type AplusContentApiSearchContentPublishRecordsOpts
type AplusContentApiService
- func (a *AplusContentApiService) CreateContentDocument(ctx context.Context, body PostContentDocumentRequest, marketplaceId string) (PostContentDocumentResponse, *http.Response, error)
- func (a *AplusContentApiService) GetContentDocument(ctx context.Context, contentReferenceKey string, marketplaceId string, ...) (GetContentDocumentResponse, *http.Response, error)
- func (a *AplusContentApiService) ListContentDocumentAsinRelations(ctx context.Context, contentReferenceKey string, marketplaceId string, ...) (ListContentDocumentAsinRelationsResponse, *http.Response, error)
- func (a *AplusContentApiService) PostContentDocumentApprovalSubmission(ctx context.Context, contentReferenceKey string, marketplaceId string) (PostContentDocumentApprovalSubmissionResponse, *http.Response, error)
- func (a *AplusContentApiService) PostContentDocumentAsinRelations(ctx context.Context, body PostContentDocumentAsinRelationsRequest, ...) (PostContentDocumentAsinRelationsResponse, *http.Response, error)
- func (a *AplusContentApiService) PostContentDocumentSuspendSubmission(ctx context.Context, contentReferenceKey string, marketplaceId string) (PostContentDocumentSuspendSubmissionResponse, *http.Response, error)
- func (a *AplusContentApiService) SearchContentDocuments(ctx context.Context, marketplaceId string, ...) (SearchContentDocumentsResponse, *http.Response, error)
- func (a *AplusContentApiService) SearchContentPublishRecords(ctx context.Context, marketplaceId string, asin string, ...) (SearchContentPublishRecordsResponse, *http.Response, error)
- func (a *AplusContentApiService) UpdateContentDocument(ctx context.Context, body PostContentDocumentRequest, marketplaceId string, ...) (PostContentDocumentResponse, *http.Response, error)
- func (a *AplusContentApiService) ValidateContentDocumentAsinRelations(ctx context.Context, body PostContentDocumentRequest, marketplaceId string, ...) (ValidateContentDocumentAsinRelationsResponse, *http.Response, error)
type AplusContentApiValidateContentDocumentAsinRelationsOpts
type AplusPaginatedResponse
type AplusResponse
type AsinBadge
type AsinMetadata
type BasicAuth
type ColorType
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ContentBadge
type ContentDocument
type ContentMetadata
type ContentMetadataRecord
type ContentModule
type ContentModuleType
type ContentRecord
type ContentStatus
type ContentType
type Decorator
type DecoratorType
type ErrorList
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetContentDocumentResponse
type ImageComponent
type ImageCropSpecification
type ImageDimensions
type ImageOffsets
type IntegerWithUnits
type ListContentDocumentAsinRelationsResponse
type ModelError
type ParagraphComponent
type PlainTextItem
type PositionType
type PostContentDocumentApprovalSubmissionResponse
type PostContentDocumentAsinRelationsRequest
type PostContentDocumentAsinRelationsResponse
type PostContentDocumentRequest
type PostContentDocumentResponse
type PostContentDocumentSuspendSubmissionResponse
type PublishRecord
type SearchContentDocumentsResponse
type SearchContentPublishRecordsResponse
type StandardCompanyLogoModule
type StandardComparisonProductBlock
type StandardComparisonTableModule
type StandardFourImageTextModule
type StandardFourImageTextQuadrantModule
type StandardHeaderImageTextModule
type StandardHeaderTextListBlock
type StandardImageCaptionBlock
type StandardImageSidebarModule
type StandardImageTextBlock
type StandardImageTextCaptionBlock
type StandardImageTextOverlayModule
type StandardMultipleImageTextModule
type StandardProductDescriptionModule
type StandardSingleImageHighlightsModule
type StandardSingleImageSpecsDetailModule
type StandardSingleSideImageModule
type StandardTechSpecsModule
type StandardTextBlock
type StandardTextListBlock
type StandardTextModule
type StandardTextPairBlock
type StandardThreeImageTextModule
type TextComponent
type TextItem
type ValidateContentDocumentAsinRelationsResponse

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AplusContentApi *AplusContentApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for A+ Content Management API v2020-11-01 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AplusContentApiListContentDocumentAsinRelationsOpts ¶

type AplusContentApiListContentDocumentAsinRelationsOpts struct {
	IncludedDataSet optional.Interface
	AsinSet         optional.Interface
	PageToken       optional.String
}

type AplusContentApiSearchContentDocumentsOpts ¶

type AplusContentApiSearchContentDocumentsOpts struct {
	PageToken optional.String
}

type AplusContentApiSearchContentPublishRecordsOpts ¶

type AplusContentApiSearchContentPublishRecordsOpts struct {
	PageToken optional.String
}

type AplusContentApiService ¶

type AplusContentApiService service

func (*AplusContentApiService) CreateContentDocument ¶

func (a *AplusContentApiService) CreateContentDocument(ctx context.Context, body PostContentDocumentRequest, marketplaceId string) (PostContentDocumentResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The content document request details.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.

@return PostContentDocumentResponse

func (*AplusContentApiService) GetContentDocument ¶

func (a *AplusContentApiService) GetContentDocument(ctx context.Context, contentReferenceKey string, marketplaceId string, includedDataSet []string) (GetContentDocumentResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contentReferenceKey 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.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.
@param includedDataSet The set of A+ Content data types to include in the response.

@return GetContentDocumentResponse

func (*AplusContentApiService) ListContentDocumentAsinRelations ¶

func (a *AplusContentApiService) ListContentDocumentAsinRelations(ctx context.Context, contentReferenceKey string, marketplaceId string, localVarOptionals *AplusContentApiListContentDocumentAsinRelationsOpts) (ListContentDocumentAsinRelationsResponse, *http.Response, error)

func (*AplusContentApiService) PostContentDocumentApprovalSubmission ¶

func (a *AplusContentApiService) PostContentDocumentApprovalSubmission(ctx context.Context, contentReferenceKey string, marketplaceId string) (PostContentDocumentApprovalSubmissionResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contentReferenceKey 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.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.

@return PostContentDocumentApprovalSubmissionResponse

func (*AplusContentApiService) PostContentDocumentAsinRelations ¶

func (a *AplusContentApiService) PostContentDocumentAsinRelations(ctx context.Context, body PostContentDocumentAsinRelationsRequest, marketplaceId string, contentReferenceKey string) (PostContentDocumentAsinRelationsResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The content document ASIN relations request details.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.
@param contentReferenceKey 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 PostContentDocumentAsinRelationsResponse

func (*AplusContentApiService) PostContentDocumentSuspendSubmission ¶

func (a *AplusContentApiService) PostContentDocumentSuspendSubmission(ctx context.Context, contentReferenceKey string, marketplaceId string) (PostContentDocumentSuspendSubmissionResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contentReferenceKey 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.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.

@return PostContentDocumentSuspendSubmissionResponse

func (*AplusContentApiService) SearchContentDocuments ¶

func (a *AplusContentApiService) SearchContentDocuments(ctx context.Context, marketplaceId string, localVarOptionals *AplusContentApiSearchContentDocumentsOpts) (SearchContentDocumentsResponse, *http.Response, error)

func (*AplusContentApiService) SearchContentPublishRecords ¶

func (a *AplusContentApiService) SearchContentPublishRecords(ctx context.Context, marketplaceId string, asin string, localVarOptionals *AplusContentApiSearchContentPublishRecordsOpts) (SearchContentPublishRecordsResponse, *http.Response, error)

func (*AplusContentApiService) UpdateContentDocument ¶

func (a *AplusContentApiService) UpdateContentDocument(ctx context.Context, body PostContentDocumentRequest, marketplaceId string, contentReferenceKey string) (PostContentDocumentResponse, *http.Response, error)

AplusContentApiService 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.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The content document request details.
@param marketplaceId The identifier for the marketplace where the A+ Content is published.
@param contentReferenceKey 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 PostContentDocumentResponse

func (*AplusContentApiService) ValidateContentDocumentAsinRelations ¶

func (a *AplusContentApiService) ValidateContentDocumentAsinRelations(ctx context.Context, body PostContentDocumentRequest, marketplaceId string, localVarOptionals *AplusContentApiValidateContentDocumentAsinRelationsOpts) (ValidateContentDocumentAsinRelationsResponse, *http.Response, error)

type AplusContentApiValidateContentDocumentAsinRelationsOpts ¶

type AplusContentApiValidateContentDocumentAsinRelationsOpts struct {
	AsinSet optional.Interface
}

type AplusPaginatedResponse ¶

type AplusPaginatedResponse struct {
	Warnings      *[]ModelError `json:"warnings,omitempty"`
	NextPageToken string        `json:"nextPageToken,omitempty"`
}

The base response data for paginated A+ Content operations. Individual operations may extend this with additional data. If nextPageToken is not returned, there are no more pages to return.

type AplusResponse ¶

type AplusResponse struct {
	Warnings *[]ModelError `json:"warnings,omitempty"`
}

The base response data for all A+ Content operations when a request is successful or partially successful. Individual operations may extend this with additional data.

type AsinBadge ¶

type AsinBadge string

AsinBadge : A flag that provides additional information about an ASIN. This is contextual and may change depending on the request that generated it.

const (
	BRAND_NOT_ELIGIBLE_AsinBadge    AsinBadge = "BRAND_NOT_ELIGIBLE"
	CATALOG_NOT_FOUND_AsinBadge     AsinBadge = "CATALOG_NOT_FOUND"
	CONTENT_NOT_PUBLISHED_AsinBadge AsinBadge = "CONTENT_NOT_PUBLISHED"
	CONTENT_PUBLISHED_AsinBadge     AsinBadge = "CONTENT_PUBLISHED"
)

List of AsinBadge

type AsinMetadata ¶

type AsinMetadata struct {
	Asin     string       `json:"asin"`
	BadgeSet *[]AsinBadge `json:"badgeSet,omitempty"`
	Parent   string       `json:"parent,omitempty"`
	// The title for the ASIN in the Amazon catalog.
	Title string `json:"title,omitempty"`
	// The default image for the ASIN in the Amazon catalog.
	ImageUrl               string    `json:"imageUrl,omitempty"`
	ContentReferenceKeySet *[]string `json:"contentReferenceKeySet,omitempty"`
}

The A+ Content ASIN with additional metadata for content management. If you don't include the `includedDataSet` parameter in a call to the listContentDocumentAsinRelations operation, the related ASINs are returned without metadata.

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ColorType ¶

type ColorType string

ColorType : The relative color scheme of content.

const (
	DARK_ColorType  ColorType = "DARK"
	LIGHT_ColorType ColorType = "LIGHT"
)

List of ColorType

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ContentBadge ¶

type ContentBadge string

ContentBadge : A flag that provides additional information about an A+ Content document.

const (
	BULK_ContentBadge      ContentBadge = "BULK"
	GENERATED_ContentBadge ContentBadge = "GENERATED"
	LAUNCHPAD_ContentBadge ContentBadge = "LAUNCHPAD"
	PREMIUM_ContentBadge   ContentBadge = "PREMIUM"
	STANDARD_ContentBadge  ContentBadge = "STANDARD"
)

List of ContentBadge

type ContentDocument ¶

type ContentDocument struct {
	// The A+ Content document name.
	Name              string           `json:"name"`
	ContentType       *ContentType     `json:"contentType"`
	ContentSubType    string           `json:"contentSubType,omitempty"`
	Locale            string           `json:"locale"`
	ContentModuleList *[]ContentModule `json:"contentModuleList"`
}

The A+ Content document. This is the enhanced content that is published to product detail pages.

type ContentMetadata ¶

type ContentMetadata struct {
	// The A+ Content document name.
	Name          string          `json:"name"`
	MarketplaceId string          `json:"marketplaceId"`
	Status        *ContentStatus  `json:"status"`
	BadgeSet      *[]ContentBadge `json:"badgeSet"`
	// The approximate age of the A+ Content document and metadata.
	UpdateTime time.Time `json:"updateTime"`
}

The metadata of an A+ Content document.

type ContentMetadataRecord ¶

type ContentMetadataRecord struct {
	ContentReferenceKey string           `json:"contentReferenceKey"`
	ContentMetadata     *ContentMetadata `json:"contentMetadata"`
}

The metadata for an A+ Content document, with additional information for content management.

type ContentModule ¶

type ContentModule struct {
	ContentModuleType              *ContentModuleType                    `json:"contentModuleType"`
	StandardCompanyLogo            *StandardCompanyLogoModule            `json:"standardCompanyLogo,omitempty"`
	StandardComparisonTable        *StandardComparisonTableModule        `json:"standardComparisonTable,omitempty"`
	StandardFourImageText          *StandardFourImageTextModule          `json:"standardFourImageText,omitempty"`
	StandardFourImageTextQuadrant  *StandardFourImageTextQuadrantModule  `json:"standardFourImageTextQuadrant,omitempty"`
	StandardHeaderImageText        *StandardHeaderImageTextModule        `json:"standardHeaderImageText,omitempty"`
	StandardImageSidebar           *StandardImageSidebarModule           `json:"standardImageSidebar,omitempty"`
	StandardImageTextOverlay       *StandardImageTextOverlayModule       `json:"standardImageTextOverlay,omitempty"`
	StandardMultipleImageText      *StandardMultipleImageTextModule      `json:"standardMultipleImageText,omitempty"`
	StandardProductDescription     *StandardProductDescriptionModule     `json:"standardProductDescription,omitempty"`
	StandardSingleImageHighlights  *StandardSingleImageHighlightsModule  `json:"standardSingleImageHighlights,omitempty"`
	StandardSingleImageSpecsDetail *StandardSingleImageSpecsDetailModule `json:"standardSingleImageSpecsDetail,omitempty"`
	StandardSingleSideImage        *StandardSingleSideImageModule        `json:"standardSingleSideImage,omitempty"`
	StandardTechSpecs              *StandardTechSpecsModule              `json:"standardTechSpecs,omitempty"`
	StandardText                   *StandardTextModule                   `json:"standardText,omitempty"`
	StandardThreeImageText         *StandardThreeImageTextModule         `json:"standardThreeImageText,omitempty"`
}

An A+ Content module. An A+ Content document is composed of content modules. The contentModuleType property selects which content module types to use.

type ContentModuleType ¶

type ContentModuleType string

ContentModuleType : The type of A+ Content module.

const (
	COMPANY_LOGO_ContentModuleType              ContentModuleType = "STANDARD_COMPANY_LOGO"
	COMPARISON_TABLE_ContentModuleType          ContentModuleType = "STANDARD_COMPARISON_TABLE"
	FOUR_IMAGE_TEXT_ContentModuleType           ContentModuleType = "STANDARD_FOUR_IMAGE_TEXT"
	FOUR_IMAGE_TEXT_QUADRANT_ContentModuleType  ContentModuleType = "STANDARD_FOUR_IMAGE_TEXT_QUADRANT"
	HEADER_IMAGE_TEXT_ContentModuleType         ContentModuleType = "STANDARD_HEADER_IMAGE_TEXT"
	IMAGE_SIDEBAR_ContentModuleType             ContentModuleType = "STANDARD_IMAGE_SIDEBAR"
	IMAGE_TEXT_OVERLAY_ContentModuleType        ContentModuleType = "STANDARD_IMAGE_TEXT_OVERLAY"
	MULTIPLE_IMAGE_TEXT_ContentModuleType       ContentModuleType = "STANDARD_MULTIPLE_IMAGE_TEXT"
	PRODUCT_DESCRIPTION_ContentModuleType       ContentModuleType = "STANDARD_PRODUCT_DESCRIPTION"
	SINGLE_IMAGE_HIGHLIGHTS_ContentModuleType   ContentModuleType = "STANDARD_SINGLE_IMAGE_HIGHLIGHTS"
	SINGLE_IMAGE_SPECS_DETAIL_ContentModuleType ContentModuleType = "STANDARD_SINGLE_IMAGE_SPECS_DETAIL"
	SINGLE_SIDE_IMAGE_ContentModuleType         ContentModuleType = "STANDARD_SINGLE_SIDE_IMAGE"
	TECH_SPECS_ContentModuleType                ContentModuleType = "STANDARD_TECH_SPECS"
	TEXT_ContentModuleType                      ContentModuleType = "STANDARD_TEXT"
	THREE_IMAGE_TEXT_ContentModuleType          ContentModuleType = "STANDARD_THREE_IMAGE_TEXT"
)

List of ContentModuleType

type ContentRecord ¶

type ContentRecord struct {
	ContentReferenceKey string           `json:"contentReferenceKey"`
	ContentMetadata     *ContentMetadata `json:"contentMetadata,omitempty"`
	ContentDocument     *ContentDocument `json:"contentDocument,omitempty"`
}

A content document with additional information for content management.

type ContentStatus ¶

type ContentStatus string

ContentStatus : The submission status of the content document.

const (
	APPROVED_ContentStatus  ContentStatus = "APPROVED"
	DRAFT_ContentStatus     ContentStatus = "DRAFT"
	REJECTED_ContentStatus  ContentStatus = "REJECTED"
	SUBMITTED_ContentStatus ContentStatus = "SUBMITTED"
)

List of ContentStatus

type ContentType ¶

type ContentType string

ContentType : The A+ Content document type.

const (
	EBC_ContentType ContentType = "EBC"
	EMC_ContentType ContentType = "EMC"
)

List of ContentType

type Decorator ¶

type Decorator struct {
	Type_ *DecoratorType `json:"type,omitempty"`
	// The starting character of this decorator within the content string. Use zero for the first character.
	Offset int32 `json:"offset,omitempty"`
	// The number of content characters to alter with this decorator. Decorators such as line breaks can have zero length and fit between characters.
	Length int32 `json:"length,omitempty"`
	// The relative intensity or variation of this decorator. Decorators such as bullet-points, for example, can have multiple indentation depths.
	Depth int32 `json:"depth,omitempty"`
}

A decorator applied to a content string value in order to create rich text.

type DecoratorType ¶

type DecoratorType string

DecoratorType : The type of rich text decorator.

const (
	LIST_ITEM_DecoratorType       DecoratorType = "LIST_ITEM"
	LIST_ORDERED_DecoratorType    DecoratorType = "LIST_ORDERED"
	LIST_UNORDERED_DecoratorType  DecoratorType = "LIST_UNORDERED"
	STYLE_BOLD_DecoratorType      DecoratorType = "STYLE_BOLD"
	STYLE_ITALIC_DecoratorType    DecoratorType = "STYLE_ITALIC"
	STYLE_LINEBREAK_DecoratorType DecoratorType = "STYLE_LINEBREAK"
	STYLE_PARAGRAPH_DecoratorType DecoratorType = "STYLE_PARAGRAPH"
	STYLE_UNDERLINE_DecoratorType DecoratorType = "STYLE_UNDERLINE"
)

List of DecoratorType

type ErrorList ¶

type ErrorList struct {
	// A list of error responses returned when a request is unsuccessful.
	Errors []ModelError `json:"errors"`
}

The error response for when a request is unsuccessful.

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetContentDocumentResponse ¶

type GetContentDocumentResponse struct {
	Warnings      *[]ModelError  `json:"warnings,omitempty"`
	ContentRecord *ContentRecord `json:"contentRecord"`
}

type ImageComponent ¶

type ImageComponent struct {
	// This identifier is provided by the Selling Partner API for Uploads.
	UploadDestinationId    string                  `json:"uploadDestinationId"`
	ImageCropSpecification *ImageCropSpecification `json:"imageCropSpecification"`
	// The alternative text for the image.
	AltText string `json:"altText"`
}

A reference to an image, hosted in the A+ Content media library.

type ImageCropSpecification ¶

type ImageCropSpecification struct {
	Size   *ImageDimensions `json:"size"`
	Offset *ImageOffsets    `json:"offset,omitempty"`
}

The instructions for optionally cropping an image. If no cropping is desired, set the dimensions to the original image size. If the image is cropped and no offset values are provided, then the coordinates of the top left corner of the cropped image, relative to the original image, are defaulted to (0,0).

type ImageDimensions ¶

type ImageDimensions struct {
	Width  *IntegerWithUnits `json:"width"`
	Height *IntegerWithUnits `json:"height"`
}

The dimensions extending from the top left corner of the cropped image, or the top left corner of the original image if there is no cropping. Only `pixels` is allowed as the units value for ImageDimensions.

type ImageOffsets ¶

type ImageOffsets struct {
	X *IntegerWithUnits `json:"x"`
	Y *IntegerWithUnits `json:"y"`
}

The top left corner of the cropped image, specified in the original image's coordinate space.

type IntegerWithUnits ¶

type IntegerWithUnits struct {
	// The dimension value.
	Value int32 `json:"value"`
	// The unit of measurement.
	Units string `json:"units"`
}

A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.

type ListContentDocumentAsinRelationsResponse ¶

type ListContentDocumentAsinRelationsResponse struct {
	NextPageToken   string          `json:"nextPageToken,omitempty"`
	AsinMetadataSet *[]AsinMetadata `json:"asinMetadataSet"`
}

type ModelError ¶

type ModelError struct {
	// The code that identifies the type of error condition.
	Code string `json:"code"`
	// A human readable description of the error condition.
	Message string `json:"message"`
	// Additional information, if available, to clarify the error condition.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type ParagraphComponent ¶

type ParagraphComponent struct {
	TextList []TextComponent `json:"textList"`
}

A list of rich text content, usually presented in a text box.

type PlainTextItem ¶

type PlainTextItem struct {
	// The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.
	Position int32 `json:"position"`
	// The actual plain text.
	Value string `json:"value"`
}

Plain positional text, used in collections of brief labels and descriptors.

type PositionType ¶

type PositionType string

PositionType : The relative positioning of content.

const (
	LEFT_PositionType  PositionType = "LEFT"
	RIGHT_PositionType PositionType = "RIGHT"
)

List of PositionType

type PostContentDocumentApprovalSubmissionResponse ¶

type PostContentDocumentApprovalSubmissionResponse struct {
	Warnings *[]ModelError `json:"warnings,omitempty"`
}

type PostContentDocumentAsinRelationsRequest ¶

type PostContentDocumentAsinRelationsRequest struct {
	AsinSet *[]string `json:"asinSet"`
}

type PostContentDocumentAsinRelationsResponse ¶

type PostContentDocumentAsinRelationsResponse struct {
	Warnings *[]ModelError `json:"warnings,omitempty"`
}

type PostContentDocumentRequest ¶

type PostContentDocumentRequest struct {
	ContentDocument *ContentDocument `json:"contentDocument"`
}

type PostContentDocumentResponse ¶

type PostContentDocumentResponse struct {
	Warnings            *[]ModelError `json:"warnings,omitempty"`
	ContentReferenceKey string        `json:"contentReferenceKey"`
}

type PostContentDocumentSuspendSubmissionResponse ¶

type PostContentDocumentSuspendSubmissionResponse struct {
	Warnings *[]ModelError `json:"warnings,omitempty"`
}

type PublishRecord ¶

type PublishRecord struct {
	MarketplaceId       string       `json:"marketplaceId"`
	Locale              string       `json:"locale"`
	Asin                string       `json:"asin"`
	ContentType         *ContentType `json:"contentType"`
	ContentSubType      string       `json:"contentSubType,omitempty"`
	ContentReferenceKey string       `json:"contentReferenceKey"`
}

The full context for an A+ Content publishing event.

type SearchContentDocumentsResponse ¶

type SearchContentDocumentsResponse struct {
	NextPageToken          string                   `json:"nextPageToken,omitempty"`
	ContentMetadataRecords *[]ContentMetadataRecord `json:"contentMetadataRecords"`
}

type SearchContentPublishRecordsResponse ¶

type SearchContentPublishRecordsResponse struct {
	NextPageToken     string           `json:"nextPageToken,omitempty"`
	PublishRecordList *[]PublishRecord `json:"publishRecordList"`
}

type StandardCompanyLogoModule ¶

type StandardCompanyLogoModule struct {
	CompanyLogo *ImageComponent `json:"companyLogo"`
}

The standard company logo image.

type StandardComparisonProductBlock ¶

type StandardComparisonProductBlock struct {
	// The rank or index of this comparison product block within the module. Different blocks cannot occupy the same position within a single module.
	Position int32           `json:"position"`
	Image    *ImageComponent `json:"image,omitempty"`
	// The comparison product title.
	Title string `json:"title,omitempty"`
	Asin  string `json:"asin,omitempty"`
	// Determines whether this block of content is visually highlighted.
	Highlight bool `json:"highlight,omitempty"`
	// Comparison metrics for the product.
	Metrics []PlainTextItem `json:"metrics,omitempty"`
}

The A+ Content standard comparison product block.

type StandardComparisonTableModule ¶

type StandardComparisonTableModule struct {
	ProductColumns  []StandardComparisonProductBlock `json:"productColumns,omitempty"`
	MetricRowLabels []PlainTextItem                  `json:"metricRowLabels,omitempty"`
}

The standard product comparison table.

type StandardFourImageTextModule ¶

type StandardFourImageTextModule struct {
	Headline *TextComponent          `json:"headline,omitempty"`
	Block1   *StandardImageTextBlock `json:"block1,omitempty"`
	Block2   *StandardImageTextBlock `json:"block2,omitempty"`
	Block3   *StandardImageTextBlock `json:"block3,omitempty"`
	Block4   *StandardImageTextBlock `json:"block4,omitempty"`
}

Four standard images with text, presented across a single row.

type StandardFourImageTextQuadrantModule ¶

type StandardFourImageTextQuadrantModule struct {
	Block1 *StandardImageTextBlock `json:"block1"`
	Block2 *StandardImageTextBlock `json:"block2"`
	Block3 *StandardImageTextBlock `json:"block3"`
	Block4 *StandardImageTextBlock `json:"block4"`
}

Four standard images with text, presented on a grid of four quadrants.

type StandardHeaderImageTextModule ¶

type StandardHeaderImageTextModule struct {
	Headline *TextComponent          `json:"headline,omitempty"`
	Block    *StandardImageTextBlock `json:"block,omitempty"`
}

Standard headline text, an image, and body text.

type StandardHeaderTextListBlock ¶

type StandardHeaderTextListBlock struct {
	Headline *TextComponent         `json:"headline,omitempty"`
	Block    *StandardTextListBlock `json:"block,omitempty"`
}

The A+ standard fixed-length list of text, with a related headline.

type StandardImageCaptionBlock ¶

type StandardImageCaptionBlock struct {
	Image   *ImageComponent `json:"image,omitempty"`
	Caption *TextComponent  `json:"caption,omitempty"`
}

The A+ Content standard image and caption block.

type StandardImageSidebarModule ¶

type StandardImageSidebarModule struct {
	Headline              *TextComponent             `json:"headline,omitempty"`
	ImageCaptionBlock     *StandardImageCaptionBlock `json:"imageCaptionBlock,omitempty"`
	DescriptionTextBlock  *StandardTextBlock         `json:"descriptionTextBlock,omitempty"`
	DescriptionListBlock  *StandardTextListBlock     `json:"descriptionListBlock,omitempty"`
	SidebarImageTextBlock *StandardImageTextBlock    `json:"sidebarImageTextBlock,omitempty"`
	SidebarListBlock      *StandardTextListBlock     `json:"sidebarListBlock,omitempty"`
}

Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar.

type StandardImageTextBlock ¶

type StandardImageTextBlock struct {
	Image    *ImageComponent     `json:"image,omitempty"`
	Headline *TextComponent      `json:"headline,omitempty"`
	Body     *ParagraphComponent `json:"body,omitempty"`
}

The A+ Content standard image and text box block.

type StandardImageTextCaptionBlock ¶

type StandardImageTextCaptionBlock struct {
	Block   *StandardImageTextBlock `json:"block,omitempty"`
	Caption *TextComponent          `json:"caption,omitempty"`
}

The A+ Content standard image and text block, with a related caption. The caption may not display on all devices.

type StandardImageTextOverlayModule ¶

type StandardImageTextOverlayModule struct {
	OverlayColorType *ColorType              `json:"overlayColorType"`
	Block            *StandardImageTextBlock `json:"block,omitempty"`
}

A standard background image with a floating text box.

type StandardMultipleImageTextModule ¶

type StandardMultipleImageTextModule struct {
	Blocks []StandardImageTextCaptionBlock `json:"blocks,omitempty"`
}

Standard images with text, presented one at a time. The user clicks on thumbnails to view each block.

type StandardProductDescriptionModule ¶

type StandardProductDescriptionModule struct {
	Body *ParagraphComponent `json:"body"`
}

Standard product description text.

type StandardSingleImageHighlightsModule ¶

type StandardSingleImageHighlightsModule struct {
	Image             *ImageComponent              `json:"image,omitempty"`
	Headline          *TextComponent               `json:"headline,omitempty"`
	TextBlock1        *StandardTextBlock           `json:"textBlock1,omitempty"`
	TextBlock2        *StandardTextBlock           `json:"textBlock2,omitempty"`
	TextBlock3        *StandardTextBlock           `json:"textBlock3,omitempty"`
	BulletedListBlock *StandardHeaderTextListBlock `json:"bulletedListBlock,omitempty"`
}

A standard image with several paragraphs and a bulleted list.

type StandardSingleImageSpecsDetailModule ¶

type StandardSingleImageSpecsDetailModule struct {
	Headline               *TextComponent               `json:"headline,omitempty"`
	Image                  *ImageComponent              `json:"image,omitempty"`
	DescriptionHeadline    *TextComponent               `json:"descriptionHeadline,omitempty"`
	DescriptionBlock1      *StandardTextBlock           `json:"descriptionBlock1,omitempty"`
	DescriptionBlock2      *StandardTextBlock           `json:"descriptionBlock2,omitempty"`
	SpecificationHeadline  *TextComponent               `json:"specificationHeadline,omitempty"`
	SpecificationListBlock *StandardHeaderTextListBlock `json:"specificationListBlock,omitempty"`
	SpecificationTextBlock *StandardTextBlock           `json:"specificationTextBlock,omitempty"`
}

A standard image with paragraphs and a bulleted list, and extra space for technical details.

type StandardSingleSideImageModule ¶

type StandardSingleSideImageModule struct {
	ImagePositionType *PositionType           `json:"imagePositionType"`
	Block             *StandardImageTextBlock `json:"block,omitempty"`
}

A standard headline and body text with an image on the side.

type StandardTechSpecsModule ¶

type StandardTechSpecsModule struct {
	Headline *TextComponent `json:"headline,omitempty"`
	// The specification list.
	SpecificationList []StandardTextPairBlock `json:"specificationList"`
	// The number of tables to present. Features are evenly divided between the tables.
	TableCount int32 `json:"tableCount,omitempty"`
}

The standard table of technical feature names and definitions.

type StandardTextBlock ¶

type StandardTextBlock struct {
	Headline *TextComponent      `json:"headline,omitempty"`
	Body     *ParagraphComponent `json:"body,omitempty"`
}

The A+ Content standard text box block, comprised of a paragraph with a headline.

type StandardTextListBlock ¶

type StandardTextListBlock struct {
	TextList []TextItem `json:"textList"`
}

The A+ Content standard fixed length list of text, usually presented as bullet points.

type StandardTextModule ¶

type StandardTextModule struct {
	Headline *TextComponent      `json:"headline,omitempty"`
	Body     *ParagraphComponent `json:"body"`
}

A standard headline and body text.

type StandardTextPairBlock ¶

type StandardTextPairBlock struct {
	Label       *TextComponent `json:"label,omitempty"`
	Description *TextComponent `json:"description,omitempty"`
}

The A+ Content standard label and description block, comprised of a pair of text components.

type StandardThreeImageTextModule ¶

type StandardThreeImageTextModule struct {
	Headline *TextComponent          `json:"headline,omitempty"`
	Block1   *StandardImageTextBlock `json:"block1,omitempty"`
	Block2   *StandardImageTextBlock `json:"block2,omitempty"`
	Block3   *StandardImageTextBlock `json:"block3,omitempty"`
}

Three standard images with text, presented across a single row.

type TextComponent ¶

type TextComponent struct {
	// The actual plain text.
	Value        string       `json:"value"`
	DecoratorSet *[]Decorator `json:"decoratorSet,omitempty"`
}

Rich text content.

type TextItem ¶

type TextItem struct {
	// The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.
	Position int32          `json:"position"`
	Text     *TextComponent `json:"text"`
}

Rich positional text, usually presented as a collection of bullet points.

type ValidateContentDocumentAsinRelationsResponse ¶

type ValidateContentDocumentAsinRelationsResponse struct {
	// A list of error responses returned when a request is unsuccessful.
	Errors   []ModelError  `json:"errors"`
	Warnings *[]ModelError `json:"warnings,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL