Documentation ¶
Index ¶
- type API
- func (a *API) CancelFeed(feedID string) error
- func (a *API) CreateFeed(specification *CreateFeedSpecification) (*apis.CallResponse[CreateFeedResponse], error)
- func (a *API) CreateFeedDocument(specification *CreateFeedDocumentSpecification) (*apis.CallResponse[CreateFeedDocumentResponse], error)
- func (a *API) GetFeed(feedID string) (*apis.CallResponse[Feed], error)
- func (a *API) GetFeedDocument(feedDocumentID string) (*apis.CallResponse[FeedDocument], error)
- func (a *API) GetFeeds(filter *GetFeedsRequestFilter) (*apis.CallResponse[GetFeedsResponse], error)
- type CreateFeedDocumentResponse
- type CreateFeedDocumentSpecification
- type CreateFeedResponse
- type CreateFeedSpecification
- type Feed
- type FeedDocument
- type GetFeedsRequestFilter
- type GetFeedsResponse
- type ProcessingStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
func (*API) CancelFeed ¶
CancelFeed cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.
func (*API) CreateFeed ¶
func (a *API) CreateFeed(specification *CreateFeedSpecification) (*apis.CallResponse[CreateFeedResponse], error)
CreateFeed creates a feed. Upload the contents of the feed document before calling this operation.
func (*API) CreateFeedDocument ¶
func (a *API) CreateFeedDocument(specification *CreateFeedDocumentSpecification) (*apis.CallResponse[CreateFeedDocumentResponse], error)
CreateFeedDocument creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.
func (*API) GetFeed ¶
GetFeed returns feed details (including the resultDocumentId, if available) for the feed that you specify.
func (*API) GetFeedDocument ¶
func (a *API) GetFeedDocument(feedDocumentID string) (*apis.CallResponse[FeedDocument], error)
GetFeedDocument the information required for retrieving a feed document's contents.
func (*API) GetFeeds ¶
func (a *API) GetFeeds(filter *GetFeedsRequestFilter) (*apis.CallResponse[GetFeedsResponse], error)
GetFeeds returns feed details for the feeds that match the filters that you specify.
type CreateFeedDocumentResponse ¶
type CreateFeedDocumentResponse struct { // The identifier of the feed document. FeedDocumentId string `json:"feedDocumentId"` // The presigned URL for uploading the feed contents. This URL expires after 5 minutes. Url string `json:"url"` }
CreateFeedDocumentResponse is the response schema for the createFeedDocument operation.
type CreateFeedDocumentSpecification ¶
type CreateFeedDocumentSpecification struct { // The content type of the feed. ContentType string `json:"contentType"` }
CreateFeedDocumentSpecification specifies the content type for the createFeedDocument operation.
type CreateFeedResponse ¶
type CreateFeedResponse struct { // The identifier for the feed. This identifier is unique only in combination with a seller ID. FeedId string `json:"feedId"` }
CreateFeedResponse is the response schema for the createFeed operation.
type CreateFeedSpecification ¶
type CreateFeedSpecification struct { // The feed type. FeedType string `json:"feedType"` // A list of identifiers for marketplaces that you want the feed to be applied to. MarketplaceIDs []constants.MarketplaceID `json:"marketplaceIds"` // The document identifier returned by the createFeedDocument operation. Upload the feed document contents before // calling the createFeed operation. InputFeedDocumentId string `json:"inputFeedDocumentId"` // Additional options to control the feed. These vary by feed type. FeedOptions *map[string]string `json:"feedOptions,omitempty"` }
CreateFeedSpecification information required to create the feed."
type Feed ¶
type Feed struct { // The identifier for the feed. This identifier is unique only in combination with a seller ID. FeedId string `json:"feedId"` // The feed type. FeedType string `json:"feedType"` // A list of identifiers for the marketplaces that the feed is applied to. MarketplaceIDs []constants.MarketplaceID `json:"marketplaceIds,omitempty"` // The date and time when the feed was created, in ISO 8601 date time format. CreatedTime time.Time `json:"createdTime"` // The processing status of the feed. ProcessingStatus ProcessingStatus `json:"processingStatus"` // The date and time when feed processing started, in ISO 8601 date time format. ProcessingStartTime *time.Time `json:"processingStartTime,omitempty"` // The date and time when feed processing completed, in ISO 8601 date time format. ProcessingEndTime *time.Time `json:"processingEndTime,omitempty"` // The identifier for the feed document. This identifier is unique only in combination with a seller ID. ResultFeedDocumentId *string `json:"resultFeedDocumentId,omitempty"` }
Feed contains detailed information about the feed.
type FeedDocument ¶
type FeedDocument struct { // The identifier for the feed document. This identifier is unique only in combination with a seller ID. FeedDocumentId string `json:"feedDocumentId"` // A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can download the feed // directly from this URL. This URL expires after 5 minutes. Url string `json:"url"` // If the feed document contents have been compressed, the compression algorithm used is returned in this property // and you must decompress the feed when you download. Otherwise, you can download the feed directly. CompressionAlgorithm *string `json:"compressionAlgorithm,omitempty"` }
FeedDocument contains information about the feed document.
type GetFeedsRequestFilter ¶
type GetFeedsRequestFilter struct { // A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters // (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. // Either feedTypes or nextToken is required. Maximum 10 feed types. If longer the first 10 will be used. FeedTypes []string `json:"feedTypes,omitempty"` // A list of marketplace identifiers used to filter feeds. // The feeds returned will match at least one of the marketplaces that you specify. // Maximum 10 marketplace identifiers. If longer the first 10 will be used. MarketplaceIDs []constants.MarketplaceID `json:"marketplaceIds,omitempty"` // The maximum number of feeds to return in a single call. // Minimum 1. Maximum 100. PageSize int `json:"pageSize,omitempty"` // A list of processing statuses used to filter feeds. ProcessingStatuses []string `json:"processingStatuses,omitempty"` // The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. //The default is 90 days ago. Feeds are retained for a maximum of 90 days. CreatedSince apis.JsonTimeISO8601 `json:"createdSince,omitempty"` // The latest feed creation date and time for feeds included in the response, in ISO 8601 format. // The default is now. CreatedUntil apis.JsonTimeISO8601 `json:"createdUntil,omitempty"` // The token returned by a previous call to this operation. NextToken string `json:"nextToken,omitempty"` }
GetFeedsRequestFilter specifies optional filters for the getFeeds operation.
func (*GetFeedsRequestFilter) GetQuery ¶
func (f *GetFeedsRequestFilter) GetQuery() url.Values
type GetFeedsResponse ¶
type GetFeedsResponse struct { // A list of feeds. Feeds []Feed `json:"feeds"` // Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds // operation with this token as the only parameter. NextToken *string `json:"nextToken,omitempty"` }
GetFeedsResponse is the response schema for the getFeeds operation.
type ProcessingStatus ¶ added in v0.6.0
type ProcessingStatus string
const ( // ProcessingStatusCanceled The feed was cancelled before it started processing. ProcessingStatusCanceled ProcessingStatus = "CANCELLED" // ProcessingStatusDone The feed has completed processing. Examine the contents of the result document to determine if there were any errors during processing. ProcessingStatusDone ProcessingStatus = "DONE" // ProcessingStatusFatal The feed was aborted due to a fatal error. Some, none, or all of the operations within the feed may have completed successfully. ProcessingStatusFatal ProcessingStatus = "FATAL" // ProcessingStatusInProgress The feed is being processed. ProcessingStatusInProgress ProcessingStatus = "IN_PROGRESS" // ProcessingStatusInQueue The feed has not yet started processing. It may be waiting for another IN_PROGRESS feed. ProcessingStatusInQueue ProcessingStatus = "IN_QUEUE" )