sponsoredproductssnapshots

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 22, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package sponsoredproductssnapshots provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.15.0 DO NOT EDIT.

Index

Constants

View Source 
const (
	BearerScopes = "bearer.Scopes"
)

Variables

This section is empty.

Functions

func NewBulkGetAsinSuggestedKeywordsRequest 

func NewBulkGetAsinSuggestedKeywordsRequest(server string, params *BulkGetAsinSuggestedKeywordsParams, body BulkGetAsinSuggestedKeywordsJSONRequestBody) (*http.Request, error)

NewBulkGetAsinSuggestedKeywordsRequest calls the generic BulkGetAsinSuggestedKeywords builder with application/json body

func NewBulkGetAsinSuggestedKeywordsRequestWithBody 

func NewBulkGetAsinSuggestedKeywordsRequestWithBody(server string, params *BulkGetAsinSuggestedKeywordsParams, contentType string, body io.Reader) (*http.Request, error)

NewBulkGetAsinSuggestedKeywordsRequestWithBody generates requests for BulkGetAsinSuggestedKeywords with any type of body

func NewCreateKeywordBidRecommendationsRequest 

func NewCreateKeywordBidRecommendationsRequest(server string, params *CreateKeywordBidRecommendationsParams, body CreateKeywordBidRecommendationsJSONRequestBody) (*http.Request, error)

NewCreateKeywordBidRecommendationsRequest calls the generic CreateKeywordBidRecommendations builder with application/json body

func NewCreateKeywordBidRecommendationsRequestWithBody 

func NewCreateKeywordBidRecommendationsRequestWithBody(server string, params *CreateKeywordBidRecommendationsParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateKeywordBidRecommendationsRequestWithBody generates requests for CreateKeywordBidRecommendations with any type of body

func NewDownloadSnapshotRequest 

func NewDownloadSnapshotRequest(server string, snapshotId float32, params *DownloadSnapshotParams) (*http.Request, error)

NewDownloadSnapshotRequest generates requests for DownloadSnapshot

func NewGetAdGroupBidRecommendationsRequest 

func NewGetAdGroupBidRecommendationsRequest(server string, adGroupId float32, params *GetAdGroupBidRecommendationsParams) (*http.Request, error)

NewGetAdGroupBidRecommendationsRequest generates requests for GetAdGroupBidRecommendations

func NewGetAdGroupSuggestedKeywordsExRequest 

func NewGetAdGroupSuggestedKeywordsExRequest(server string, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsExParams) (*http.Request, error)

NewGetAdGroupSuggestedKeywordsExRequest generates requests for GetAdGroupSuggestedKeywordsEx

func NewGetAdGroupSuggestedKeywordsRequest 

func NewGetAdGroupSuggestedKeywordsRequest(server string, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsParams) (*http.Request, error)

NewGetAdGroupSuggestedKeywordsRequest generates requests for GetAdGroupSuggestedKeywords

func NewGetAsinSuggestedKeywordsRequest 

func NewGetAsinSuggestedKeywordsRequest(server string, asinValue string, params *GetAsinSuggestedKeywordsParams) (*http.Request, error)

NewGetAsinSuggestedKeywordsRequest generates requests for GetAsinSuggestedKeywords

func NewGetBidRecommendationsRequest 

func NewGetBidRecommendationsRequest(server string, body GetBidRecommendationsJSONRequestBody) (*http.Request, error)

NewGetBidRecommendationsRequest calls the generic GetBidRecommendations builder with application/json body

func NewGetBidRecommendationsRequestWithBody 

func NewGetBidRecommendationsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewGetBidRecommendationsRequestWithBody generates requests for GetBidRecommendations with any type of body

func NewGetKeywordBidRecommendationsRequest 

func NewGetKeywordBidRecommendationsRequest(server string, keywordId float32, params *GetKeywordBidRecommendationsParams) (*http.Request, error)

NewGetKeywordBidRecommendationsRequest generates requests for GetKeywordBidRecommendations

func NewGetSnapshotStatusRequest 

func NewGetSnapshotStatusRequest(server string, snapshotId float32, params *GetSnapshotStatusParams) (*http.Request, error)

NewGetSnapshotStatusRequest generates requests for GetSnapshotStatus

func NewRequestSnapshotRequest 

func NewRequestSnapshotRequest(server string, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, body RequestSnapshotJSONRequestBody) (*http.Request, error)

NewRequestSnapshotRequest calls the generic RequestSnapshot builder with application/json body

func NewRequestSnapshotRequestWithBody 

func NewRequestSnapshotRequestWithBody(server string, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, contentType string, body io.Reader) (*http.Request, error)

NewRequestSnapshotRequestWithBody generates requests for RequestSnapshot with any type of body

Types

type AdGroupBidRecommendationsResponse 

type AdGroupBidRecommendationsResponse struct {
	// AdGroupId The identifier of the ad group.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// SuggestedBid Information about the recommended bid.
	SuggestedBid *SuggestedBid `json:"suggestedBid,omitempty"`
}

AdGroupBidRecommendationsResponse defines model for AdGroupBidRecommendationsResponse.

type AdGroupId 

type AdGroupId = float32

AdGroupId defines model for adGroupId.

type AdGroupSuggestedKeywordsResponse 

type AdGroupSuggestedKeywordsResponse struct {
	// AdGroupId The ad group identifier.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// SuggestededKeywords An array of suggested keywords.
	SuggestededKeywords *[]string `json:"suggestededKeywords,omitempty"`
}

AdGroupSuggestedKeywordsResponse defines model for AdGroupSuggestedKeywordsResponse.

type AdGroupSuggestedKeywordsResponseEx 

type AdGroupSuggestedKeywordsResponseEx struct {
	// AdGroupId The ad group identifier.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// Bid The suggested bid for the suggested keyword. Note that this field will not be included in the response if the `suggestBids` query parameter is set to `no` in the request.
	Bid *float32 `json:"bid,omitempty"`

	// CampaignId The campaign identifier.
	CampaignId *float32 `json:"campaignId,omitempty"`

	// KeywordText The suggested keyword.
	KeywordText *string `json:"keywordText,omitempty"`

	// MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.
	MatchType *MatchType `json:"matchType,omitempty"`

	// State The state of the ad for which the keyword is suggested.
	State *AdGroupSuggestedKeywordsResponseExState `json:"state,omitempty"`
}

AdGroupSuggestedKeywordsResponseEx defines model for AdGroupSuggestedKeywordsResponseEx.

type AdGroupSuggestedKeywordsResponseExState 

type AdGroupSuggestedKeywordsResponseExState string

AdGroupSuggestedKeywordsResponseExState The state of the ad for which the keyword is suggested. 

const (
	AdGroupSuggestedKeywordsResponseExStateEnabled AdGroupSuggestedKeywordsResponseExState = "enabled"
	AdGroupSuggestedKeywordsResponseExStatePaused  AdGroupSuggestedKeywordsResponseExState = "paused"
)

Defines values for AdGroupSuggestedKeywordsResponseExState.

type AdStateFilter 

type AdStateFilter string

AdStateFilter defines model for adStateFilter. 

const (
	AdStateFilterArchived              AdStateFilter = "archived"
	AdStateFilterEnabled               AdStateFilter = "enabled"
	AdStateFilterEnabledArchived       AdStateFilter = "enabled, archived"
	AdStateFilterEnabledPaused         AdStateFilter = "enabled, paused"
	AdStateFilterEnabledPausedArchived AdStateFilter = "enabled, paused, archived"
	AdStateFilterPaused                AdStateFilter = "paused"
	AdStateFilterPausedArchived        AdStateFilter = "paused, archived"
)

Defines values for AdStateFilter.

type BadRequest 

type BadRequest = Error

BadRequest defines model for BadRequest.

type BidRecommendationsCode 

type BidRecommendationsCode string

BidRecommendationsCode The response code. 

const (
	BidRecommendationsCodeINTERNALERROR   BidRecommendationsCode = "INTERNAL_ERROR"
	BidRecommendationsCodeINVALIDARGUMENT BidRecommendationsCode = "INVALID_ARGUMENT"
	BidRecommendationsCodeNOTFOUND        BidRecommendationsCode = "NOT_FOUND"
	BidRecommendationsCodeSERVERISBUSY    BidRecommendationsCode = "SERVER_IS_BUSY"
	BidRecommendationsCodeSUCCESS         BidRecommendationsCode = "SUCCESS"
	BidRecommendationsCodeUNAUTHORIZED    BidRecommendationsCode = "UNAUTHORIZED"
)

Defines values for BidRecommendationsCode.

type BidRecommendationsResponse 

type BidRecommendationsResponse struct {
	// AdGroupId The identifier of the ad group that the recommendations are associated with.
	AdGroupId *string `json:"adGroupId,omitempty"`

	// Recommendations An array of bid recommendation objects.
	Recommendations *[]struct {
		// Code The resulting status code for retrieving the bid.
		Code *BidRecommendationsResponseRecommendationsCode `json:"code,omitempty"`

		// Keyword The keyword text.
		Keyword *string `json:"keyword,omitempty"`

		// MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.
		MatchType *MatchType `json:"matchType,omitempty"`

		// SuggestedBid Information about the recommended bid.
		SuggestedBid *SuggestedBid `json:"suggestedBid,omitempty"`
	} `json:"recommendations,omitempty"`
}

BidRecommendationsResponse defines model for BidRecommendationsResponse.

type BidRecommendationsResponseRecommendationsCode 

type BidRecommendationsResponseRecommendationsCode string

BidRecommendationsResponseRecommendationsCode The resulting status code for retrieving the bid. 

const (
	BidRecommendationsResponseRecommendationsCodeNOTFOUND BidRecommendationsResponseRecommendationsCode = "NOT_FOUND"
	BidRecommendationsResponseRecommendationsCodeSUCCESS  BidRecommendationsResponseRecommendationsCode = "SUCCESS"
)

Defines values for BidRecommendationsResponseRecommendationsCode.

type BulkGetAsinSuggestedKeywordsJSONBody 

type BulkGetAsinSuggestedKeywordsJSONBody struct {
	// Asins A list of ASINs.
	Asins *[]string `json:"asins,omitempty"`

	// MaxNumSuggestions The maximum number of suggested keywords in the response.
	MaxNumSuggestions *int `json:"maxNumSuggestions,omitempty"`
}

BulkGetAsinSuggestedKeywordsJSONBody defines parameters for BulkGetAsinSuggestedKeywords.

type BulkGetAsinSuggestedKeywordsJSONRequestBody 

type BulkGetAsinSuggestedKeywordsJSONRequestBody BulkGetAsinSuggestedKeywordsJSONBody

BulkGetAsinSuggestedKeywordsJSONRequestBody defines body for BulkGetAsinSuggestedKeywords for application/json ContentType.

type BulkGetAsinSuggestedKeywordsParams 

type BulkGetAsinSuggestedKeywordsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

BulkGetAsinSuggestedKeywordsParams defines parameters for BulkGetAsinSuggestedKeywords.

type BulkGetAsinSuggestedKeywordsResp 

type BulkGetAsinSuggestedKeywordsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BulkGetAsinSuggestedKeywordsResponse
	JSON400      *InvalidQueryParam
}

func ParseBulkGetAsinSuggestedKeywordsResp 

func ParseBulkGetAsinSuggestedKeywordsResp(rsp *http.Response) (*BulkGetAsinSuggestedKeywordsResp, error)

ParseBulkGetAsinSuggestedKeywordsResp parses an HTTP response from a BulkGetAsinSuggestedKeywordsWithResponse call

func (BulkGetAsinSuggestedKeywordsResp) Status 

func (r BulkGetAsinSuggestedKeywordsResp) Status() string

Status returns HTTPResponse.Status

func (BulkGetAsinSuggestedKeywordsResp) StatusCode 

func (r BulkGetAsinSuggestedKeywordsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkGetAsinSuggestedKeywordsResponse 

type BulkGetAsinSuggestedKeywordsResponse = []struct {
	// KeywordText The keyword text.
	KeywordText *string `json:"keywordText,omitempty"`

	// MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.
	MatchType *MatchType `json:"matchType,omitempty"`
}

BulkGetAsinSuggestedKeywordsResponse defines model for BulkGetAsinSuggestedKeywordsResponse.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BulkGetAsinSuggestedKeywords 

func (c *Client) BulkGetAsinSuggestedKeywords(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, body BulkGetAsinSuggestedKeywordsJSONRequestBody) (*http.Response, error)

func (*Client) BulkGetAsinSuggestedKeywordsWithBody 

func (c *Client) BulkGetAsinSuggestedKeywordsWithBody(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateKeywordBidRecommendations 

func (c *Client) CreateKeywordBidRecommendations(ctx context.Context, params *CreateKeywordBidRecommendationsParams, body CreateKeywordBidRecommendationsJSONRequestBody) (*http.Response, error)

func (*Client) CreateKeywordBidRecommendationsWithBody 

func (c *Client) CreateKeywordBidRecommendationsWithBody(ctx context.Context, params *CreateKeywordBidRecommendationsParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) DownloadSnapshot 

func (c *Client) DownloadSnapshot(ctx context.Context, snapshotId float32, params *DownloadSnapshotParams) (*http.Response, error)

func (*Client) GetAdGroupBidRecommendations 

func (c *Client) GetAdGroupBidRecommendations(ctx context.Context, adGroupId float32, params *GetAdGroupBidRecommendationsParams) (*http.Response, error)

func (*Client) GetAdGroupSuggestedKeywords 

func (c *Client) GetAdGroupSuggestedKeywords(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsParams) (*http.Response, error)

func (*Client) GetAdGroupSuggestedKeywordsEx 

func (c *Client) GetAdGroupSuggestedKeywordsEx(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsExParams) (*http.Response, error)

func (*Client) GetAsinSuggestedKeywords 

func (c *Client) GetAsinSuggestedKeywords(ctx context.Context, asinValue string, params *GetAsinSuggestedKeywordsParams) (*http.Response, error)

func (*Client) GetBidRecommendations 

func (c *Client) GetBidRecommendations(ctx context.Context, body GetBidRecommendationsJSONRequestBody) (*http.Response, error)

func (*Client) GetBidRecommendationsWithBody 

func (c *Client) GetBidRecommendationsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetKeywordBidRecommendations 

func (c *Client) GetKeywordBidRecommendations(ctx context.Context, keywordId float32, params *GetKeywordBidRecommendationsParams) (*http.Response, error)

func (*Client) GetSnapshotStatus 

func (c *Client) GetSnapshotStatus(ctx context.Context, snapshotId float32, params *GetSnapshotStatusParams) (*http.Response, error)

func (*Client) RequestSnapshot 

func (c *Client) RequestSnapshot(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, body RequestSnapshotJSONRequestBody) (*http.Response, error)

func (*Client) RequestSnapshotWithBody 

func (c *Client) RequestSnapshotWithBody(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, contentType string, body io.Reader) (*http.Response, error)

type ClientHeader 

type ClientHeader = string

ClientHeader defines model for clientHeader.

type ClientInterface 

type ClientInterface interface {
	// GetAdGroupBidRecommendations request
	GetAdGroupBidRecommendations(ctx context.Context, adGroupId float32, params *GetAdGroupBidRecommendationsParams) (*http.Response, error)

	// GetAdGroupSuggestedKeywords request
	GetAdGroupSuggestedKeywords(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsParams) (*http.Response, error)

	// GetAdGroupSuggestedKeywordsEx request
	GetAdGroupSuggestedKeywordsEx(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsExParams) (*http.Response, error)

	// BulkGetAsinSuggestedKeywordsWithBody request with any body
	BulkGetAsinSuggestedKeywordsWithBody(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, contentType string, body io.Reader) (*http.Response, error)

	BulkGetAsinSuggestedKeywords(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, body BulkGetAsinSuggestedKeywordsJSONRequestBody) (*http.Response, error)

	// GetAsinSuggestedKeywords request
	GetAsinSuggestedKeywords(ctx context.Context, asinValue string, params *GetAsinSuggestedKeywordsParams) (*http.Response, error)

	// CreateKeywordBidRecommendationsWithBody request with any body
	CreateKeywordBidRecommendationsWithBody(ctx context.Context, params *CreateKeywordBidRecommendationsParams, contentType string, body io.Reader) (*http.Response, error)

	CreateKeywordBidRecommendations(ctx context.Context, params *CreateKeywordBidRecommendationsParams, body CreateKeywordBidRecommendationsJSONRequestBody) (*http.Response, error)

	// GetKeywordBidRecommendations request
	GetKeywordBidRecommendations(ctx context.Context, keywordId float32, params *GetKeywordBidRecommendationsParams) (*http.Response, error)

	// GetSnapshotStatus request
	GetSnapshotStatus(ctx context.Context, snapshotId float32, params *GetSnapshotStatusParams) (*http.Response, error)

	// DownloadSnapshot request
	DownloadSnapshot(ctx context.Context, snapshotId float32, params *DownloadSnapshotParams) (*http.Response, error)

	// GetBidRecommendationsWithBody request with any body
	GetBidRecommendationsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	GetBidRecommendations(ctx context.Context, body GetBidRecommendationsJSONRequestBody) (*http.Response, error)

	// RequestSnapshotWithBody request with any body
	RequestSnapshotWithBody(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, contentType string, body io.Reader) (*http.Response, error)

	RequestSnapshot(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, body RequestSnapshotJSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn 

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BulkGetAsinSuggestedKeywordsWithBodyWithResponse 

func (c *ClientWithResponses) BulkGetAsinSuggestedKeywordsWithBodyWithResponse(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, contentType string, body io.Reader) (*BulkGetAsinSuggestedKeywordsResp, error)

BulkGetAsinSuggestedKeywordsWithBodyWithResponse request with arbitrary body returning *BulkGetAsinSuggestedKeywordsResp

func (*ClientWithResponses) BulkGetAsinSuggestedKeywordsWithResponse 

func (c *ClientWithResponses) BulkGetAsinSuggestedKeywordsWithResponse(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, body BulkGetAsinSuggestedKeywordsJSONRequestBody) (*BulkGetAsinSuggestedKeywordsResp, error)

func (*ClientWithResponses) CreateKeywordBidRecommendationsWithBodyWithResponse 

func (c *ClientWithResponses) CreateKeywordBidRecommendationsWithBodyWithResponse(ctx context.Context, params *CreateKeywordBidRecommendationsParams, contentType string, body io.Reader) (*CreateKeywordBidRecommendationsResp, error)

CreateKeywordBidRecommendationsWithBodyWithResponse request with arbitrary body returning *CreateKeywordBidRecommendationsResp

func (*ClientWithResponses) CreateKeywordBidRecommendationsWithResponse 

func (c *ClientWithResponses) CreateKeywordBidRecommendationsWithResponse(ctx context.Context, params *CreateKeywordBidRecommendationsParams, body CreateKeywordBidRecommendationsJSONRequestBody) (*CreateKeywordBidRecommendationsResp, error)

func (*ClientWithResponses) DownloadSnapshotWithResponse 

func (c *ClientWithResponses) DownloadSnapshotWithResponse(ctx context.Context, snapshotId float32, params *DownloadSnapshotParams) (*DownloadSnapshotResp, error)

DownloadSnapshotWithResponse request returning *DownloadSnapshotResp

func (*ClientWithResponses) GetAdGroupBidRecommendationsWithResponse 

func (c *ClientWithResponses) GetAdGroupBidRecommendationsWithResponse(ctx context.Context, adGroupId float32, params *GetAdGroupBidRecommendationsParams) (*GetAdGroupBidRecommendationsResp, error)

GetAdGroupBidRecommendationsWithResponse request returning *GetAdGroupBidRecommendationsResp

func (*ClientWithResponses) GetAdGroupSuggestedKeywordsExWithResponse 

func (c *ClientWithResponses) GetAdGroupSuggestedKeywordsExWithResponse(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsExParams) (*GetAdGroupSuggestedKeywordsExResp, error)

GetAdGroupSuggestedKeywordsExWithResponse request returning *GetAdGroupSuggestedKeywordsExResp

func (*ClientWithResponses) GetAdGroupSuggestedKeywordsWithResponse 

func (c *ClientWithResponses) GetAdGroupSuggestedKeywordsWithResponse(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsParams) (*GetAdGroupSuggestedKeywordsResp, error)

GetAdGroupSuggestedKeywordsWithResponse request returning *GetAdGroupSuggestedKeywordsResp

func (*ClientWithResponses) GetAsinSuggestedKeywordsWithResponse 

func (c *ClientWithResponses) GetAsinSuggestedKeywordsWithResponse(ctx context.Context, asinValue string, params *GetAsinSuggestedKeywordsParams) (*GetAsinSuggestedKeywordsResp, error)

GetAsinSuggestedKeywordsWithResponse request returning *GetAsinSuggestedKeywordsResp

func (*ClientWithResponses) GetBidRecommendationsWithBodyWithResponse 

func (c *ClientWithResponses) GetBidRecommendationsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetBidRecommendationsResp, error)

GetBidRecommendationsWithBodyWithResponse request with arbitrary body returning *GetBidRecommendationsResp

func (*ClientWithResponses) GetBidRecommendationsWithResponse 

func (c *ClientWithResponses) GetBidRecommendationsWithResponse(ctx context.Context, body GetBidRecommendationsJSONRequestBody) (*GetBidRecommendationsResp, error)

func (*ClientWithResponses) GetKeywordBidRecommendationsWithResponse 

func (c *ClientWithResponses) GetKeywordBidRecommendationsWithResponse(ctx context.Context, keywordId float32, params *GetKeywordBidRecommendationsParams) (*GetKeywordBidRecommendationsResp, error)

GetKeywordBidRecommendationsWithResponse request returning *GetKeywordBidRecommendationsResp

func (*ClientWithResponses) GetSnapshotStatusWithResponse 

func (c *ClientWithResponses) GetSnapshotStatusWithResponse(ctx context.Context, snapshotId float32, params *GetSnapshotStatusParams) (*GetSnapshotStatusResp, error)

GetSnapshotStatusWithResponse request returning *GetSnapshotStatusResp

func (*ClientWithResponses) RequestSnapshotWithBodyWithResponse 

func (c *ClientWithResponses) RequestSnapshotWithBodyWithResponse(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, contentType string, body io.Reader) (*RequestSnapshotResp, error)

RequestSnapshotWithBodyWithResponse request with arbitrary body returning *RequestSnapshotResp

func (*ClientWithResponses) RequestSnapshotWithResponse 

func (c *ClientWithResponses) RequestSnapshotWithResponse(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, body RequestSnapshotJSONRequestBody) (*RequestSnapshotResp, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetAdGroupBidRecommendationsWithResponse request
	GetAdGroupBidRecommendationsWithResponse(ctx context.Context, adGroupId float32, params *GetAdGroupBidRecommendationsParams) (*GetAdGroupBidRecommendationsResp, error)

	// GetAdGroupSuggestedKeywordsWithResponse request
	GetAdGroupSuggestedKeywordsWithResponse(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsParams) (*GetAdGroupSuggestedKeywordsResp, error)

	// GetAdGroupSuggestedKeywordsExWithResponse request
	GetAdGroupSuggestedKeywordsExWithResponse(ctx context.Context, adGroupId AdGroupId, params *GetAdGroupSuggestedKeywordsExParams) (*GetAdGroupSuggestedKeywordsExResp, error)

	// BulkGetAsinSuggestedKeywordsWithBodyWithResponse request with any body
	BulkGetAsinSuggestedKeywordsWithBodyWithResponse(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, contentType string, body io.Reader) (*BulkGetAsinSuggestedKeywordsResp, error)

	BulkGetAsinSuggestedKeywordsWithResponse(ctx context.Context, params *BulkGetAsinSuggestedKeywordsParams, body BulkGetAsinSuggestedKeywordsJSONRequestBody) (*BulkGetAsinSuggestedKeywordsResp, error)

	// GetAsinSuggestedKeywordsWithResponse request
	GetAsinSuggestedKeywordsWithResponse(ctx context.Context, asinValue string, params *GetAsinSuggestedKeywordsParams) (*GetAsinSuggestedKeywordsResp, error)

	// CreateKeywordBidRecommendationsWithBodyWithResponse request with any body
	CreateKeywordBidRecommendationsWithBodyWithResponse(ctx context.Context, params *CreateKeywordBidRecommendationsParams, contentType string, body io.Reader) (*CreateKeywordBidRecommendationsResp, error)

	CreateKeywordBidRecommendationsWithResponse(ctx context.Context, params *CreateKeywordBidRecommendationsParams, body CreateKeywordBidRecommendationsJSONRequestBody) (*CreateKeywordBidRecommendationsResp, error)

	// GetKeywordBidRecommendationsWithResponse request
	GetKeywordBidRecommendationsWithResponse(ctx context.Context, keywordId float32, params *GetKeywordBidRecommendationsParams) (*GetKeywordBidRecommendationsResp, error)

	// GetSnapshotStatusWithResponse request
	GetSnapshotStatusWithResponse(ctx context.Context, snapshotId float32, params *GetSnapshotStatusParams) (*GetSnapshotStatusResp, error)

	// DownloadSnapshotWithResponse request
	DownloadSnapshotWithResponse(ctx context.Context, snapshotId float32, params *DownloadSnapshotParams) (*DownloadSnapshotResp, error)

	// GetBidRecommendationsWithBodyWithResponse request with any body
	GetBidRecommendationsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetBidRecommendationsResp, error)

	GetBidRecommendationsWithResponse(ctx context.Context, body GetBidRecommendationsJSONRequestBody) (*GetBidRecommendationsResp, error)

	// RequestSnapshotWithBodyWithResponse request with any body
	RequestSnapshotWithBodyWithResponse(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, contentType string, body io.Reader) (*RequestSnapshotResp, error)

	RequestSnapshotWithResponse(ctx context.Context, recordType RequestSnapshotParamsRecordType, params *RequestSnapshotParams, body RequestSnapshotJSONRequestBody) (*RequestSnapshotResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateKeywordBidRecommendationsJSONRequestBody 

type CreateKeywordBidRecommendationsJSONRequestBody = KeywordBidRecommendationsData

CreateKeywordBidRecommendationsJSONRequestBody defines body for CreateKeywordBidRecommendations for application/json ContentType.

type CreateKeywordBidRecommendationsParams 

type CreateKeywordBidRecommendationsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateKeywordBidRecommendationsParams defines parameters for CreateKeywordBidRecommendations.

type CreateKeywordBidRecommendationsResp 

type CreateKeywordBidRecommendationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *BidRecommendationsResponse
	JSON400      *BadRequest
	JSON404      *NotFound
}

func ParseCreateKeywordBidRecommendationsResp 

func ParseCreateKeywordBidRecommendationsResp(rsp *http.Response) (*CreateKeywordBidRecommendationsResp, error)

ParseCreateKeywordBidRecommendationsResp parses an HTTP response from a CreateKeywordBidRecommendationsWithResponse call

func (CreateKeywordBidRecommendationsResp) Status 

func (r CreateKeywordBidRecommendationsResp) Status() string

Status returns HTTPResponse.Status

func (CreateKeywordBidRecommendationsResp) StatusCode 

func (r CreateKeywordBidRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DownloadSnapshotParams 

type DownloadSnapshotParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

DownloadSnapshotParams defines parameters for DownloadSnapshot.

type DownloadSnapshotResp 

type DownloadSnapshotResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *Unauthorized
	JSON404      *NotFound
}

func ParseDownloadSnapshotResp 

func ParseDownloadSnapshotResp(rsp *http.Response) (*DownloadSnapshotResp, error)

ParseDownloadSnapshotResp parses an HTTP response from a DownloadSnapshotWithResponse call

func (DownloadSnapshotResp) Status 

func (r DownloadSnapshotResp) Status() string

Status returns HTTPResponse.Status

func (DownloadSnapshotResp) StatusCode 

func (r DownloadSnapshotResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error 

type Error struct {
	// Code An enumerated error for machine use.
	Code *string `json:"code,omitempty"`

	// Details A human-readable description of the error.
	Details *string `json:"details,omitempty"`
}

Error defines model for Error.

type GetAdGroupBidRecommendationsParams 

type GetAdGroupBidRecommendationsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAdGroupBidRecommendationsParams defines parameters for GetAdGroupBidRecommendations.

type GetAdGroupBidRecommendationsResp 

type GetAdGroupBidRecommendationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdGroupBidRecommendationsResponse
	JSON400      *BadRequest
	JSON404      *Error
}

func ParseGetAdGroupBidRecommendationsResp 

func ParseGetAdGroupBidRecommendationsResp(rsp *http.Response) (*GetAdGroupBidRecommendationsResp, error)

ParseGetAdGroupBidRecommendationsResp parses an HTTP response from a GetAdGroupBidRecommendationsWithResponse call

func (GetAdGroupBidRecommendationsResp) Status 

func (r GetAdGroupBidRecommendationsResp) Status() string

Status returns HTTPResponse.Status

func (GetAdGroupBidRecommendationsResp) StatusCode 

func (r GetAdGroupBidRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdGroupSuggestedKeywordsExParams 

type GetAdGroupSuggestedKeywordsExParams struct {
	// MaxNumSuggestions The maximum number of suggested keywords for the response.
	MaxNumSuggestions *MaxNumSuggestions `form:"maxNumSuggestions,omitempty" json:"maxNumSuggestions,omitempty"`

	// SuggestBids Set to `yes` to include a suggest bid for the suggested keyword in the response. Otherwise, set to `no`.
	SuggestBids *GetAdGroupSuggestedKeywordsExParamsSuggestBids `form:"suggestBids,omitempty" json:"suggestBids,omitempty"`

	// AdStateFilter Filters results to ad groups with state matching the comma-delimited list.
	AdStateFilter *GetAdGroupSuggestedKeywordsExParamsAdStateFilter `form:"adStateFilter,omitempty" json:"adStateFilter,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAdGroupSuggestedKeywordsExParams defines parameters for GetAdGroupSuggestedKeywordsEx.

type GetAdGroupSuggestedKeywordsExParamsAdStateFilter 

type GetAdGroupSuggestedKeywordsExParamsAdStateFilter string

GetAdGroupSuggestedKeywordsExParamsAdStateFilter defines parameters for GetAdGroupSuggestedKeywordsEx. 

const (
	Archived              GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "archived"
	Enabled               GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "enabled"
	EnabledArchived       GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "enabled, archived"
	EnabledPaused         GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "enabled, paused"
	EnabledPausedArchived GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "enabled, paused, archived"
	Paused                GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "paused"
	PausedArchived        GetAdGroupSuggestedKeywordsExParamsAdStateFilter = "paused, archived"
)

Defines values for GetAdGroupSuggestedKeywordsExParamsAdStateFilter.

type GetAdGroupSuggestedKeywordsExParamsSuggestBids 

type GetAdGroupSuggestedKeywordsExParamsSuggestBids string

GetAdGroupSuggestedKeywordsExParamsSuggestBids defines parameters for GetAdGroupSuggestedKeywordsEx. 

const (
	No  GetAdGroupSuggestedKeywordsExParamsSuggestBids = "no"
	Yes GetAdGroupSuggestedKeywordsExParamsSuggestBids = "yes"
)

Defines values for GetAdGroupSuggestedKeywordsExParamsSuggestBids.

type GetAdGroupSuggestedKeywordsExResp 

type GetAdGroupSuggestedKeywordsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]AdGroupSuggestedKeywordsResponseEx
	JSON400      *InvalidQueryParam
	JSON404      *NotFound
}

func ParseGetAdGroupSuggestedKeywordsExResp 

func ParseGetAdGroupSuggestedKeywordsExResp(rsp *http.Response) (*GetAdGroupSuggestedKeywordsExResp, error)

ParseGetAdGroupSuggestedKeywordsExResp parses an HTTP response from a GetAdGroupSuggestedKeywordsExWithResponse call

func (GetAdGroupSuggestedKeywordsExResp) Status 

func (r GetAdGroupSuggestedKeywordsExResp) Status() string

Status returns HTTPResponse.Status

func (GetAdGroupSuggestedKeywordsExResp) StatusCode 

func (r GetAdGroupSuggestedKeywordsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdGroupSuggestedKeywordsParams 

type GetAdGroupSuggestedKeywordsParams struct {
	// MaxNumSuggestions The maximum number of suggested keywords for the response.
	MaxNumSuggestions *MaxNumSuggestions `form:"maxNumSuggestions,omitempty" json:"maxNumSuggestions,omitempty"`

	// AdStateFilter Filters results to ad groups with state matching the comma-delimited list.
	AdStateFilter *GetAdGroupSuggestedKeywordsParamsAdStateFilter `form:"adStateFilter,omitempty" json:"adStateFilter,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAdGroupSuggestedKeywordsParams defines parameters for GetAdGroupSuggestedKeywords.

type GetAdGroupSuggestedKeywordsParamsAdStateFilter 

type GetAdGroupSuggestedKeywordsParamsAdStateFilter string

GetAdGroupSuggestedKeywordsParamsAdStateFilter defines parameters for GetAdGroupSuggestedKeywords. 

const (
	GetAdGroupSuggestedKeywordsParamsAdStateFilterArchived              GetAdGroupSuggestedKeywordsParamsAdStateFilter = "archived"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterEnabled               GetAdGroupSuggestedKeywordsParamsAdStateFilter = "enabled"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterEnabledArchived       GetAdGroupSuggestedKeywordsParamsAdStateFilter = "enabled, archived"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterEnabledPaused         GetAdGroupSuggestedKeywordsParamsAdStateFilter = "enabled, paused"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterEnabledPausedArchived GetAdGroupSuggestedKeywordsParamsAdStateFilter = "enabled, paused, archived"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterPaused                GetAdGroupSuggestedKeywordsParamsAdStateFilter = "paused"
	GetAdGroupSuggestedKeywordsParamsAdStateFilterPausedArchived        GetAdGroupSuggestedKeywordsParamsAdStateFilter = "paused, archived"
)

Defines values for GetAdGroupSuggestedKeywordsParamsAdStateFilter.

type GetAdGroupSuggestedKeywordsResp 

type GetAdGroupSuggestedKeywordsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdGroupSuggestedKeywordsResponse
	JSON400      *ResourceNotFound
	JSON404      *NotFound
}

func ParseGetAdGroupSuggestedKeywordsResp 

func ParseGetAdGroupSuggestedKeywordsResp(rsp *http.Response) (*GetAdGroupSuggestedKeywordsResp, error)

ParseGetAdGroupSuggestedKeywordsResp parses an HTTP response from a GetAdGroupSuggestedKeywordsWithResponse call

func (GetAdGroupSuggestedKeywordsResp) Status 

func (r GetAdGroupSuggestedKeywordsResp) Status() string

Status returns HTTPResponse.Status

func (GetAdGroupSuggestedKeywordsResp) StatusCode 

func (r GetAdGroupSuggestedKeywordsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAsinSuggestedKeywordsParams 

type GetAsinSuggestedKeywordsParams struct {
	// MaxNumSuggestions The maximum number of suggested keywords for the response.
	MaxNumSuggestions *MaxNumSuggestions `form:"maxNumSuggestions,omitempty" json:"maxNumSuggestions,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAsinSuggestedKeywordsParams defines parameters for GetAsinSuggestedKeywords.

type GetAsinSuggestedKeywordsResp 

type GetAsinSuggestedKeywordsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetAsinSuggestedKeywordsResponse
	JSON400      *InvalidQueryParam
}

func ParseGetAsinSuggestedKeywordsResp 

func ParseGetAsinSuggestedKeywordsResp(rsp *http.Response) (*GetAsinSuggestedKeywordsResp, error)

ParseGetAsinSuggestedKeywordsResp parses an HTTP response from a GetAsinSuggestedKeywordsWithResponse call

func (GetAsinSuggestedKeywordsResp) Status 

func (r GetAsinSuggestedKeywordsResp) Status() string

Status returns HTTPResponse.Status

func (GetAsinSuggestedKeywordsResp) StatusCode 

func (r GetAsinSuggestedKeywordsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAsinSuggestedKeywordsResponse 

type GetAsinSuggestedKeywordsResponse struct {
	// Asin The ASIN for which keywords are suggested.
	Asin *string `json:"asin,omitempty"`

	// SuggestedKeywords The list of suggested keywords.
	SuggestedKeywords *[]struct {
		// KeywordText The text of the suggested keyword.
		KeywordText *string `json:"keywordText,omitempty"`

		// MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.
		MatchType *MatchType `json:"matchType,omitempty"`
	} `json:"suggestedKeywords,omitempty"`
}

GetAsinSuggestedKeywordsResponse defines model for GetAsinSuggestedKeywordsResponse.

type GetBidRecommendationsJSONBody 

type GetBidRecommendationsJSONBody struct {
	// AdGroupId The ad group identifier.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// Expressions The list of targeting expressions.
	Expressions *[][]TargetingExpressionPredicate `json:"expressions,omitempty"`
}

GetBidRecommendationsJSONBody defines parameters for GetBidRecommendations.

type GetBidRecommendationsJSONRequestBody 

type GetBidRecommendationsJSONRequestBody GetBidRecommendationsJSONBody

GetBidRecommendationsJSONRequestBody defines body for GetBidRecommendations for application/json ContentType.

type GetBidRecommendationsResp 

type GetBidRecommendationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// AdGroupId The ad group identifier.
		AdGroupId *float32 `json:"adGroupId,omitempty"`

		// Recommendations The list of recommended bids with associated targeting expressions.
		Recommendations *[]struct {
			// Code The response code.
			Code       *BidRecommendationsCode       `json:"code,omitempty"`
			Expression *TargetingExpressionPredicate `json:"expression,omitempty"`

			// SuggestedBid Information about the recommended bid.
			SuggestedBid *SuggestedBid `json:"suggestedBid,omitempty"`
		} `json:"recommendations,omitempty"`
	}
	JSON400 *BadRequest
}

func ParseGetBidRecommendationsResp 

func ParseGetBidRecommendationsResp(rsp *http.Response) (*GetBidRecommendationsResp, error)

ParseGetBidRecommendationsResp parses an HTTP response from a GetBidRecommendationsWithResponse call

func (GetBidRecommendationsResp) Status 

func (r GetBidRecommendationsResp) Status() string

Status returns HTTPResponse.Status

func (GetBidRecommendationsResp) StatusCode 

func (r GetBidRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetKeywordBidRecommendationsParams 

type GetKeywordBidRecommendationsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetKeywordBidRecommendationsParams defines parameters for GetKeywordBidRecommendations.

type GetKeywordBidRecommendationsResp 

type GetKeywordBidRecommendationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *KeywordBidRecommendationsResponse
	JSON400      *BadRequest
}

func ParseGetKeywordBidRecommendationsResp 

func ParseGetKeywordBidRecommendationsResp(rsp *http.Response) (*GetKeywordBidRecommendationsResp, error)

ParseGetKeywordBidRecommendationsResp parses an HTTP response from a GetKeywordBidRecommendationsWithResponse call

func (GetKeywordBidRecommendationsResp) Status 

func (r GetKeywordBidRecommendationsResp) Status() string

Status returns HTTPResponse.Status

func (GetKeywordBidRecommendationsResp) StatusCode 

func (r GetKeywordBidRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSnapshotStatusParams 

type GetSnapshotStatusParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetSnapshotStatusParams defines parameters for GetSnapshotStatus.

type GetSnapshotStatusResp 

type GetSnapshotStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SnapshotResponse
	JSON401      *Unauthorized
	JSON404      *NotFound
}

func ParseGetSnapshotStatusResp 

func ParseGetSnapshotStatusResp(rsp *http.Response) (*GetSnapshotStatusResp, error)

ParseGetSnapshotStatusResp parses an HTTP response from a GetSnapshotStatusWithResponse call

func (GetSnapshotStatusResp) Status 

func (r GetSnapshotStatusResp) Status() string

Status returns HTTPResponse.Status

func (GetSnapshotStatusResp) StatusCode 

func (r GetSnapshotStatusResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvalidQueryParam 

type InvalidQueryParam = Error

InvalidQueryParam defines model for InvalidQueryParam.

type KeywordBidRecommendationsData 

type KeywordBidRecommendationsData struct {
	// AdGroupId The identifier of the ad group that the keywords are associated with.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// Keywords An array of keyword data objects.
	Keywords *[]struct {
		// Keyword The keyword text.
		Keyword *string `json:"keyword,omitempty"`

		// MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.
		MatchType *MatchType `json:"matchType,omitempty"`
	} `json:"keywords,omitempty"`
}

KeywordBidRecommendationsData defines model for KeywordBidRecommendationsData.

type KeywordBidRecommendationsResponse 

type KeywordBidRecommendationsResponse struct {
	// AdGroupId The identifier of the ad group that the bid is associated with.
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// KeywordId The identifier of the keyword that the bid is associated with.
	KeywordId *float32 `json:"keywordId,omitempty"`

	// SuggestedBid Information about the recommended bid.
	SuggestedBid *SuggestedBid `json:"suggestedBid,omitempty"`
}

KeywordBidRecommendationsResponse defines model for KeywordBidRecommendationsResponse.

type MatchType 

type MatchType string

MatchType The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center. 

const (
	Broad  MatchType = "broad"
	Exact  MatchType = "exact"
	Phrase MatchType = "phrase"
)

Defines values for MatchType.

type MaxNumSuggestions 

type MaxNumSuggestions = int

MaxNumSuggestions defines model for maxNumSuggestions.

type NotFound 

type NotFound = Error

NotFound defines model for NotFound.

type ProfileHeader 

type ProfileHeader = string

ProfileHeader defines model for profileHeader.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestSnapshotJSONRequestBody 

type RequestSnapshotJSONRequestBody = SnapshotRequest

RequestSnapshotJSONRequestBody defines body for RequestSnapshot for application/json ContentType.

type RequestSnapshotParams 

type RequestSnapshotParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" developer account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

RequestSnapshotParams defines parameters for RequestSnapshot.

type RequestSnapshotParamsRecordType 

type RequestSnapshotParamsRecordType string

RequestSnapshotParamsRecordType defines parameters for RequestSnapshot. 

const (
	RequestSnapshotParamsRecordTypeAdGroups                 RequestSnapshotParamsRecordType = "adGroups"
	RequestSnapshotParamsRecordTypeCampaignNegativeKeywords RequestSnapshotParamsRecordType = "campaignNegativeKeywords"
	RequestSnapshotParamsRecordTypeCampaigns                RequestSnapshotParamsRecordType = "campaigns"
	RequestSnapshotParamsRecordTypeKeywords                 RequestSnapshotParamsRecordType = "keywords"
	RequestSnapshotParamsRecordTypeNegativeKeywords         RequestSnapshotParamsRecordType = "negativeKeywords"
	RequestSnapshotParamsRecordTypeNegativeTargets          RequestSnapshotParamsRecordType = "negativeTargets"
	RequestSnapshotParamsRecordTypeProductAds               RequestSnapshotParamsRecordType = "productAds"
	RequestSnapshotParamsRecordTypeTargets                  RequestSnapshotParamsRecordType = "targets"
)

Defines values for RequestSnapshotParamsRecordType.

type RequestSnapshotResp 

type RequestSnapshotResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SnapshotResponse
	JSON401      *Unauthorized
}

func ParseRequestSnapshotResp 

func ParseRequestSnapshotResp(rsp *http.Response) (*RequestSnapshotResp, error)

ParseRequestSnapshotResp parses an HTTP response from a RequestSnapshotWithResponse call

func (RequestSnapshotResp) Status 

func (r RequestSnapshotResp) Status() string

Status returns HTTPResponse.Status

func (RequestSnapshotResp) StatusCode 

func (r RequestSnapshotResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ResourceNotFound 

type ResourceNotFound = Error

ResourceNotFound defines model for ResourceNotFound.

type ResponseEditorFn 

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

type SnapshotRequest 

type SnapshotRequest struct {
	StateFilter *SnapshotRequestStateFilter `json:"stateFilter,omitempty"`
}

SnapshotRequest defines model for SnapshotRequest.

type SnapshotRequestStateFilter 

type SnapshotRequestStateFilter string

SnapshotRequestStateFilter defines model for SnapshotRequest.StateFilter. 

const (
	SnapshotRequestStateFilterArchived              SnapshotRequestStateFilter = "archived"
	SnapshotRequestStateFilterEnabled               SnapshotRequestStateFilter = "enabled"
	SnapshotRequestStateFilterEnabledArchived       SnapshotRequestStateFilter = "enabled, archived"
	SnapshotRequestStateFilterEnabledPaused         SnapshotRequestStateFilter = "enabled, paused"
	SnapshotRequestStateFilterEnabledPausedArchived SnapshotRequestStateFilter = "enabled, paused, archived"
	SnapshotRequestStateFilterPaused                SnapshotRequestStateFilter = "paused"
	SnapshotRequestStateFilterPausedArchived        SnapshotRequestStateFilter = "paused, archived"
)

Defines values for SnapshotRequestStateFilter.

type SnapshotResponse 

type SnapshotResponse struct {
	// RecordType The record type of the report.
	RecordType *SnapshotResponseRecordType `json:"recordType,omitempty"`

	// SnapshotId The snapshot identifier.
	SnapshotId *string `json:"snapshotId,omitempty"`

	// Status The generation status of the snapshot.
	Status *SnapshotResponseStatus `json:"status,omitempty"`
}

SnapshotResponse defines model for SnapshotResponse.

type SnapshotResponseRecordType 

type SnapshotResponseRecordType string

SnapshotResponseRecordType The record type of the report. 

const (
	SnapshotResponseRecordTypeAdGroups                 SnapshotResponseRecordType = "adGroups"
	SnapshotResponseRecordTypeCampaignNegativeKeywords SnapshotResponseRecordType = "campaignNegativeKeywords"
	SnapshotResponseRecordTypeCampaigns                SnapshotResponseRecordType = "campaigns"
	SnapshotResponseRecordTypeKeywords                 SnapshotResponseRecordType = "keywords"
	SnapshotResponseRecordTypeNegativeKeywords         SnapshotResponseRecordType = "negativeKeywords"
	SnapshotResponseRecordTypeNegativeTargets          SnapshotResponseRecordType = "negativeTargets"
	SnapshotResponseRecordTypeProductAds               SnapshotResponseRecordType = "productAds"
	SnapshotResponseRecordTypeTargets                  SnapshotResponseRecordType = "targets"
)

Defines values for SnapshotResponseRecordType.

type SnapshotResponseStatus 

type SnapshotResponseStatus string

SnapshotResponseStatus The generation status of the snapshot. 

const (
	FAILURE    SnapshotResponseStatus = "FAILURE"
	INPROGRESS SnapshotResponseStatus = "IN_PROGRESS"
	SUCCESS    SnapshotResponseStatus = "SUCCESS"
)

Defines values for SnapshotResponseStatus.

type SuggestedBid 

type SuggestedBid struct {
	// RangeEnd The upper bound bid recommendation.
	RangeEnd *float32 `json:"rangeEnd,omitempty"`

	// RangeStart The lower bound bid recommendation.
	RangeStart *float32 `json:"rangeStart,omitempty"`

	// Suggested The bid recommendation.
	Suggested *float32 `json:"suggested,omitempty"`
}

SuggestedBid Information about the recommended bid.

type TargetingExpressionPredicate 

type TargetingExpressionPredicate struct {
	// Type The type of targeting expression. You can specify values for the following predicates:
	// | Predicate | Description |
	// | --- | --- |
	// | `asinCategorySameAs` | Negatively Target the same category as the category expressed. |
	// | `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |
	// | `asinPriceLessThan` | Target a price that is less than the price expressed. |
	// | `asinPriceBetween` | Target a price that is between the prices expressed. |
	// | `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |
	// | `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |
	// | `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |
	// | `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |
	// | `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |
	// | `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |
	// | `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |
	// | `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |
	// | `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements.   |
	// | `queryExactMatches` | Use this enum to exactly match your query with search queries.   |
	// | `queryPhraseMatches` | Use this enum to match your query with search phrases.   |
	// | `queryBroadMatches` | Use this enum to broadly match your query with search queries.   |
	Type *TargetingExpressionPredicateType `json:"type,omitempty"`

	// Value The expression value
	Value *string `json:"value,omitempty"`
}

TargetingExpressionPredicate defines model for TargetingExpressionPredicate.

type TargetingExpressionPredicateType 

type TargetingExpressionPredicateType string

TargetingExpressionPredicateType The type of targeting expression. You can specify values for the following predicates: | Predicate | Description | | --- | --- | | `asinCategorySameAs` | Negatively Target the same category as the category expressed. | | `asinBrandSameAs` | Target the brand that is the same as the brand expressed. | | `asinPriceLessThan` | Target a price that is less than the price expressed. | | `asinPriceBetween` | Target a price that is between the prices expressed. | | `asinPriceGreaterThan` | Target a price that is greater than the price expressed. | | `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. | | `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. | | `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. | | `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. | | `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. | | `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. | | `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only. | | `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements. | | `queryExactMatches` | Use this enum to exactly match your query with search queries. | | `queryPhraseMatches` | Use this enum to match your query with search phrases. | | `queryBroadMatches` | Use this enum to broadly match your query with search queries. | 

const (
	AsinAccessoryRelated        TargetingExpressionPredicateType = "asinAccessoryRelated"
	AsinAgeRangeSameAs          TargetingExpressionPredicateType = "asinAgeRangeSameAs"
	AsinBrandSameAs             TargetingExpressionPredicateType = "asinBrandSameAs"
	AsinCategorySameAs          TargetingExpressionPredicateType = "asinCategorySameAs"
	AsinExpandedFrom            TargetingExpressionPredicateType = "asinExpandedFrom"
	AsinGenreSameAs             TargetingExpressionPredicateType = "asinGenreSameAs"
	AsinIsPrimeShippingEligible TargetingExpressionPredicateType = "asinIsPrimeShippingEligible"
	AsinPriceBetween            TargetingExpressionPredicateType = "asinPriceBetween"
	AsinPriceGreaterThan        TargetingExpressionPredicateType = "asinPriceGreaterThan"
	AsinPriceLessThan           TargetingExpressionPredicateType = "asinPriceLessThan"
	AsinReviewRatingBetween     TargetingExpressionPredicateType = "asinReviewRatingBetween"
	AsinReviewRatingGreaterThan TargetingExpressionPredicateType = "asinReviewRatingGreaterThan"
	AsinReviewRatingLessThan    TargetingExpressionPredicateType = "asinReviewRatingLessThan"
	AsinSameAs                  TargetingExpressionPredicateType = "asinSameAs"
	AsinSubstituteRelated       TargetingExpressionPredicateType = "asinSubstituteRelated"
	QueryBroadMatches           TargetingExpressionPredicateType = "queryBroadMatches"
	QueryBroadRelMatches        TargetingExpressionPredicateType = "queryBroadRelMatches"
	QueryExactMatches           TargetingExpressionPredicateType = "queryExactMatches"
	QueryHighRelMatches         TargetingExpressionPredicateType = "queryHighRelMatches"
	QueryPhraseMatches          TargetingExpressionPredicateType = "queryPhraseMatches"
)

Defines values for TargetingExpressionPredicateType.

type Unauthorized 

type Unauthorized = Error

Unauthorized defines model for Unauthorized.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.