sponsoreddisplaybudget

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: 12 Imported by: 0

Documentation

Overview

Package sponsoreddisplaybudget 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

This section is empty.

Variables

This section is empty.

Functions

func NewCreateAssociatedBudgetRulesForSDCampaignsRequest

func NewCreateAssociatedBudgetRulesForSDCampaignsRequest(server string, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, body CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody) (*http.Request, error)

NewCreateAssociatedBudgetRulesForSDCampaignsRequest calls the generic CreateAssociatedBudgetRulesForSDCampaigns builder with application/json body

func NewCreateAssociatedBudgetRulesForSDCampaignsRequestWithBody

func NewCreateAssociatedBudgetRulesForSDCampaignsRequestWithBody(server string, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateAssociatedBudgetRulesForSDCampaignsRequestWithBody generates requests for CreateAssociatedBudgetRulesForSDCampaigns with any type of body

func NewCreateBrandSafetyDenyListDomainsRequest

func NewCreateBrandSafetyDenyListDomainsRequest(server string, params *CreateBrandSafetyDenyListDomainsParams, body CreateBrandSafetyDenyListDomainsJSONRequestBody) (*http.Request, error)

NewCreateBrandSafetyDenyListDomainsRequest calls the generic CreateBrandSafetyDenyListDomains builder with application/json body

func NewCreateBrandSafetyDenyListDomainsRequestWithBody

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

NewCreateBrandSafetyDenyListDomainsRequestWithBody generates requests for CreateBrandSafetyDenyListDomains with any type of body

func NewCreateBudgetRulesForSDCampaignsRequest

func NewCreateBudgetRulesForSDCampaignsRequest(server string, params *CreateBudgetRulesForSDCampaignsParams, body CreateBudgetRulesForSDCampaignsJSONRequestBody) (*http.Request, error)

NewCreateBudgetRulesForSDCampaignsRequest calls the generic CreateBudgetRulesForSDCampaigns builder with application/json body

func NewCreateBudgetRulesForSDCampaignsRequestWithBody

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

NewCreateBudgetRulesForSDCampaignsRequestWithBody generates requests for CreateBudgetRulesForSDCampaigns with any type of body

func NewCreateSnapshotRequest

func NewCreateSnapshotRequest(server string, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*http.Request, error)

NewCreateSnapshotRequest calls the generic CreateSnapshot builder with application/json body

func NewCreateSnapshotRequestWithBody

func NewCreateSnapshotRequestWithBody(server string, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateSnapshotRequestWithBody generates requests for CreateSnapshot with any type of body

func NewDeleteBrandSafetyDenyListRequest

func NewDeleteBrandSafetyDenyListRequest(server string, params *DeleteBrandSafetyDenyListParams) (*http.Request, error)

NewDeleteBrandSafetyDenyListRequest generates requests for DeleteBrandSafetyDenyList

func NewDisassociateAssociatedBudgetRuleForSDCampaignsRequest

func NewDisassociateAssociatedBudgetRuleForSDCampaignsRequest(server string, campaignId int64, budgetRuleId string, params *DisassociateAssociatedBudgetRuleForSDCampaignsParams) (*http.Request, error)

NewDisassociateAssociatedBudgetRuleForSDCampaignsRequest generates requests for DisassociateAssociatedBudgetRuleForSDCampaigns

func NewDownloadSnapshotByIdRequest

func NewDownloadSnapshotByIdRequest(server string, snapshotId string, params *DownloadSnapshotByIdParams) (*http.Request, error)

NewDownloadSnapshotByIdRequest generates requests for DownloadSnapshotById

func NewGetBudgetRuleByRuleIdForSDCampaignsRequest

func NewGetBudgetRuleByRuleIdForSDCampaignsRequest(server string, budgetRuleId string, params *GetBudgetRuleByRuleIdForSDCampaignsParams) (*http.Request, error)

NewGetBudgetRuleByRuleIdForSDCampaignsRequest generates requests for GetBudgetRuleByRuleIdForSDCampaigns

func NewGetCampaignsAssociatedWithSDBudgetRuleRequest

func NewGetCampaignsAssociatedWithSDBudgetRuleRequest(server string, budgetRuleId string, params *GetCampaignsAssociatedWithSDBudgetRuleParams) (*http.Request, error)

NewGetCampaignsAssociatedWithSDBudgetRuleRequest generates requests for GetCampaignsAssociatedWithSDBudgetRule

func NewGetHeadlineRecommendationsForSDRequestWithApplicationVndSdheadlinerecommendationrequestV40PlusJSONBody

func NewGetHeadlineRecommendationsForSDRequestWithApplicationVndSdheadlinerecommendationrequestV40PlusJSONBody(server string, params *GetHeadlineRecommendationsForSDParams, body GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody) (*http.Request, error)

NewGetHeadlineRecommendationsForSDRequestWithApplicationVndSdheadlinerecommendationrequestV40PlusJSONBody calls the generic GetHeadlineRecommendationsForSD builder with application/vnd.sdheadlinerecommendationrequest.v4.0+json body

func NewGetHeadlineRecommendationsForSDRequestWithBody

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

NewGetHeadlineRecommendationsForSDRequestWithBody generates requests for GetHeadlineRecommendationsForSD with any type of body

func NewGetRequestResultsRequest

func NewGetRequestResultsRequest(server string, requestId string, params *GetRequestResultsParams) (*http.Request, error)

NewGetRequestResultsRequest generates requests for GetRequestResults

func NewGetRequestStatusRequest

func NewGetRequestStatusRequest(server string, requestId string, params *GetRequestStatusParams) (*http.Request, error)

NewGetRequestStatusRequest generates requests for GetRequestStatus

func NewGetRuleBasedBudgetHistoryForSDCampaignsRequest

func NewGetRuleBasedBudgetHistoryForSDCampaignsRequest(server string, campaignId int64, params *GetRuleBasedBudgetHistoryForSDCampaignsParams) (*http.Request, error)

NewGetRuleBasedBudgetHistoryForSDCampaignsRequest generates requests for GetRuleBasedBudgetHistoryForSDCampaigns

func NewGetSDBudgetRecommendationsRequestWithApplicationVndSdbudgetrecommendationsV3PlusJSONBody

func NewGetSDBudgetRecommendationsRequestWithApplicationVndSdbudgetrecommendationsV3PlusJSONBody(server string, params *GetSDBudgetRecommendationsParams, body GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody) (*http.Request, error)

NewGetSDBudgetRecommendationsRequestWithApplicationVndSdbudgetrecommendationsV3PlusJSONBody calls the generic GetSDBudgetRecommendations builder with application/vnd.sdbudgetrecommendations.v3+json body

func NewGetSDBudgetRecommendationsRequestWithBody

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

NewGetSDBudgetRecommendationsRequestWithBody generates requests for GetSDBudgetRecommendations with any type of body

func NewGetSDBudgetRulesForAdvertiserRequest

func NewGetSDBudgetRulesForAdvertiserRequest(server string, params *GetSDBudgetRulesForAdvertiserParams) (*http.Request, error)

NewGetSDBudgetRulesForAdvertiserRequest generates requests for GetSDBudgetRulesForAdvertiser

func NewGetSnapshotByIdRequest

func NewGetSnapshotByIdRequest(server string, snapshotId string, params *GetSnapshotByIdParams) (*http.Request, error)

NewGetSnapshotByIdRequest generates requests for GetSnapshotById

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody(server string, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*http.Request, error)

NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody calls the generic GetTargetBidRecommendations builder with application/vnd.sdtargetingrecommendations.v3.1+json body

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody(server string, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*http.Request, error)

NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody calls the generic GetTargetBidRecommendations builder with application/vnd.sdtargetingrecommendations.v3.2+json body

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody

func NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody(server string, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*http.Request, error)

NewGetTargetBidRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody calls the generic GetTargetBidRecommendations builder with application/vnd.sdtargetingrecommendations.v3.3+json body

func NewGetTargetBidRecommendationsRequestWithBody

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

NewGetTargetBidRecommendationsRequestWithBody generates requests for GetTargetBidRecommendations with any type of body

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV30PlusJSONBody

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV30PlusJSONBody(server string, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody) (*http.Request, error)

NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV30PlusJSONBody calls the generic GetTargetRecommendations builder with application/vnd.sdtargetingrecommendations.v3.0+json body

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody(server string, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*http.Request, error)

NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody calls the generic GetTargetRecommendations builder with application/vnd.sdtargetingrecommendations.v3.1+json body

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody(server string, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*http.Request, error)

NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody calls the generic GetTargetRecommendations builder with application/vnd.sdtargetingrecommendations.v3.2+json body

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody(server string, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*http.Request, error)

NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody calls the generic GetTargetRecommendations builder with application/vnd.sdtargetingrecommendations.v3.3+json body

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV34PlusJSONBody

func NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV34PlusJSONBody(server string, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody) (*http.Request, error)

NewGetTargetRecommendationsRequestWithApplicationVndSdtargetingrecommendationsV34PlusJSONBody calls the generic GetTargetRecommendations builder with application/vnd.sdtargetingrecommendations.v3.4+json body

func NewGetTargetRecommendationsRequestWithBody

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

NewGetTargetRecommendationsRequestWithBody generates requests for GetTargetRecommendations with any type of body

func NewListAssociatedBudgetRulesForSDCampaignsRequest

func NewListAssociatedBudgetRulesForSDCampaignsRequest(server string, campaignId int64, params *ListAssociatedBudgetRulesForSDCampaignsParams) (*http.Request, error)

NewListAssociatedBudgetRulesForSDCampaignsRequest generates requests for ListAssociatedBudgetRulesForSDCampaigns

func NewListDomainsRequest

func NewListDomainsRequest(server string, params *ListDomainsParams) (*http.Request, error)

NewListDomainsRequest generates requests for ListDomains

func NewListRequestStatusRequest

func NewListRequestStatusRequest(server string, params *ListRequestStatusParams) (*http.Request, error)

NewListRequestStatusRequest generates requests for ListRequestStatus

func NewSdCampaignsBudgetUsageRequestWithApplicationVndSdcampaignbudgetusageV1PlusJSONBody

func NewSdCampaignsBudgetUsageRequestWithApplicationVndSdcampaignbudgetusageV1PlusJSONBody(server string, params *SdCampaignsBudgetUsageParams, body SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody) (*http.Request, error)

NewSdCampaignsBudgetUsageRequestWithApplicationVndSdcampaignbudgetusageV1PlusJSONBody calls the generic SdCampaignsBudgetUsage builder with application/vnd.sdcampaignbudgetusage.v1+json body

func NewSdCampaignsBudgetUsageRequestWithBody

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

NewSdCampaignsBudgetUsageRequestWithBody generates requests for SdCampaignsBudgetUsage with any type of body

func NewUpdateBudgetRulesForSDCampaignsRequest

func NewUpdateBudgetRulesForSDCampaignsRequest(server string, params *UpdateBudgetRulesForSDCampaignsParams, body UpdateBudgetRulesForSDCampaignsJSONRequestBody) (*http.Request, error)

NewUpdateBudgetRulesForSDCampaignsRequest calls the generic UpdateBudgetRulesForSDCampaigns builder with application/json body

func NewUpdateBudgetRulesForSDCampaignsRequestWithBody

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

NewUpdateBudgetRulesForSDCampaignsRequestWithBody generates requests for UpdateBudgetRulesForSDCampaigns with any type of body

Types

type AssociatedBudgetRuleResponse

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

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

	// RuleId The budget rule identifier.
	RuleId *string `json:"ruleId,omitempty"`
}

AssociatedBudgetRuleResponse defines model for AssociatedBudgetRuleResponse.

type AssociatedCampaign

type AssociatedCampaign struct {
	// CampaignId The campaign identifier.
	CampaignId string `json:"campaignId"`

	// CampaignName The campaign name.
	CampaignName string `json:"campaignName"`

	// RuleStatus The budget rule evaluation status for this campaign. Read-only.
	RuleStatus string `json:"ruleStatus"`
}

AssociatedCampaign defines model for AssociatedCampaign.

type BudgetChangeType

type BudgetChangeType string

BudgetChangeType The value by which to update the budget of the budget rule.

const (
	PERCENT BudgetChangeType = "PERCENT"
)

Defines values for BudgetChangeType.

type BudgetIncreaseBy

type BudgetIncreaseBy struct {
	// Type The value by which to update the budget of the budget rule.
	Type BudgetChangeType `json:"type"`

	// Value The budget value.
	Value float64 `json:"value"`
}

BudgetIncreaseBy defines model for budgetIncreaseBy.

type BudgetRuleError

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

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

BudgetRuleError The Error Response Object.

type BudgetRuleResponse

type BudgetRuleResponse struct {
	AssociatedCampaignIds *[]string `json:"associatedCampaignIds,omitempty"`

	// Code An enumerated success or error code for machine use.
	Code *string `json:"code,omitempty"`

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

	// RuleId The rule identifier.
	RuleId *string `json:"ruleId,omitempty"`
}

BudgetRuleResponse defines model for BudgetRuleResponse.

type BudgetUsageCampaign

type BudgetUsageCampaign struct {
	// Budget Budget amount of resource requested
	Budget *float32 `json:"budget,omitempty"`

	// BudgetUsagePercent Budget usage percentage (spend / available budget) for the given budget policy.
	BudgetUsagePercent *float32 `json:"budgetUsagePercent,omitempty"`

	// CampaignId ID of requested resource
	CampaignId *string `json:"campaignId,omitempty"`

	// Index An index to maintain order of the campaignIds
	Index *float32 `json:"index,omitempty"`

	// UsageUpdatedTimestamp Last evaluation time for budget usage
	UsageUpdatedTimestamp *time.Time `json:"usageUpdatedTimestamp,omitempty"`
}

BudgetUsageCampaign defines model for BudgetUsageCampaign.

type BudgetUsageCampaignBatchError

type BudgetUsageCampaignBatchError struct {
	// CampaignId ID of requested resource
	CampaignId *string `json:"campaignId,omitempty"`

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

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

	// Index An index to maintain order of the campaignIds
	Index *float32 `json:"index,omitempty"`
}

BudgetUsageCampaignBatchError defines model for BudgetUsageCampaignBatchError.

type BudgetUsageCampaignRequest

type BudgetUsageCampaignRequest struct {
	// CampaignIds A list of campaign IDs
	CampaignIds *[]string `json:"campaignIds,omitempty"`
}

BudgetUsageCampaignRequest defines model for BudgetUsageCampaignRequest.

type BudgetUsageCampaignResponse

type BudgetUsageCampaignResponse struct {
	// Error List of budget usage percentages that failed to pull
	Error *[]BudgetUsageCampaignBatchError `json:"error,omitempty"`

	// Success List of budget usage percentages that were successfully pulled
	Success *[]BudgetUsageCampaign `json:"success,omitempty"`
}

BudgetUsageCampaignResponse defines model for BudgetUsageCampaignResponse.

type BudgetUsageError

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

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

BudgetUsageError The Error Response Object.

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) CreateAssociatedBudgetRulesForSDCampaignsWithBody

func (c *Client) CreateAssociatedBudgetRulesForSDCampaignsWithBody(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateBrandSafetyDenyListDomainsWithBody

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

func (*Client) CreateBudgetRulesForSDCampaignsWithBody

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

func (*Client) CreateSnapshot

func (*Client) CreateSnapshotWithBody

func (c *Client) CreateSnapshotWithBody(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) DeleteBrandSafetyDenyList

func (c *Client) DeleteBrandSafetyDenyList(ctx context.Context, params *DeleteBrandSafetyDenyListParams) (*http.Response, error)

func (*Client) DisassociateAssociatedBudgetRuleForSDCampaigns

func (c *Client) DisassociateAssociatedBudgetRuleForSDCampaigns(ctx context.Context, campaignId int64, budgetRuleId string, params *DisassociateAssociatedBudgetRuleForSDCampaignsParams) (*http.Response, error)

func (*Client) DownloadSnapshotById

func (c *Client) DownloadSnapshotById(ctx context.Context, snapshotId string, params *DownloadSnapshotByIdParams) (*http.Response, error)

func (*Client) GetBudgetRuleByRuleIdForSDCampaigns

func (c *Client) GetBudgetRuleByRuleIdForSDCampaigns(ctx context.Context, budgetRuleId string, params *GetBudgetRuleByRuleIdForSDCampaignsParams) (*http.Response, error)

func (*Client) GetCampaignsAssociatedWithSDBudgetRule

func (c *Client) GetCampaignsAssociatedWithSDBudgetRule(ctx context.Context, budgetRuleId string, params *GetCampaignsAssociatedWithSDBudgetRuleParams) (*http.Response, error)

func (*Client) GetHeadlineRecommendationsForSDWithBody

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

func (*Client) GetRequestResults

func (c *Client) GetRequestResults(ctx context.Context, requestId string, params *GetRequestResultsParams) (*http.Response, error)

func (*Client) GetRequestStatus

func (c *Client) GetRequestStatus(ctx context.Context, requestId string, params *GetRequestStatusParams) (*http.Response, error)

func (*Client) GetRuleBasedBudgetHistoryForSDCampaigns

func (c *Client) GetRuleBasedBudgetHistoryForSDCampaigns(ctx context.Context, campaignId int64, params *GetRuleBasedBudgetHistoryForSDCampaignsParams) (*http.Response, error)

func (*Client) GetSDBudgetRecommendationsWithBody

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

func (*Client) GetSDBudgetRulesForAdvertiser

func (c *Client) GetSDBudgetRulesForAdvertiser(ctx context.Context, params *GetSDBudgetRulesForAdvertiserParams) (*http.Response, error)

func (*Client) GetSnapshotById

func (c *Client) GetSnapshotById(ctx context.Context, snapshotId string, params *GetSnapshotByIdParams) (*http.Response, error)

func (*Client) GetTargetBidRecommendationsWithBody

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

func (*Client) GetTargetRecommendationsWithBody

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

func (*Client) ListAssociatedBudgetRulesForSDCampaigns

func (c *Client) ListAssociatedBudgetRulesForSDCampaigns(ctx context.Context, campaignId int64, params *ListAssociatedBudgetRulesForSDCampaignsParams) (*http.Response, error)

func (*Client) ListDomains

func (c *Client) ListDomains(ctx context.Context, params *ListDomainsParams) (*http.Response, error)

func (*Client) ListRequestStatus

func (c *Client) ListRequestStatus(ctx context.Context, params *ListRequestStatusParams) (*http.Response, error)

func (*Client) SdCampaignsBudgetUsageWithBody

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

func (*Client) UpdateBudgetRulesForSDCampaignsWithBody

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

type ClientHeader

type ClientHeader = string

ClientHeader defines model for clientHeader.

type ClientInterface

type ClientInterface interface {
	// DeleteBrandSafetyDenyList request
	DeleteBrandSafetyDenyList(ctx context.Context, params *DeleteBrandSafetyDenyListParams) (*http.Response, error)

	// ListDomains request
	ListDomains(ctx context.Context, params *ListDomainsParams) (*http.Response, error)

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

	CreateBrandSafetyDenyListDomains(ctx context.Context, params *CreateBrandSafetyDenyListDomainsParams, body CreateBrandSafetyDenyListDomainsJSONRequestBody) (*http.Response, error)

	// ListRequestStatus request
	ListRequestStatus(ctx context.Context, params *ListRequestStatusParams) (*http.Response, error)

	// GetRequestResults request
	GetRequestResults(ctx context.Context, requestId string, params *GetRequestResultsParams) (*http.Response, error)

	// GetRequestStatus request
	GetRequestStatus(ctx context.Context, requestId string, params *GetRequestStatusParams) (*http.Response, error)

	// GetSDBudgetRulesForAdvertiser request
	GetSDBudgetRulesForAdvertiser(ctx context.Context, params *GetSDBudgetRulesForAdvertiserParams) (*http.Response, error)

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

	CreateBudgetRulesForSDCampaigns(ctx context.Context, params *CreateBudgetRulesForSDCampaignsParams, body CreateBudgetRulesForSDCampaignsJSONRequestBody) (*http.Response, error)

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

	UpdateBudgetRulesForSDCampaigns(ctx context.Context, params *UpdateBudgetRulesForSDCampaignsParams, body UpdateBudgetRulesForSDCampaignsJSONRequestBody) (*http.Response, error)

	// GetBudgetRuleByRuleIdForSDCampaigns request
	GetBudgetRuleByRuleIdForSDCampaigns(ctx context.Context, budgetRuleId string, params *GetBudgetRuleByRuleIdForSDCampaignsParams) (*http.Response, error)

	// GetCampaignsAssociatedWithSDBudgetRule request
	GetCampaignsAssociatedWithSDBudgetRule(ctx context.Context, budgetRuleId string, params *GetCampaignsAssociatedWithSDBudgetRuleParams) (*http.Response, error)

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

	SdCampaignsBudgetUsageWithApplicationVndSdcampaignbudgetusageV1PlusJSONBody(ctx context.Context, params *SdCampaignsBudgetUsageParams, body SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody) (*http.Response, error)

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

	GetSDBudgetRecommendationsWithApplicationVndSdbudgetrecommendationsV3PlusJSONBody(ctx context.Context, params *GetSDBudgetRecommendationsParams, body GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody) (*http.Response, error)

	// ListAssociatedBudgetRulesForSDCampaigns request
	ListAssociatedBudgetRulesForSDCampaigns(ctx context.Context, campaignId int64, params *ListAssociatedBudgetRulesForSDCampaignsParams) (*http.Response, error)

	// CreateAssociatedBudgetRulesForSDCampaignsWithBody request with any body
	CreateAssociatedBudgetRulesForSDCampaignsWithBody(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*http.Response, error)

	CreateAssociatedBudgetRulesForSDCampaigns(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, body CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody) (*http.Response, error)

	// GetRuleBasedBudgetHistoryForSDCampaigns request
	GetRuleBasedBudgetHistoryForSDCampaigns(ctx context.Context, campaignId int64, params *GetRuleBasedBudgetHistoryForSDCampaignsParams) (*http.Response, error)

	// DisassociateAssociatedBudgetRuleForSDCampaigns request
	DisassociateAssociatedBudgetRuleForSDCampaigns(ctx context.Context, campaignId int64, budgetRuleId string, params *DisassociateAssociatedBudgetRuleForSDCampaignsParams) (*http.Response, error)

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

	GetHeadlineRecommendationsForSDWithApplicationVndSdheadlinerecommendationrequestV40PlusJSONBody(ctx context.Context, params *GetHeadlineRecommendationsForSDParams, body GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody) (*http.Response, error)

	// GetSnapshotById request
	GetSnapshotById(ctx context.Context, snapshotId string, params *GetSnapshotByIdParams) (*http.Response, error)

	// DownloadSnapshotById request
	DownloadSnapshotById(ctx context.Context, snapshotId string, params *DownloadSnapshotByIdParams) (*http.Response, error)

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

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*http.Response, error)

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*http.Response, error)

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*http.Response, error)

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

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV30PlusJSONBody(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody) (*http.Response, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV31PlusJSONBody(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*http.Response, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV32PlusJSONBody(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*http.Response, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV33PlusJSONBody(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*http.Response, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV34PlusJSONBody(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody) (*http.Response, error)

	// CreateSnapshotWithBody request with any body
	CreateSnapshotWithBody(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, contentType string, body io.Reader) (*http.Response, error)

	CreateSnapshot(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*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 added in v0.0.2

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) CreateAssociatedBudgetRulesForSDCampaignsWithBodyWithResponse

func (c *ClientWithResponses) CreateAssociatedBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*CreateAssociatedBudgetRulesForSDCampaignsResp, error)

CreateAssociatedBudgetRulesForSDCampaignsWithBodyWithResponse request with arbitrary body returning *CreateAssociatedBudgetRulesForSDCampaignsResp

func (*ClientWithResponses) CreateBrandSafetyDenyListDomainsWithBodyWithResponse

func (c *ClientWithResponses) CreateBrandSafetyDenyListDomainsWithBodyWithResponse(ctx context.Context, params *CreateBrandSafetyDenyListDomainsParams, contentType string, body io.Reader) (*CreateBrandSafetyDenyListDomainsResp, error)

CreateBrandSafetyDenyListDomainsWithBodyWithResponse request with arbitrary body returning *CreateBrandSafetyDenyListDomainsResp

func (*ClientWithResponses) CreateBudgetRulesForSDCampaignsWithBodyWithResponse

func (c *ClientWithResponses) CreateBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, params *CreateBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*CreateBudgetRulesForSDCampaignsResp, error)

CreateBudgetRulesForSDCampaignsWithBodyWithResponse request with arbitrary body returning *CreateBudgetRulesForSDCampaignsResp

func (*ClientWithResponses) CreateSnapshotWithBodyWithResponse

func (c *ClientWithResponses) CreateSnapshotWithBodyWithResponse(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, contentType string, body io.Reader) (*CreateSnapshotResp, error)

CreateSnapshotWithBodyWithResponse request with arbitrary body returning *CreateSnapshotResp

func (*ClientWithResponses) CreateSnapshotWithResponse

func (*ClientWithResponses) DeleteBrandSafetyDenyListWithResponse

func (c *ClientWithResponses) DeleteBrandSafetyDenyListWithResponse(ctx context.Context, params *DeleteBrandSafetyDenyListParams) (*DeleteBrandSafetyDenyListResp, error)

DeleteBrandSafetyDenyListWithResponse request returning *DeleteBrandSafetyDenyListResp

func (*ClientWithResponses) DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse

func (c *ClientWithResponses) DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse(ctx context.Context, campaignId int64, budgetRuleId string, params *DisassociateAssociatedBudgetRuleForSDCampaignsParams) (*DisassociateAssociatedBudgetRuleForSDCampaignsResp, error)

DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse request returning *DisassociateAssociatedBudgetRuleForSDCampaignsResp

func (*ClientWithResponses) DownloadSnapshotByIdWithResponse

func (c *ClientWithResponses) DownloadSnapshotByIdWithResponse(ctx context.Context, snapshotId string, params *DownloadSnapshotByIdParams) (*DownloadSnapshotByIdResp, error)

DownloadSnapshotByIdWithResponse request returning *DownloadSnapshotByIdResp

func (*ClientWithResponses) GetBudgetRuleByRuleIdForSDCampaignsWithResponse

func (c *ClientWithResponses) GetBudgetRuleByRuleIdForSDCampaignsWithResponse(ctx context.Context, budgetRuleId string, params *GetBudgetRuleByRuleIdForSDCampaignsParams) (*GetBudgetRuleByRuleIdForSDCampaignsResp, error)

GetBudgetRuleByRuleIdForSDCampaignsWithResponse request returning *GetBudgetRuleByRuleIdForSDCampaignsResp

func (*ClientWithResponses) GetCampaignsAssociatedWithSDBudgetRuleWithResponse

func (c *ClientWithResponses) GetCampaignsAssociatedWithSDBudgetRuleWithResponse(ctx context.Context, budgetRuleId string, params *GetCampaignsAssociatedWithSDBudgetRuleParams) (*GetCampaignsAssociatedWithSDBudgetRuleResp, error)

GetCampaignsAssociatedWithSDBudgetRuleWithResponse request returning *GetCampaignsAssociatedWithSDBudgetRuleResp

func (*ClientWithResponses) GetHeadlineRecommendationsForSDWithBodyWithResponse

func (c *ClientWithResponses) GetHeadlineRecommendationsForSDWithBodyWithResponse(ctx context.Context, params *GetHeadlineRecommendationsForSDParams, contentType string, body io.Reader) (*GetHeadlineRecommendationsForSDResp, error)

GetHeadlineRecommendationsForSDWithBodyWithResponse request with arbitrary body returning *GetHeadlineRecommendationsForSDResp

func (*ClientWithResponses) GetRequestResultsWithResponse

func (c *ClientWithResponses) GetRequestResultsWithResponse(ctx context.Context, requestId string, params *GetRequestResultsParams) (*GetRequestResultsResp, error)

GetRequestResultsWithResponse request returning *GetRequestResultsResp

func (*ClientWithResponses) GetRequestStatusWithResponse

func (c *ClientWithResponses) GetRequestStatusWithResponse(ctx context.Context, requestId string, params *GetRequestStatusParams) (*GetRequestStatusResp, error)

GetRequestStatusWithResponse request returning *GetRequestStatusResp

func (*ClientWithResponses) GetRuleBasedBudgetHistoryForSDCampaignsWithResponse

func (c *ClientWithResponses) GetRuleBasedBudgetHistoryForSDCampaignsWithResponse(ctx context.Context, campaignId int64, params *GetRuleBasedBudgetHistoryForSDCampaignsParams) (*GetRuleBasedBudgetHistoryForSDCampaignsResp, error)

GetRuleBasedBudgetHistoryForSDCampaignsWithResponse request returning *GetRuleBasedBudgetHistoryForSDCampaignsResp

func (*ClientWithResponses) GetSDBudgetRecommendationsWithBodyWithResponse

func (c *ClientWithResponses) GetSDBudgetRecommendationsWithBodyWithResponse(ctx context.Context, params *GetSDBudgetRecommendationsParams, contentType string, body io.Reader) (*GetSDBudgetRecommendationsResp, error)

GetSDBudgetRecommendationsWithBodyWithResponse request with arbitrary body returning *GetSDBudgetRecommendationsResp

func (*ClientWithResponses) GetSDBudgetRulesForAdvertiserWithResponse

func (c *ClientWithResponses) GetSDBudgetRulesForAdvertiserWithResponse(ctx context.Context, params *GetSDBudgetRulesForAdvertiserParams) (*GetSDBudgetRulesForAdvertiserResp, error)

GetSDBudgetRulesForAdvertiserWithResponse request returning *GetSDBudgetRulesForAdvertiserResp

func (*ClientWithResponses) GetSnapshotByIdWithResponse

func (c *ClientWithResponses) GetSnapshotByIdWithResponse(ctx context.Context, snapshotId string, params *GetSnapshotByIdParams) (*GetSnapshotByIdResp, error)

GetSnapshotByIdWithResponse request returning *GetSnapshotByIdResp

func (*ClientWithResponses) GetTargetBidRecommendationsWithBodyWithResponse

func (c *ClientWithResponses) GetTargetBidRecommendationsWithBodyWithResponse(ctx context.Context, params *GetTargetBidRecommendationsParams, contentType string, body io.Reader) (*GetTargetBidRecommendationsResp, error)

GetTargetBidRecommendationsWithBodyWithResponse request with arbitrary body returning *GetTargetBidRecommendationsResp

func (*ClientWithResponses) GetTargetRecommendationsWithBodyWithResponse

func (c *ClientWithResponses) GetTargetRecommendationsWithBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, contentType string, body io.Reader) (*GetTargetRecommendationsResp, error)

GetTargetRecommendationsWithBodyWithResponse request with arbitrary body returning *GetTargetRecommendationsResp

func (*ClientWithResponses) ListAssociatedBudgetRulesForSDCampaignsWithResponse

func (c *ClientWithResponses) ListAssociatedBudgetRulesForSDCampaignsWithResponse(ctx context.Context, campaignId int64, params *ListAssociatedBudgetRulesForSDCampaignsParams) (*ListAssociatedBudgetRulesForSDCampaignsResp, error)

ListAssociatedBudgetRulesForSDCampaignsWithResponse request returning *ListAssociatedBudgetRulesForSDCampaignsResp

func (*ClientWithResponses) ListDomainsWithResponse

func (c *ClientWithResponses) ListDomainsWithResponse(ctx context.Context, params *ListDomainsParams) (*ListDomainsResp, error)

ListDomainsWithResponse request returning *ListDomainsResp

func (*ClientWithResponses) ListRequestStatusWithResponse

func (c *ClientWithResponses) ListRequestStatusWithResponse(ctx context.Context, params *ListRequestStatusParams) (*ListRequestStatusResp, error)

ListRequestStatusWithResponse request returning *ListRequestStatusResp

func (*ClientWithResponses) SdCampaignsBudgetUsageWithBodyWithResponse

func (c *ClientWithResponses) SdCampaignsBudgetUsageWithBodyWithResponse(ctx context.Context, params *SdCampaignsBudgetUsageParams, contentType string, body io.Reader) (*SdCampaignsBudgetUsageResp, error)

SdCampaignsBudgetUsageWithBodyWithResponse request with arbitrary body returning *SdCampaignsBudgetUsageResp

func (*ClientWithResponses) UpdateBudgetRulesForSDCampaignsWithBodyWithResponse

func (c *ClientWithResponses) UpdateBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, params *UpdateBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*UpdateBudgetRulesForSDCampaignsResp, error)

UpdateBudgetRulesForSDCampaignsWithBodyWithResponse request with arbitrary body returning *UpdateBudgetRulesForSDCampaignsResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// DeleteBrandSafetyDenyListWithResponse request
	DeleteBrandSafetyDenyListWithResponse(ctx context.Context, params *DeleteBrandSafetyDenyListParams) (*DeleteBrandSafetyDenyListResp, error)

	// ListDomainsWithResponse request
	ListDomainsWithResponse(ctx context.Context, params *ListDomainsParams) (*ListDomainsResp, error)

	// CreateBrandSafetyDenyListDomainsWithBodyWithResponse request with any body
	CreateBrandSafetyDenyListDomainsWithBodyWithResponse(ctx context.Context, params *CreateBrandSafetyDenyListDomainsParams, contentType string, body io.Reader) (*CreateBrandSafetyDenyListDomainsResp, error)

	CreateBrandSafetyDenyListDomainsWithResponse(ctx context.Context, params *CreateBrandSafetyDenyListDomainsParams, body CreateBrandSafetyDenyListDomainsJSONRequestBody) (*CreateBrandSafetyDenyListDomainsResp, error)

	// ListRequestStatusWithResponse request
	ListRequestStatusWithResponse(ctx context.Context, params *ListRequestStatusParams) (*ListRequestStatusResp, error)

	// GetRequestResultsWithResponse request
	GetRequestResultsWithResponse(ctx context.Context, requestId string, params *GetRequestResultsParams) (*GetRequestResultsResp, error)

	// GetRequestStatusWithResponse request
	GetRequestStatusWithResponse(ctx context.Context, requestId string, params *GetRequestStatusParams) (*GetRequestStatusResp, error)

	// GetSDBudgetRulesForAdvertiserWithResponse request
	GetSDBudgetRulesForAdvertiserWithResponse(ctx context.Context, params *GetSDBudgetRulesForAdvertiserParams) (*GetSDBudgetRulesForAdvertiserResp, error)

	// CreateBudgetRulesForSDCampaignsWithBodyWithResponse request with any body
	CreateBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, params *CreateBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*CreateBudgetRulesForSDCampaignsResp, error)

	CreateBudgetRulesForSDCampaignsWithResponse(ctx context.Context, params *CreateBudgetRulesForSDCampaignsParams, body CreateBudgetRulesForSDCampaignsJSONRequestBody) (*CreateBudgetRulesForSDCampaignsResp, error)

	// UpdateBudgetRulesForSDCampaignsWithBodyWithResponse request with any body
	UpdateBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, params *UpdateBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*UpdateBudgetRulesForSDCampaignsResp, error)

	UpdateBudgetRulesForSDCampaignsWithResponse(ctx context.Context, params *UpdateBudgetRulesForSDCampaignsParams, body UpdateBudgetRulesForSDCampaignsJSONRequestBody) (*UpdateBudgetRulesForSDCampaignsResp, error)

	// GetBudgetRuleByRuleIdForSDCampaignsWithResponse request
	GetBudgetRuleByRuleIdForSDCampaignsWithResponse(ctx context.Context, budgetRuleId string, params *GetBudgetRuleByRuleIdForSDCampaignsParams) (*GetBudgetRuleByRuleIdForSDCampaignsResp, error)

	// GetCampaignsAssociatedWithSDBudgetRuleWithResponse request
	GetCampaignsAssociatedWithSDBudgetRuleWithResponse(ctx context.Context, budgetRuleId string, params *GetCampaignsAssociatedWithSDBudgetRuleParams) (*GetCampaignsAssociatedWithSDBudgetRuleResp, error)

	// SdCampaignsBudgetUsageWithBodyWithResponse request with any body
	SdCampaignsBudgetUsageWithBodyWithResponse(ctx context.Context, params *SdCampaignsBudgetUsageParams, contentType string, body io.Reader) (*SdCampaignsBudgetUsageResp, error)

	SdCampaignsBudgetUsageWithApplicationVndSdcampaignbudgetusageV1PlusJSONBodyWithResponse(ctx context.Context, params *SdCampaignsBudgetUsageParams, body SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody) (*SdCampaignsBudgetUsageResp, error)

	// GetSDBudgetRecommendationsWithBodyWithResponse request with any body
	GetSDBudgetRecommendationsWithBodyWithResponse(ctx context.Context, params *GetSDBudgetRecommendationsParams, contentType string, body io.Reader) (*GetSDBudgetRecommendationsResp, error)

	GetSDBudgetRecommendationsWithApplicationVndSdbudgetrecommendationsV3PlusJSONBodyWithResponse(ctx context.Context, params *GetSDBudgetRecommendationsParams, body GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody) (*GetSDBudgetRecommendationsResp, error)

	// ListAssociatedBudgetRulesForSDCampaignsWithResponse request
	ListAssociatedBudgetRulesForSDCampaignsWithResponse(ctx context.Context, campaignId int64, params *ListAssociatedBudgetRulesForSDCampaignsParams) (*ListAssociatedBudgetRulesForSDCampaignsResp, error)

	// CreateAssociatedBudgetRulesForSDCampaignsWithBodyWithResponse request with any body
	CreateAssociatedBudgetRulesForSDCampaignsWithBodyWithResponse(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, contentType string, body io.Reader) (*CreateAssociatedBudgetRulesForSDCampaignsResp, error)

	CreateAssociatedBudgetRulesForSDCampaignsWithResponse(ctx context.Context, campaignId int64, params *CreateAssociatedBudgetRulesForSDCampaignsParams, body CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody) (*CreateAssociatedBudgetRulesForSDCampaignsResp, error)

	// GetRuleBasedBudgetHistoryForSDCampaignsWithResponse request
	GetRuleBasedBudgetHistoryForSDCampaignsWithResponse(ctx context.Context, campaignId int64, params *GetRuleBasedBudgetHistoryForSDCampaignsParams) (*GetRuleBasedBudgetHistoryForSDCampaignsResp, error)

	// DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse request
	DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse(ctx context.Context, campaignId int64, budgetRuleId string, params *DisassociateAssociatedBudgetRuleForSDCampaignsParams) (*DisassociateAssociatedBudgetRuleForSDCampaignsResp, error)

	// GetHeadlineRecommendationsForSDWithBodyWithResponse request with any body
	GetHeadlineRecommendationsForSDWithBodyWithResponse(ctx context.Context, params *GetHeadlineRecommendationsForSDParams, contentType string, body io.Reader) (*GetHeadlineRecommendationsForSDResp, error)

	GetHeadlineRecommendationsForSDWithApplicationVndSdheadlinerecommendationrequestV40PlusJSONBodyWithResponse(ctx context.Context, params *GetHeadlineRecommendationsForSDParams, body GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody) (*GetHeadlineRecommendationsForSDResp, error)

	// GetSnapshotByIdWithResponse request
	GetSnapshotByIdWithResponse(ctx context.Context, snapshotId string, params *GetSnapshotByIdParams) (*GetSnapshotByIdResp, error)

	// DownloadSnapshotByIdWithResponse request
	DownloadSnapshotByIdWithResponse(ctx context.Context, snapshotId string, params *DownloadSnapshotByIdParams) (*DownloadSnapshotByIdResp, error)

	// GetTargetBidRecommendationsWithBodyWithResponse request with any body
	GetTargetBidRecommendationsWithBodyWithResponse(ctx context.Context, params *GetTargetBidRecommendationsParams, contentType string, body io.Reader) (*GetTargetBidRecommendationsResp, error)

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV31PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*GetTargetBidRecommendationsResp, error)

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV32PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*GetTargetBidRecommendationsResp, error)

	GetTargetBidRecommendationsWithApplicationVndSdtargetingrecommendationsV33PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetBidRecommendationsParams, body GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*GetTargetBidRecommendationsResp, error)

	// GetTargetRecommendationsWithBodyWithResponse request with any body
	GetTargetRecommendationsWithBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, contentType string, body io.Reader) (*GetTargetRecommendationsResp, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV30PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody) (*GetTargetRecommendationsResp, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV31PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody) (*GetTargetRecommendationsResp, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV32PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody) (*GetTargetRecommendationsResp, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV33PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody) (*GetTargetRecommendationsResp, error)

	GetTargetRecommendationsWithApplicationVndSdtargetingrecommendationsV34PlusJSONBodyWithResponse(ctx context.Context, params *GetTargetRecommendationsParams, body GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody) (*GetTargetRecommendationsResp, error)

	// CreateSnapshotWithBodyWithResponse request with any body
	CreateSnapshotWithBodyWithResponse(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, contentType string, body io.Reader) (*CreateSnapshotResp, error)

	CreateSnapshotWithResponse(ctx context.Context, recordType CreateSnapshotParamsRecordType, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*CreateSnapshotResp, error)
}

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

type ComparisonOperator

type ComparisonOperator string

ComparisonOperator The comparison operator.

const (
	GREATERTHAN          ComparisonOperator = "GREATER_THAN"
	GREATERTHANOREQUALTO ComparisonOperator = "GREATER_THAN_OR_EQUAL_TO"
	LESSTHAN             ComparisonOperator = "LESS_THAN"
	LESSTHANOREQUALTO    ComparisonOperator = "LESS_THAN_OR_EQUAL_TO"
)

Defines values for ComparisonOperator.

type CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody

type CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody = CreateAssociatedBudgetRulesRequest

CreateAssociatedBudgetRulesForSDCampaignsJSONRequestBody defines body for CreateAssociatedBudgetRulesForSDCampaigns for application/json ContentType.

type CreateAssociatedBudgetRulesForSDCampaignsParams

type CreateAssociatedBudgetRulesForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

CreateAssociatedBudgetRulesForSDCampaignsParams defines parameters for CreateAssociatedBudgetRulesForSDCampaigns.

type CreateAssociatedBudgetRulesForSDCampaignsResp

type CreateAssociatedBudgetRulesForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *CreateAssociatedBudgetRulesResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseCreateAssociatedBudgetRulesForSDCampaignsResp

func ParseCreateAssociatedBudgetRulesForSDCampaignsResp(rsp *http.Response) (*CreateAssociatedBudgetRulesForSDCampaignsResp, error)

ParseCreateAssociatedBudgetRulesForSDCampaignsResp parses an HTTP response from a CreateAssociatedBudgetRulesForSDCampaignsWithResponse call

func (CreateAssociatedBudgetRulesForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (CreateAssociatedBudgetRulesForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateAssociatedBudgetRulesRequest

type CreateAssociatedBudgetRulesRequest struct {
	// BudgetRuleIds A list of budget rule identifiers.
	BudgetRuleIds *[]string `json:"budgetRuleIds,omitempty"`
}

CreateAssociatedBudgetRulesRequest defines model for CreateAssociatedBudgetRulesRequest.

type CreateAssociatedBudgetRulesResponse

type CreateAssociatedBudgetRulesResponse struct {
	Responses *[]AssociatedBudgetRuleResponse `json:"responses,omitempty"`
}

CreateAssociatedBudgetRulesResponse defines model for CreateAssociatedBudgetRulesResponse.

type CreateBrandSafetyDenyListDomainsJSONRequestBody

type CreateBrandSafetyDenyListDomainsJSONRequestBody = SDBrandSafetyPostRequest

CreateBrandSafetyDenyListDomainsJSONRequestBody defines body for CreateBrandSafetyDenyListDomains for application/json ContentType.

type CreateBrandSafetyDenyListDomainsParams

type CreateBrandSafetyDenyListDomainsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateBrandSafetyDenyListDomainsParams defines parameters for CreateBrandSafetyDenyListDomains.

type CreateBrandSafetyDenyListDomainsResp

type CreateBrandSafetyDenyListDomainsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SDBrandSafetyUpdateResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseCreateBrandSafetyDenyListDomainsResp

func ParseCreateBrandSafetyDenyListDomainsResp(rsp *http.Response) (*CreateBrandSafetyDenyListDomainsResp, error)

ParseCreateBrandSafetyDenyListDomainsResp parses an HTTP response from a CreateBrandSafetyDenyListDomainsWithResponse call

func (CreateBrandSafetyDenyListDomainsResp) Status

Status returns HTTPResponse.Status

func (CreateBrandSafetyDenyListDomainsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateBudgetRulesForSDCampaignsJSONRequestBody

type CreateBudgetRulesForSDCampaignsJSONRequestBody = CreateSDBudgetRulesRequest

CreateBudgetRulesForSDCampaignsJSONRequestBody defines body for CreateBudgetRulesForSDCampaigns for application/json ContentType.

type CreateBudgetRulesForSDCampaignsParams

type CreateBudgetRulesForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

CreateBudgetRulesForSDCampaignsParams defines parameters for CreateBudgetRulesForSDCampaigns.

type CreateBudgetRulesForSDCampaignsResp

type CreateBudgetRulesForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *CreateBudgetRulesResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseCreateBudgetRulesForSDCampaignsResp

func ParseCreateBudgetRulesForSDCampaignsResp(rsp *http.Response) (*CreateBudgetRulesForSDCampaignsResp, error)

ParseCreateBudgetRulesForSDCampaignsResp parses an HTTP response from a CreateBudgetRulesForSDCampaignsWithResponse call

func (CreateBudgetRulesForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (CreateBudgetRulesForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateBudgetRulesResponse

type CreateBudgetRulesResponse struct {
	Responses *[]BudgetRuleResponse `json:"responses,omitempty"`
}

CreateBudgetRulesResponse defines model for CreateBudgetRulesResponse.

type CreateSDBudgetRulesRequest

type CreateSDBudgetRulesRequest struct {
	// BudgetRulesDetails A list of budget rule details.
	BudgetRulesDetails *[]SDBudgetRuleDetails `json:"budgetRulesDetails,omitempty"`
}

CreateSDBudgetRulesRequest defines model for CreateSDBudgetRulesRequest.

type CreateSnapshotJSONRequestBody

type CreateSnapshotJSONRequestBody = SnapshotRequest

CreateSnapshotJSONRequestBody defines body for CreateSnapshot for application/json ContentType.

type CreateSnapshotParams

type CreateSnapshotParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `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 string `json:"Amazon-Advertising-API-Scope"`
}

CreateSnapshotParams defines parameters for CreateSnapshot.

type CreateSnapshotParamsRecordType

type CreateSnapshotParamsRecordType string

CreateSnapshotParamsRecordType defines parameters for CreateSnapshot.

const (
	CreateSnapshotParamsRecordTypeAdGroups        CreateSnapshotParamsRecordType = "adGroups"
	CreateSnapshotParamsRecordTypeCampaigns       CreateSnapshotParamsRecordType = "campaigns"
	CreateSnapshotParamsRecordTypeNegativeTargets CreateSnapshotParamsRecordType = "negativeTargets"
	CreateSnapshotParamsRecordTypeProductAds      CreateSnapshotParamsRecordType = "productAds"
	CreateSnapshotParamsRecordTypeTargets         CreateSnapshotParamsRecordType = "targets"
)

Defines values for CreateSnapshotParamsRecordType.

type CreateSnapshotResp

type CreateSnapshotResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SnapshotResponse
	JSON400      *SdDefaultError
	JSON401      *SdDefaultError
	JSON403      *SdDefaultError
	JSON429      *SdDefaultError
	JSON500      *SdDefaultError
}

func ParseCreateSnapshotResp

func ParseCreateSnapshotResp(rsp *http.Response) (*CreateSnapshotResp, error)

ParseCreateSnapshotResp parses an HTTP response from a CreateSnapshotWithResponse call

func (CreateSnapshotResp) Status

func (r CreateSnapshotResp) Status() string

Status returns HTTPResponse.Status

func (CreateSnapshotResp) StatusCode

func (r CreateSnapshotResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DateRangeTypeRuleDuration

type DateRangeTypeRuleDuration struct {
	// EndDate The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.
	EndDate *string `json:"endDate,omitempty"`

	// StartDate The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.
	StartDate string `json:"startDate"`
}

DateRangeTypeRuleDuration Object representing date range type rule duration.

type DayOfWeek

type DayOfWeek string

DayOfWeek The day of the week.

const (
	FRIDAY    DayOfWeek = "FRIDAY"
	MONDAY    DayOfWeek = "MONDAY"
	SATURDAY  DayOfWeek = "SATURDAY"
	SUNDAY    DayOfWeek = "SUNDAY"
	THURSDAY  DayOfWeek = "THURSDAY"
	TUESDAY   DayOfWeek = "TUESDAY"
	WEDNESDAY DayOfWeek = "WEDNESDAY"
)

Defines values for DayOfWeek.

type DeleteBrandSafetyDenyListParams

type DeleteBrandSafetyDenyListParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

DeleteBrandSafetyDenyListParams defines parameters for DeleteBrandSafetyDenyList.

type DeleteBrandSafetyDenyListResp

type DeleteBrandSafetyDenyListResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SDBrandSafetyUpdateResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseDeleteBrandSafetyDenyListResp

func ParseDeleteBrandSafetyDenyListResp(rsp *http.Response) (*DeleteBrandSafetyDenyListResp, error)

ParseDeleteBrandSafetyDenyListResp parses an HTTP response from a DeleteBrandSafetyDenyListWithResponse call

func (DeleteBrandSafetyDenyListResp) Status

Status returns HTTPResponse.Status

func (DeleteBrandSafetyDenyListResp) StatusCode

func (r DeleteBrandSafetyDenyListResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisassociateAssociatedBudgetRuleForSDCampaignsParams

type DisassociateAssociatedBudgetRuleForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

DisassociateAssociatedBudgetRuleForSDCampaignsParams defines parameters for DisassociateAssociatedBudgetRuleForSDCampaigns.

type DisassociateAssociatedBudgetRuleForSDCampaignsResp

type DisassociateAssociatedBudgetRuleForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DisassociateAssociatedBudgetRuleResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseDisassociateAssociatedBudgetRuleForSDCampaignsResp

func ParseDisassociateAssociatedBudgetRuleForSDCampaignsResp(rsp *http.Response) (*DisassociateAssociatedBudgetRuleForSDCampaignsResp, error)

ParseDisassociateAssociatedBudgetRuleForSDCampaignsResp parses an HTTP response from a DisassociateAssociatedBudgetRuleForSDCampaignsWithResponse call

func (DisassociateAssociatedBudgetRuleForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (DisassociateAssociatedBudgetRuleForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DisassociateAssociatedBudgetRuleResponse

type DisassociateAssociatedBudgetRuleResponse = map[string]interface{}

DisassociateAssociatedBudgetRuleResponse defines model for DisassociateAssociatedBudgetRuleResponse.

type DownloadSnapshotByIdParams

type DownloadSnapshotByIdParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `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 string `json:"Amazon-Advertising-API-Scope"`
}

DownloadSnapshotByIdParams defines parameters for DownloadSnapshotById.

type DownloadSnapshotByIdResp

type DownloadSnapshotByIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SnapshotResponse
	JSON400      *SdDefaultError
	JSON401      *SdDefaultError
	JSON403      *SdDefaultError
	JSON429      *SdDefaultError
	JSON500      *SdDefaultError
}

func ParseDownloadSnapshotByIdResp

func ParseDownloadSnapshotByIdResp(rsp *http.Response) (*DownloadSnapshotByIdResp, error)

ParseDownloadSnapshotByIdResp parses an HTTP response from a DownloadSnapshotByIdWithResponse call

func (DownloadSnapshotByIdResp) Status

func (r DownloadSnapshotByIdResp) Status() string

Status returns HTTPResponse.Status

func (DownloadSnapshotByIdResp) StatusCode

func (r DownloadSnapshotByIdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EventTypeRuleDuration

type EventTypeRuleDuration struct {
	// EndDate The event end date in YYYYMMDD format. Read-only.
	EndDate *string `json:"endDate,omitempty"`

	// EventId The event identifier. This value is available from the budget rules recommendation API.
	EventId string `json:"eventId"`

	// EventName The event name. Read-only.
	EventName *string `json:"eventName,omitempty"`

	// StartDate The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.
	StartDate *string `json:"startDate,omitempty"`
}

EventTypeRuleDuration Object representing event type rule duration.

type GetBudgetRuleByRuleIdForSDCampaignsParams

type GetBudgetRuleByRuleIdForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

GetBudgetRuleByRuleIdForSDCampaignsParams defines parameters for GetBudgetRuleByRuleIdForSDCampaigns.

type GetBudgetRuleByRuleIdForSDCampaignsResp

type GetBudgetRuleByRuleIdForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSDBudgetRuleResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseGetBudgetRuleByRuleIdForSDCampaignsResp

func ParseGetBudgetRuleByRuleIdForSDCampaignsResp(rsp *http.Response) (*GetBudgetRuleByRuleIdForSDCampaignsResp, error)

ParseGetBudgetRuleByRuleIdForSDCampaignsResp parses an HTTP response from a GetBudgetRuleByRuleIdForSDCampaignsWithResponse call

func (GetBudgetRuleByRuleIdForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (GetBudgetRuleByRuleIdForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetCampaignsAssociatedWithSDBudgetRuleParams

type GetCampaignsAssociatedWithSDBudgetRuleParams struct {
	// NextToken To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`

	// PageSize Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.
	PageSize float32 `form:"pageSize" json:"pageSize"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

GetCampaignsAssociatedWithSDBudgetRuleParams defines parameters for GetCampaignsAssociatedWithSDBudgetRule.

type GetCampaignsAssociatedWithSDBudgetRuleResp

type GetCampaignsAssociatedWithSDBudgetRuleResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDGetAssociatedCampaignsResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseGetCampaignsAssociatedWithSDBudgetRuleResp

func ParseGetCampaignsAssociatedWithSDBudgetRuleResp(rsp *http.Response) (*GetCampaignsAssociatedWithSDBudgetRuleResp, error)

ParseGetCampaignsAssociatedWithSDBudgetRuleResp parses an HTTP response from a GetCampaignsAssociatedWithSDBudgetRuleWithResponse call

func (GetCampaignsAssociatedWithSDBudgetRuleResp) Status

Status returns HTTPResponse.Status

func (GetCampaignsAssociatedWithSDBudgetRuleResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody

type GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody = SDHeadlineRecommendationRequest

GetHeadlineRecommendationsForSDApplicationVndSdheadlinerecommendationrequestV40PlusJSONRequestBody defines body for GetHeadlineRecommendationsForSD for application/vnd.sdheadlinerecommendationrequest.v4.0+json ContentType.

type GetHeadlineRecommendationsForSDParams

type GetHeadlineRecommendationsForSDParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" 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 and choose profile id `profileId` from the response to pass it as input.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetHeadlineRecommendationsForSDParams defines parameters for GetHeadlineRecommendationsForSD.

type GetHeadlineRecommendationsForSDResp

type GetHeadlineRecommendationsForSDResp struct {
	Body                                                                        []byte
	HTTPResponse                                                                *http.Response
	ApplicationvndSdheadlinerecommendationresponseV40JSON200                    *SDHeadlineRecommendationResponse
	ApplicationvndSdheadlinerecommendationschemavalidationexceptionV40JSON400   *SDHeadlineRecommendationSchemaValidationException
	ApplicationvndSdheadlinerecommendationaccessdeniedexceptionV40JSON403       *SDHeadlineRecommendationAccessDeniedException
	ApplicationvndSdheadlinerecommendationidentifiernotfoundexceptionV40JSON404 *SDHeadlineRecommendationIdentifierNotfoundException
	ApplicationvndSdheadlinerecommendationthrottlingexceptionV40JSON429         *SDHeadlineRecommendationMarsThrottlingException
	ApplicationvndSdheadlinerecommendationinternalserverexceptionV40JSON500     *SDHeadlineRecommendationInternalServerException
}

func ParseGetHeadlineRecommendationsForSDResp

func ParseGetHeadlineRecommendationsForSDResp(rsp *http.Response) (*GetHeadlineRecommendationsForSDResp, error)

ParseGetHeadlineRecommendationsForSDResp parses an HTTP response from a GetHeadlineRecommendationsForSDWithResponse call

func (GetHeadlineRecommendationsForSDResp) Status

Status returns HTTPResponse.Status

func (GetHeadlineRecommendationsForSDResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetRequestResultsParams

type GetRequestResultsParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of results. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.
	StartIndex *int `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of results in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 results set startIndex=0 and count=1000. To return the next 1000 results, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).
	Count *int `form:"count,omitempty" json:"count,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetRequestResultsParams defines parameters for GetRequestResults.

type GetRequestResultsResp

type GetRequestResultsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDBrandSafetyRequestResultsResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseGetRequestResultsResp

func ParseGetRequestResultsResp(rsp *http.Response) (*GetRequestResultsResp, error)

ParseGetRequestResultsResp parses an HTTP response from a GetRequestResultsWithResponse call

func (GetRequestResultsResp) Status

func (r GetRequestResultsResp) Status() string

Status returns HTTPResponse.Status

func (GetRequestResultsResp) StatusCode

func (r GetRequestResultsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRequestStatusParams

type GetRequestStatusParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetRequestStatusParams defines parameters for GetRequestStatus.

type GetRequestStatusResp

type GetRequestStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDBrandSafetyRequestStatusResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseGetRequestStatusResp

func ParseGetRequestStatusResp(rsp *http.Response) (*GetRequestStatusResp, error)

ParseGetRequestStatusResp parses an HTTP response from a GetRequestStatusWithResponse call

func (GetRequestStatusResp) Status

func (r GetRequestStatusResp) Status() string

Status returns HTTPResponse.Status

func (GetRequestStatusResp) StatusCode

func (r GetRequestStatusResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRuleBasedBudgetHistoryForSDCampaignsParams

type GetRuleBasedBudgetHistoryForSDCampaignsParams struct {
	// NextToken To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`

	// PageSize Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.
	PageSize float32 `form:"pageSize" json:"pageSize"`

	// StartDate The start date of the budget history in YYYYMMDD format.
	StartDate string `form:"startDate" json:"startDate"`

	// EndDate The end date of the budget history in YYYYMMDD format.
	EndDate string `form:"endDate" json:"endDate"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a Login with Amazon account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

GetRuleBasedBudgetHistoryForSDCampaignsParams defines parameters for GetRuleBasedBudgetHistoryForSDCampaigns.

type GetRuleBasedBudgetHistoryForSDCampaignsResp

type GetRuleBasedBudgetHistoryForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDBudgetHistory
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseGetRuleBasedBudgetHistoryForSDCampaignsResp

func ParseGetRuleBasedBudgetHistoryForSDCampaignsResp(rsp *http.Response) (*GetRuleBasedBudgetHistoryForSDCampaignsResp, error)

ParseGetRuleBasedBudgetHistoryForSDCampaignsResp parses an HTTP response from a GetRuleBasedBudgetHistoryForSDCampaignsWithResponse call

func (GetRuleBasedBudgetHistoryForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (GetRuleBasedBudgetHistoryForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody

type GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody = SDBudgetRecommendationsRequest

GetSDBudgetRecommendationsApplicationVndSdbudgetrecommendationsV3PlusJSONRequestBody defines body for GetSDBudgetRecommendations for application/vnd.sdbudgetrecommendations.v3+json ContentType.

type GetSDBudgetRecommendationsParams

type GetSDBudgetRecommendationsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDClientHeader `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 SDProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetSDBudgetRecommendationsParams defines parameters for GetSDBudgetRecommendations.

type GetSDBudgetRecommendationsResp

type GetSDBudgetRecommendationsResp struct {
	Body                                           []byte
	HTTPResponse                                   *http.Response
	ApplicationvndSdbudgetrecommendationsV3JSON207 *SDBudgetRecommendationsResponse
	JSON400                                        *SDErrorResponse
	JSON401                                        *SDErrorResponse
	JSON403                                        *SDErrorResponse
	JSON415                                        *SDErrorResponse
	JSON429                                        *SDErrorResponse
	JSON500                                        *SDErrorResponse
}

func ParseGetSDBudgetRecommendationsResp

func ParseGetSDBudgetRecommendationsResp(rsp *http.Response) (*GetSDBudgetRecommendationsResp, error)

ParseGetSDBudgetRecommendationsResp parses an HTTP response from a GetSDBudgetRecommendationsWithResponse call

func (GetSDBudgetRecommendationsResp) Status

Status returns HTTPResponse.Status

func (GetSDBudgetRecommendationsResp) StatusCode

func (r GetSDBudgetRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSDBudgetRuleResponse

type GetSDBudgetRuleResponse struct {
	BudgetRule *SDBudgetRule `json:"budgetRule,omitempty"`
}

GetSDBudgetRuleResponse defines model for GetSDBudgetRuleResponse.

type GetSDBudgetRulesForAdvertiserParams

type GetSDBudgetRulesForAdvertiserParams struct {
	// NextToken To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`

	// PageSize Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.
	PageSize float32 `form:"pageSize" json:"pageSize"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

GetSDBudgetRulesForAdvertiserParams defines parameters for GetSDBudgetRulesForAdvertiser.

type GetSDBudgetRulesForAdvertiserResp

type GetSDBudgetRulesForAdvertiserResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSDBudgetRulesForAdvertiserResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseGetSDBudgetRulesForAdvertiserResp

func ParseGetSDBudgetRulesForAdvertiserResp(rsp *http.Response) (*GetSDBudgetRulesForAdvertiserResp, error)

ParseGetSDBudgetRulesForAdvertiserResp parses an HTTP response from a GetSDBudgetRulesForAdvertiserWithResponse call

func (GetSDBudgetRulesForAdvertiserResp) Status

Status returns HTTPResponse.Status

func (GetSDBudgetRulesForAdvertiserResp) StatusCode

func (r GetSDBudgetRulesForAdvertiserResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSDBudgetRulesForAdvertiserResponse

type GetSDBudgetRulesForAdvertiserResponse struct {
	// BudgetRulesForAdvertiserResponse A list of rules created by the advertiser.
	BudgetRulesForAdvertiserResponse *[]SDBudgetRule `json:"budgetRulesForAdvertiserResponse,omitempty"`

	// NextToken To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.
	NextToken *string `json:"nextToken,omitempty"`
}

GetSDBudgetRulesForAdvertiserResponse defines model for GetSDBudgetRulesForAdvertiserResponse.

type GetSnapshotByIdParams

type GetSnapshotByIdParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `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 string `json:"Amazon-Advertising-API-Scope"`
}

GetSnapshotByIdParams defines parameters for GetSnapshotById.

type GetSnapshotByIdResp

type GetSnapshotByIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SnapshotResponse
	JSON400      *SdDefaultError
	JSON401      *SdDefaultError
	JSON403      *SdDefaultError
	JSON429      *SdDefaultError
	JSON500      *SdDefaultError
}

func ParseGetSnapshotByIdResp

func ParseGetSnapshotByIdResp(rsp *http.Response) (*GetSnapshotByIdResp, error)

ParseGetSnapshotByIdResp parses an HTTP response from a GetSnapshotByIdWithResponse call

func (GetSnapshotByIdResp) Status

func (r GetSnapshotByIdResp) Status() string

Status returns HTTPResponse.Status

func (GetSnapshotByIdResp) StatusCode

func (r GetSnapshotByIdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody = SDTargetingBidRecommendationsRequestV31

GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody defines body for GetTargetBidRecommendations for application/vnd.sdtargetingrecommendations.v3.1+json ContentType.

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody = SDTargetingBidRecommendationsRequestV32

GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody defines body for GetTargetBidRecommendations for application/vnd.sdtargetingrecommendations.v3.2+json ContentType.

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody

type GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody = SDTargetingBidRecommendationsRequestV33

GetTargetBidRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody defines body for GetTargetBidRecommendations for application/vnd.sdtargetingrecommendations.v3.3+json ContentType.

type GetTargetBidRecommendationsParams

type GetTargetBidRecommendationsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDClientHeader `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 SDProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetTargetBidRecommendationsParams defines parameters for GetTargetBidRecommendations.

type GetTargetBidRecommendationsResp

type GetTargetBidRecommendationsResp struct {
	Body                                               []byte
	HTTPResponse                                       *http.Response
	ApplicationvndSdtargetingrecommendationsV31JSON207 *SDTargetingBidRecommendationsResponseV31
	ApplicationvndSdtargetingrecommendationsV32JSON207 *SDTargetingBidRecommendationsResponseV32
	ApplicationvndSdtargetingrecommendationsV33JSON207 *SDTargetingBidRecommendationsResponseV32
	JSON400                                            *SDErrorResponse
	JSON401                                            *SDErrorResponse
	JSON403                                            *SDErrorResponse
	JSON415                                            *SDErrorResponse
	JSON429                                            *SDErrorResponse
	JSON500                                            *SDErrorResponse
}

func ParseGetTargetBidRecommendationsResp

func ParseGetTargetBidRecommendationsResp(rsp *http.Response) (*GetTargetBidRecommendationsResp, error)

ParseGetTargetBidRecommendationsResp parses an HTTP response from a GetTargetBidRecommendationsWithResponse call

func (GetTargetBidRecommendationsResp) Status

Status returns HTTPResponse.Status

func (GetTargetBidRecommendationsResp) StatusCode

func (r GetTargetBidRecommendationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody = SDTargetingRecommendationsRequest

GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV30PlusJSONRequestBody defines body for GetTargetRecommendations for application/vnd.sdtargetingrecommendations.v3.0+json ContentType.

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody = SDTargetingRecommendationsRequestV31

GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV31PlusJSONRequestBody defines body for GetTargetRecommendations for application/vnd.sdtargetingrecommendations.v3.1+json ContentType.

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody = SDTargetingRecommendationsRequestV32

GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV32PlusJSONRequestBody defines body for GetTargetRecommendations for application/vnd.sdtargetingrecommendations.v3.2+json ContentType.

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody = SDTargetingRecommendationsRequestV33

GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV33PlusJSONRequestBody defines body for GetTargetRecommendations for application/vnd.sdtargetingrecommendations.v3.3+json ContentType.

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody

type GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody = SDTargetingRecommendationsRequestV34

GetTargetRecommendationsApplicationVndSdtargetingrecommendationsV34PlusJSONRequestBody defines body for GetTargetRecommendations for application/vnd.sdtargetingrecommendations.v3.4+json ContentType.

type GetTargetRecommendationsParams

type GetTargetRecommendationsParams struct {
	// Locale The requested locale from query parameter
	Locale *SDRequestedLocale `form:"locale,omitempty" json:"locale,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDClientHeader `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 SDProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetTargetRecommendationsParams defines parameters for GetTargetRecommendations.

type GetTargetRecommendationsResp

type GetTargetRecommendationsResp struct {
	Body                                               []byte
	HTTPResponse                                       *http.Response
	ApplicationvndSdtargetingrecommendationsV30JSON200 *SDTargetingRecommendationsResponse
	ApplicationvndSdtargetingrecommendationsV31JSON200 *SDTargetingRecommendationsResponseV31
	ApplicationvndSdtargetingrecommendationsV32JSON200 *SDTargetingRecommendationsResponseV32
	ApplicationvndSdtargetingrecommendationsV33JSON200 *SDTargetingRecommendationsResponseV33
	ApplicationvndSdtargetingrecommendationsV34JSON200 *SDTargetingRecommendationsResponseV34
	JSON400                                            *SDErrorResponse
	JSON401                                            *SDErrorResponse
	JSON403                                            *SDErrorResponse
	JSON415                                            *SDErrorResponse
	JSON429                                            *SDErrorResponse
	JSON500                                            *SDErrorResponse
}

func ParseGetTargetRecommendationsResp

func ParseGetTargetRecommendationsResp(rsp *http.Response) (*GetTargetRecommendationsResp, error)

ParseGetTargetRecommendationsResp parses an HTTP response from a GetTargetRecommendationsWithResponse call

func (GetTargetRecommendationsResp) Status

Status returns HTTPResponse.Status

func (GetTargetRecommendationsResp) StatusCode

func (r GetTargetRecommendationsResp) 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 ListAssociatedBudgetRulesForSDCampaignsParams

type ListAssociatedBudgetRulesForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

ListAssociatedBudgetRulesForSDCampaignsParams defines parameters for ListAssociatedBudgetRulesForSDCampaigns.

type ListAssociatedBudgetRulesForSDCampaignsResp

type ListAssociatedBudgetRulesForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDListAssociatedBudgetRulesResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseListAssociatedBudgetRulesForSDCampaignsResp

func ParseListAssociatedBudgetRulesForSDCampaignsResp(rsp *http.Response) (*ListAssociatedBudgetRulesForSDCampaignsResp, error)

ParseListAssociatedBudgetRulesForSDCampaignsResp parses an HTTP response from a ListAssociatedBudgetRulesForSDCampaignsWithResponse call

func (ListAssociatedBudgetRulesForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (ListAssociatedBudgetRulesForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ListDomainsParams

type ListDomainsParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of domains. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.
	StartIndex *int `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of domain objects in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 domains set startIndex=0 and count=1000. To return the next 1000 domains, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).
	Count *int `form:"count,omitempty" json:"count,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListDomainsParams defines parameters for ListDomains.

type ListDomainsResp

type ListDomainsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDBrandSafetyGetResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseListDomainsResp

func ParseListDomainsResp(rsp *http.Response) (*ListDomainsResp, error)

ParseListDomainsResp parses an HTTP response from a ListDomainsWithResponse call

func (ListDomainsResp) Status

func (r ListDomainsResp) Status() string

Status returns HTTPResponse.Status

func (ListDomainsResp) StatusCode

func (r ListDomainsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRequestStatusParams

type ListRequestStatusParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId SDBrandSafetyClientHeader `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 SDBrandSafetyProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListRequestStatusParams defines parameters for ListRequestStatus.

type ListRequestStatusResp

type ListRequestStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SDBrandSafetyListRequestStatusResponse
	JSON400      *SDAPIError
	JSON401      *SDAPIError
	JSON403      *SDAPIError
	JSON422      *SDAPIError
	JSON429      *SDAPIError
	JSON500      *SDAPIError
}

func ParseListRequestStatusResp

func ParseListRequestStatusResp(rsp *http.Response) (*ListRequestStatusResp, error)

ParseListRequestStatusResp parses an HTTP response from a ListRequestStatusWithResponse call

func (ListRequestStatusResp) Status

func (r ListRequestStatusResp) Status() string

Status returns HTTPResponse.Status

func (ListRequestStatusResp) StatusCode

func (r ListRequestStatusResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PerformanceMeasureCondition

type PerformanceMeasureCondition struct {
	// ComparisonOperator The comparison operator.
	ComparisonOperator ComparisonOperator `json:"comparisonOperator"`

	// MetricName The advertising performance metric.
	MetricName PerformanceMetric `json:"metricName"`

	// Threshold The performance threshold value.
	Threshold float64 `json:"threshold"`
}

PerformanceMeasureCondition defines model for PerformanceMeasureCondition.

type PerformanceMetric

type PerformanceMetric string

PerformanceMetric The advertising performance metric.

const (
	ACOS PerformanceMetric = "ACOS"
	CTR  PerformanceMetric = "CTR"
	CVR  PerformanceMetric = "CVR"
	ROAS PerformanceMetric = "ROAS"
)

Defines values for PerformanceMetric.

type PerformanceMetricValue

type PerformanceMetricValue struct {
	// Name Name of the performance metric
	Name *string `json:"name,omitempty"`

	// Value Value of the performance metric
	Value *float64 `json:"value,omitempty"`
}

PerformanceMetricValue An object giving the name of the performance metric and its value when the rule was evaluated

type ProfileHeader

type ProfileHeader = string

ProfileHeader defines model for profileHeader.

type RecommendedHeadline

type RecommendedHeadline struct {
	// Headline String that contains Recommended headline.
	Headline *string `json:"headline,omitempty"`

	// HeadlineId Unique Id of Recommended headline.
	HeadlineId *string `json:"headlineId,omitempty"`
}

RecommendedHeadline Recommended Headline in response object. Recommended headline will be locale specific, i.e. for an asin input in ES, Recommended headline will be in ES.

type Recurrence

type Recurrence struct {
	// DaysOfWeek Object representing days of the week for weekly type rule. It is not required for daily recurrence type
	DaysOfWeek *[]DayOfWeek `json:"daysOfWeek,omitempty"`

	// Type depicts the type of recurrence
	Type *RecurrenceType `json:"type,omitempty"`
}

Recurrence defines model for Recurrence.

type RecurrenceType

type RecurrenceType string

RecurrenceType depicts the type of recurrence

const (
	DAILY  RecurrenceType = "DAILY"
	WEEKLY RecurrenceType = "WEEKLY"
)

Defines values for RecurrenceType.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn added in v0.0.2

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

ResponseEditorFn is the function signature for the ResponseEditor callback function

type RuleDuration

type RuleDuration struct {
	// DateRangeTypeRuleDuration Object representing date range type rule duration.
	DateRangeTypeRuleDuration *DateRangeTypeRuleDuration `json:"dateRangeTypeRuleDuration,omitempty"`

	// EventTypeRuleDuration Object representing event type rule duration.
	EventTypeRuleDuration *EventTypeRuleDuration `json:"eventTypeRuleDuration,omitempty"`
}

RuleDuration defines model for RuleDuration.

type SDAPIError

type SDAPIError struct {
	// Code The HTTP status code of the response.
	Code *string `json:"code,omitempty"`

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

SDAPIError The error response object.

type SDASIN

type SDASIN = string

SDASIN Amazon Standard Identification Number

type SDAudience

type SDAudience = string

SDAudience The audience identifier

type SDAudienceCategory

type SDAudienceCategory string

SDAudienceCategory An audience category determines the goal of the audience such as In-market, Interest and Lifestyle

const (
	InMarket  SDAudienceCategory = "In-market"
	Interest  SDAudienceCategory = "Interest"
	LifeEvent SDAudienceCategory = "Life event"
	Lifestyle SDAudienceCategory = "Lifestyle"
)

Defines values for SDAudienceCategory.

type SDAudienceCategoryRecommendations

type SDAudienceCategoryRecommendations struct {
	// Audiences List of recommended standard Amazon audience targets
	Audiences *[]SDAudienceRecommendation `json:"audiences,omitempty"`

	// Category An audience category determines the goal of the audience such as In-market, Interest and Lifestyle
	Category *SDAudienceCategory `json:"category,omitempty"`
}

SDAudienceCategoryRecommendations List of recommended standard Amazon audience targets of a specific audience category

type SDAudienceRecommendation

type SDAudienceRecommendation struct {
	// Audience The audience identifier
	Audience *SDAudience `json:"audience,omitempty"`

	// Name The Amazon audience name
	Name *string `json:"name,omitempty"`

	// Rank A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation
	Rank *int `json:"rank,omitempty"`
}

SDAudienceRecommendation A recommended standard Amazon audience to target ads on

type SDAudienceRecommendations

type SDAudienceRecommendations struct {
	// Audiences List of recommended audience targets, broken down by audience category
	Audiences *[]SDAudienceCategoryRecommendations `json:"audiences,omitempty"`
}

SDAudienceRecommendations defines model for SDAudienceRecommendations.

type SDBidOptimizationV32

type SDBidOptimizationV32 string

SDBidOptimizationV32 Determines what the recommended bids will be optimized for.

|Name|CostType|Supported Tactics|Description| |----|----------|-----------|-----------| |clicks|cpc|T00020 T00030|Optimize for page visits| |conversions|cpc|T00020 T00030|Optimize for conversion| |reach|vcpm|T00020 T00030|Optimize for viewable impressions|

const (
	Clicks      SDBidOptimizationV32 = "clicks"
	Conversions SDBidOptimizationV32 = "conversions"
	Reach       SDBidOptimizationV32 = "reach"
)

Defines values for SDBidOptimizationV32.

type SDBidRecommendationV31

type SDBidRecommendationV31 struct {
	// RangeLower The lowest recommended bid to use to win an ad placement for this target.
	RangeLower float32 `json:"rangeLower"`

	// RangeUpper The highest recommended bid to use to win an ad placement for this target.
	RangeUpper float32 `json:"rangeUpper"`

	// Recommended The recommended bid to use to win an ad placement for this target.
	Recommended float32 `json:"recommended"`
}

SDBidRecommendationV31 A recommended bid range to use for a target.

type SDBrandSafetyClientHeader

type SDBrandSafetyClientHeader = string

SDBrandSafetyClientHeader defines model for SDBrandSafetyClientHeader.

type SDBrandSafetyDenyListDomain

type SDBrandSafetyDenyListDomain struct {
	// Name The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)
	Name string `json:"name"`

	// Type The domain type.
	Type SDBrandSafetyDenyListDomainType `json:"type"`
}

SDBrandSafetyDenyListDomain defines model for SDBrandSafetyDenyListDomain.

type SDBrandSafetyDenyListDomainState

type SDBrandSafetyDenyListDomainState string

SDBrandSafetyDenyListDomainState The state of the domain.

const (
	ARCHIVED SDBrandSafetyDenyListDomainState = "ARCHIVED"
	ENABLED  SDBrandSafetyDenyListDomainState = "ENABLED"
)

Defines values for SDBrandSafetyDenyListDomainState.

type SDBrandSafetyDenyListDomainType

type SDBrandSafetyDenyListDomainType string

SDBrandSafetyDenyListDomainType The domain type.

const (
	APP     SDBrandSafetyDenyListDomainType = "APP"
	WEBSITE SDBrandSafetyDenyListDomainType = "WEBSITE"
)

Defines values for SDBrandSafetyDenyListDomainType.

type SDBrandSafetyDenyListDomainUpdateResultStatus

type SDBrandSafetyDenyListDomainUpdateResultStatus string

SDBrandSafetyDenyListDomainUpdateResultStatus The state of the domain.

const (
	SDBrandSafetyDenyListDomainUpdateResultStatusFAILURE SDBrandSafetyDenyListDomainUpdateResultStatus = "FAILURE"
	SDBrandSafetyDenyListDomainUpdateResultStatusSUCCESS SDBrandSafetyDenyListDomainUpdateResultStatus = "SUCCESS"
)

Defines values for SDBrandSafetyDenyListDomainUpdateResultStatus.

type SDBrandSafetyDenyListProcessedDomain

type SDBrandSafetyDenyListProcessedDomain struct {
	// CreatedAt The date time the domain was created at. Format: YYYY-MM-ddT:HH:mm:ssZ
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// DomainId The identifier of the Brand Safety List domain.
	DomainId *int64 `json:"domainId,omitempty"`

	// LastModified The date time the domain was last modified. Format: YYYY-MM-ddT:HH:mm:ssZ
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Name The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)
	Name *string `json:"name,omitempty"`

	// State The state of the domain.
	State *SDBrandSafetyDenyListDomainState `json:"state,omitempty"`

	// Type The domain type.
	Type *SDBrandSafetyDenyListDomainType `json:"type,omitempty"`
}

SDBrandSafetyDenyListProcessedDomain defines model for SDBrandSafetyDenyListProcessedDomain.

type SDBrandSafetyGetResponse

type SDBrandSafetyGetResponse struct {
	// Domains List of Brand Safety Deny List Domains
	Domains *[]SDBrandSafetyDenyListProcessedDomain `json:"domains,omitempty"`

	// Pagination Response pagination info for Brand Safety Deny List GET requests
	Pagination *SDBrandSafetyGetResponsePagination `json:"pagination,omitempty"`
}

SDBrandSafetyGetResponse Response for Brand Safety Deny List GET requests

type SDBrandSafetyGetResponsePagination

type SDBrandSafetyGetResponsePagination struct {
	// Limit The maximum number of deny list domains returned from GET request.
	Limit *int `json:"limit,omitempty"`

	// Offset The number of deny list domains skipped.
	Offset *int `json:"offset,omitempty"`

	// Total The total number of deny list domains created by the advertiser.
	Total *int `json:"total,omitempty"`
}

SDBrandSafetyGetResponsePagination Response pagination info for Brand Safety Deny List GET requests

type SDBrandSafetyListRequestStatusResponse

type SDBrandSafetyListRequestStatusResponse struct {
	// RequestStatusList List of all requests' status.
	RequestStatusList *[]SDBrandSafetyRequestStatus `json:"requestStatusList,omitempty"`
}

SDBrandSafetyListRequestStatusResponse List of all requests' status.

type SDBrandSafetyPostRequest

type SDBrandSafetyPostRequest struct {
	Domains []SDBrandSafetyDenyListDomain `json:"domains"`
}

SDBrandSafetyPostRequest POST Request for Brand Safety

type SDBrandSafetyProfileHeader

type SDBrandSafetyProfileHeader = string

SDBrandSafetyProfileHeader defines model for SDBrandSafetyProfileHeader.

type SDBrandSafetyRequestResult

type SDBrandSafetyRequestResult struct {
	// Details A human-readable description of the response.
	Details *string `json:"details,omitempty"`

	// DomainId The identifier of the Brand Safety Deny List Domain.
	DomainId *int64 `json:"domainId,omitempty"`

	// Name The website or app identifier.
	Name *string `json:"name,omitempty"`

	// Status The state of the domain.
	Status *SDBrandSafetyDenyListDomainUpdateResultStatus `json:"status,omitempty"`
}

SDBrandSafetyRequestResult defines model for SDBrandSafetyRequestResult.

type SDBrandSafetyRequestResultsResponse

type SDBrandSafetyRequestResultsResponse struct {
	// Results A list of results for the given requestId
	Results *[]SDBrandSafetyRequestResult `json:"results,omitempty"`
}

SDBrandSafetyRequestResultsResponse defines model for SDBrandSafetyRequestResultsResponse.

type SDBrandSafetyRequestStatus

type SDBrandSafetyRequestStatus struct {
	// RequestId Request ID
	RequestId *string `json:"requestId,omitempty"`

	// Status The status of the request
	Status *SDBrandSafetyRequestStatusStatus `json:"status,omitempty"`

	// StatusDetails Details related to the request status
	StatusDetails *string `json:"statusDetails,omitempty"`

	// Timestamp Request timestamp
	Timestamp *string `json:"timestamp,omitempty"`
}

SDBrandSafetyRequestStatus defines model for SDBrandSafetyRequestStatus.

type SDBrandSafetyRequestStatusResponse

type SDBrandSafetyRequestStatusResponse struct {
	RequestStatus *SDBrandSafetyRequestStatus `json:"requestStatus,omitempty"`
}

SDBrandSafetyRequestStatusResponse The status of the request.

type SDBrandSafetyRequestStatusStatus

type SDBrandSafetyRequestStatusStatus string

SDBrandSafetyRequestStatusStatus The status of the request

const (
	SDBrandSafetyRequestStatusStatusCOMPLETED  SDBrandSafetyRequestStatusStatus = "COMPLETED"
	SDBrandSafetyRequestStatusStatusFAILURE    SDBrandSafetyRequestStatusStatus = "FAILURE"
	SDBrandSafetyRequestStatusStatusINPROGRESS SDBrandSafetyRequestStatusStatus = "IN_PROGRESS"
)

Defines values for SDBrandSafetyRequestStatusStatus.

type SDBrandSafetyUpdateResponse

type SDBrandSafetyUpdateResponse struct {
	// RequestId The identifier of the request
	RequestId *string `json:"requestId,omitempty"`
}

SDBrandSafetyUpdateResponse Response for Brand Safety POST and DELETE requests

type SDBudgetHistory

type SDBudgetHistory struct {
	History *[]SDRuleBasedBudget `json:"history,omitempty"`
}

SDBudgetHistory defines model for SDBudgetHistory.

type SDBudgetRecommendation

type SDBudgetRecommendation struct {
	// CampaignId Campaign id.
	CampaignId string `json:"campaignId"`

	// Index Correlate the recommendation to the campaign index in the request. Zero-based.
	Index                        int                            `json:"index"`
	SevenDaysMissedOpportunities SDSevenDaysMissedOpportunities `json:"sevenDaysMissedOpportunities"`

	// SuggestedBudget Recommended budget for the campaign. This will be in local currency.
	SuggestedBudget float32 `json:"suggestedBudget"`
}

SDBudgetRecommendation defines model for SDBudgetRecommendation.

type SDBudgetRecommendationError

type SDBudgetRecommendationError struct {
	// CampaignId Campaign id.
	CampaignId string `json:"campaignId"`

	// Code The HTTP status code of the response.
	Code string `json:"code"`

	// Details A human-readable description of the response.
	Details string `json:"details"`

	// Index Correlate the recommendation to the campaign index in the request. Zero-based.
	Index int `json:"index"`
}

SDBudgetRecommendationError defines model for SDBudgetRecommendationError.

type SDBudgetRecommendationsRequest

type SDBudgetRecommendationsRequest struct {
	// CampaignIds A list of campaign ids for which to get budget recommendations and missed opportunities.
	CampaignIds []string `json:"campaignIds"`
}

SDBudgetRecommendationsRequest Request for budget recommendations.

type SDBudgetRecommendationsResponse

type SDBudgetRecommendationsResponse struct {
	// BudgetRecommendationsErrorResults List of errors that occurred when generating budget recommendation.
	BudgetRecommendationsErrorResults []SDBudgetRecommendationError `json:"budgetRecommendationsErrorResults"`

	// BudgetRecommendationsSuccessResults List of successful budget recommendation for campaigns.
	BudgetRecommendationsSuccessResults []SDBudgetRecommendation `json:"budgetRecommendationsSuccessResults"`
}

SDBudgetRecommendationsResponse defines model for SDBudgetRecommendationsResponse.

type SDBudgetRule

type SDBudgetRule struct {
	// CreatedDate Epoch time of budget rule creation. Read-only.
	CreatedDate *int64 `json:"createdDate,omitempty"`

	// LastUpdatedDate Epoch time of budget rule update. Read-only.
	LastUpdatedDate *int64 `json:"lastUpdatedDate,omitempty"`

	// RuleDetails Object representing details of a budget rule for SD campaign
	RuleDetails *SDBudgetRuleDetails `json:"ruleDetails,omitempty"`

	// RuleId The budget rule identifier.
	RuleId string `json:"ruleId"`

	// RuleState The budget rule state.
	RuleState *State `json:"ruleState,omitempty"`

	// RuleStatus The budget rule status. Read-only.
	RuleStatus *string `json:"ruleStatus,omitempty"`
}

SDBudgetRule defines model for SDBudgetRule.

type SDBudgetRuleDetails

type SDBudgetRuleDetails struct {
	BudgetIncreaseBy *BudgetIncreaseBy `json:"budgetIncreaseBy,omitempty"`
	Duration         *RuleDuration     `json:"duration,omitempty"`

	// Name The budget rule name. Required to be unique within a campaign.
	Name                        *string                      `json:"name,omitempty"`
	PerformanceMeasureCondition *PerformanceMeasureCondition `json:"performanceMeasureCondition,omitempty"`
	Recurrence                  *Recurrence                  `json:"recurrence,omitempty"`

	// RuleType The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.
	RuleType *SDRuleType `json:"ruleType,omitempty"`
}

SDBudgetRuleDetails Object representing details of a budget rule for SD campaign

type SDCategory

type SDCategory = int64

SDCategory The category identifier

type SDCategoryRecommendation

type SDCategoryRecommendation struct {
	// Category The category identifier
	Category *SDCategory `json:"category,omitempty"`

	// Name The category name
	Name *string `json:"name,omitempty"`

	// Path The path of the category within the category catalogue
	Path *[]string `json:"path,omitempty"`

	// Rank A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation
	Rank *int `json:"rank,omitempty"`

	// TargetableAsinCountRange The range of ASINs available within the category catalogue
	TargetableAsinCountRange *struct {
		RangeLower *int `json:"rangeLower,omitempty"`
		RangeUpper *int `json:"rangeUpper,omitempty"`
	} `json:"targetableAsinCountRange,omitempty"`
}

SDCategoryRecommendation A recommended category to target ads on

type SDCategoryRecommendationV33

type SDCategoryRecommendationV33 struct {
	// Category The category identifier
	Category *SDCategory `json:"category,omitempty"`

	// Name The category name
	Name *string `json:"name,omitempty"`

	// Path The path of the category within the category catalogue
	Path *[]string `json:"path,omitempty"`

	// Rank A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation
	Rank *int `json:"rank,omitempty"`

	// TargetableAsinCountRange The range of ASINs available within the category catalogue
	TargetableAsinCountRange *struct {
		RangeLower *int `json:"rangeLower,omitempty"`
		RangeUpper *int `json:"rangeUpper,omitempty"`
	} `json:"targetableAsinCountRange,omitempty"`

	// TranslatedName The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down
	TranslatedName *string `json:"translatedName,omitempty"`

	// TranslatedPath The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down
	TranslatedPath *[]string `json:"translatedPath,omitempty"`
}

SDCategoryRecommendationV33 A recommended category to target ads on

type SDCategoryRecommendations

type SDCategoryRecommendations struct {
	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendation `json:"categories,omitempty"`
}

SDCategoryRecommendations defines model for SDCategoryRecommendations.

type SDCategoryRecommendationsV33

type SDCategoryRecommendationsV33 struct {
	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendationV33 `json:"categories,omitempty"`
}

SDCategoryRecommendationsV33 defines model for SDCategoryRecommendationsV33.

type SDClientHeader

type SDClientHeader = string

SDClientHeader defines model for SDClientHeader.

type SDCostTypeV31

type SDCostTypeV31 string

SDCostTypeV31 Determines what performance metric the bid recommendations will be optimized for. |Name|Supported Tactics|Description| |----|----------|-----------| |CPC|T00020 T00030|The bid recommendations will be optimized for clicks triggered by the ad.| |VCPM|T00020 T00030|The bid recommendations will be optimized for viewed impressions triggered by the ad.|

const (
	Cpc  SDCostTypeV31 = "cpc"
	Vcpm SDCostTypeV31 = "vcpm"
)

Defines values for SDCostTypeV31.

type SDCreativeType

type SDCreativeType string

SDCreativeType The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.

const (
	IMAGE SDCreativeType = "IMAGE"
	VIDEO SDCreativeType = "VIDEO"
)

Defines values for SDCreativeType.

type SDErrorResponse

type SDErrorResponse struct {
	// Code The HTTP status code of the response
	Code *string `json:"code,omitempty"`

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

SDErrorResponse defines model for SDErrorResponse.

type SDGetAssociatedCampaignsResponse

type SDGetAssociatedCampaignsResponse struct {
	// AssociatedCampaigns A list of campaigns that are associated to this budget rule.
	AssociatedCampaigns *[]AssociatedCampaign `json:"associatedCampaigns,omitempty"`

	// NextToken To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.
	NextToken *string `json:"nextToken,omitempty"`
}

SDGetAssociatedCampaignsResponse defines model for SDGetAssociatedCampaignsResponse.

type SDGoalProduct

type SDGoalProduct struct {
	// Asin Amazon Standard Identification Number
	Asin SDASIN `json:"asin"`
}

SDGoalProduct A product an advertisers wants to advertise. Recommendations will be made for specified goal products.

type SDHeadlineRecommendationAccessDeniedException

type SDHeadlineRecommendationAccessDeniedException struct {
	// Code AccessDeniedErrorCode.
	Code *SDHeadlineRecommendationAccessDeniedExceptionCode `json:"code,omitempty"`

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

SDHeadlineRecommendationAccessDeniedException defines model for SDHeadlineRecommendationAccessDeniedException.

type SDHeadlineRecommendationAccessDeniedExceptionCode

type SDHeadlineRecommendationAccessDeniedExceptionCode string

SDHeadlineRecommendationAccessDeniedExceptionCode AccessDeniedErrorCode.

const (
	ACCESSDENIED SDHeadlineRecommendationAccessDeniedExceptionCode = "ACCESS_DENIED"
)

Defines values for SDHeadlineRecommendationAccessDeniedExceptionCode.

type SDHeadlineRecommendationIdentifierNotfoundException

type SDHeadlineRecommendationIdentifierNotfoundException struct {
	// Code IdentiferNotFoundErrorCode.
	Code *SDHeadlineRecommendationIdentifierNotfoundExceptionCode `json:"code,omitempty"`

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

SDHeadlineRecommendationIdentifierNotfoundException defines model for SDHeadlineRecommendationIdentifierNotfoundException.

type SDHeadlineRecommendationIdentifierNotfoundExceptionCode

type SDHeadlineRecommendationIdentifierNotfoundExceptionCode string

SDHeadlineRecommendationIdentifierNotfoundExceptionCode IdentiferNotFoundErrorCode.

const (
	IDENTIFIERNOTFOUND SDHeadlineRecommendationIdentifierNotfoundExceptionCode = "IDENTIFIER_NOT_FOUND"
)

Defines values for SDHeadlineRecommendationIdentifierNotfoundExceptionCode.

type SDHeadlineRecommendationInternalServerException

type SDHeadlineRecommendationInternalServerException struct {
	// Code InternalErrorCode.
	Code *SDHeadlineRecommendationInternalServerExceptionCode `json:"code,omitempty"`

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

SDHeadlineRecommendationInternalServerException defines model for SDHeadlineRecommendationInternalServerException.

type SDHeadlineRecommendationInternalServerExceptionCode

type SDHeadlineRecommendationInternalServerExceptionCode string

SDHeadlineRecommendationInternalServerExceptionCode InternalErrorCode.

const (
	INTERNALERROR SDHeadlineRecommendationInternalServerExceptionCode = "INTERNAL_ERROR"
)

Defines values for SDHeadlineRecommendationInternalServerExceptionCode.

type SDHeadlineRecommendationMarsThrottlingException

type SDHeadlineRecommendationMarsThrottlingException struct {
	// Code ThrottledErrorCode.
	Code *SDHeadlineRecommendationMarsThrottlingExceptionCode `json:"code,omitempty"`

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

SDHeadlineRecommendationMarsThrottlingException defines model for SDHeadlineRecommendationMarsThrottlingException.

type SDHeadlineRecommendationMarsThrottlingExceptionCode

type SDHeadlineRecommendationMarsThrottlingExceptionCode string

SDHeadlineRecommendationMarsThrottlingExceptionCode ThrottledErrorCode.

const (
	THROTTLED SDHeadlineRecommendationMarsThrottlingExceptionCode = "THROTTLED"
)

Defines values for SDHeadlineRecommendationMarsThrottlingExceptionCode.

type SDHeadlineRecommendationRequest

type SDHeadlineRecommendationRequest struct {
	AdFormat *SDHeadlineRecommendationRequestAdFormat `json:"adFormat,omitempty"`

	// Asins An array of ASINs associated with the creative.
	Asins *[]string `json:"asins,omitempty"`

	// MaxNumRecommendations Maximum number of recommendations that API should return. Response will [0, maxNumRecommendations] recommendations (recommendations are not guaranteed as there can be instances where the ML model can not generate policy compliant headlines for the given set of asins).
	MaxNumRecommendations *float32 `json:"maxNumRecommendations,omitempty"`
}

SDHeadlineRecommendationRequest Request structure of SD headline recommendation API.

type SDHeadlineRecommendationRequestAdFormat

type SDHeadlineRecommendationRequestAdFormat string

SDHeadlineRecommendationRequestAdFormat defines model for SDHeadlineRecommendationRequest.AdFormat.

const (
	SPONSOREDDISPLAY SDHeadlineRecommendationRequestAdFormat = "SPONSORED_DISPLAY"
)

Defines values for SDHeadlineRecommendationRequestAdFormat.

type SDHeadlineRecommendationResponse

type SDHeadlineRecommendationResponse struct {
	// Recommendations Recommendations are sorted, i.e., more suitable headline has lesser array index value.
	Recommendations *[]RecommendedHeadline `json:"recommendations,omitempty"`

	// RequestId An identifier for request made which is generated by server.
	RequestId *string `json:"requestId,omitempty"`
}

SDHeadlineRecommendationResponse Response structure of SD headline recommendation API.

type SDHeadlineRecommendationSchemaValidationException

type SDHeadlineRecommendationSchemaValidationException struct {
	// Code InvalidArgumentErrorCode.
	Code *SDHeadlineRecommendationSchemaValidationExceptionCode `json:"code,omitempty"`

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

SDHeadlineRecommendationSchemaValidationException defines model for SDHeadlineRecommendationSchemaValidationException.

type SDHeadlineRecommendationSchemaValidationExceptionCode

type SDHeadlineRecommendationSchemaValidationExceptionCode string

SDHeadlineRecommendationSchemaValidationExceptionCode InvalidArgumentErrorCode.

const (
	INVALIDARGUMENT SDHeadlineRecommendationSchemaValidationExceptionCode = "INVALID_ARGUMENT"
)

Defines values for SDHeadlineRecommendationSchemaValidationExceptionCode.

type SDListAssociatedBudgetRulesResponse

type SDListAssociatedBudgetRulesResponse struct {
	// AssociatedRules A list of associated budget rules.
	AssociatedRules *[]SDBudgetRule `json:"associatedRules,omitempty"`
}

SDListAssociatedBudgetRulesResponse defines model for SDListAssociatedBudgetRulesResponse.

type SDLocale

type SDLocale string

SDLocale List of supported locales

const (
	ArAE SDLocale = "ar_AE"
	DeDE SDLocale = "de_DE"
	EnAE SDLocale = "en_AE"
	EnAU SDLocale = "en_AU"
	EnCA SDLocale = "en_CA"
	EnGB SDLocale = "en_GB"
	EnIN SDLocale = "en_IN"
	EnSG SDLocale = "en_SG"
	EnUS SDLocale = "en_US"
	EsES SDLocale = "es_ES"
	EsMX SDLocale = "es_MX"
	FrCA SDLocale = "fr_CA"
	FrFR SDLocale = "fr_FR"
	HiIN SDLocale = "hi_IN"
	ItIT SDLocale = "it_IT"
	JaJP SDLocale = "ja_JP"
	KoKR SDLocale = "ko_KR"
	NlNL SDLocale = "nl_NL"
	PlPL SDLocale = "pl_PL"
	PtBR SDLocale = "pt_BR"
	SvSE SDLocale = "sv_SE"
	TaIN SDLocale = "ta_IN"
	ThTH SDLocale = "th_TH"
	TrTR SDLocale = "tr_TR"
	ViVN SDLocale = "vi_VN"
	ZhCN SDLocale = "zh_CN"
)

Defines values for SDLocale.

type SDProductRecommendation

type SDProductRecommendation struct {
	// Asin Amazon Standard Identification Number
	Asin *SDASIN `json:"asin,omitempty"`

	// Rank A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation
	Rank *int `json:"rank,omitempty"`
}

SDProductRecommendation A recommended product to target ads on

type SDProductRecommendationV32

type SDProductRecommendationV32 struct {
	// AdvertisedAsins The top advertised products this recommendation is made for.
	AdvertisedAsins *[]SDASIN `json:"advertisedAsins,omitempty"`

	// Asin Amazon Standard Identification Number
	Asin *SDASIN `json:"asin,omitempty"`

	// Rank A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation
	Rank *int `json:"rank,omitempty"`
}

SDProductRecommendationV32 A recommended product to target ads on

type SDProductRecommendationsV31

type SDProductRecommendationsV31 struct {
	// Products List of recommended product targets
	Products *[]SDProductRecommendation `json:"products,omitempty"`
}

SDProductRecommendationsV31 defines model for SDProductRecommendationsV31.

type SDProductRecommendationsV32

type SDProductRecommendationsV32 struct {
	// Products List of recommended product targets
	Products *[]SDProductRecommendationV32 `json:"products,omitempty"`
}

SDProductRecommendationsV32 defines model for SDProductRecommendationsV32.

type SDProductTargetingRecommendationsSuccess

type SDProductTargetingRecommendationsSuccess struct {
	// Code HTTP status code 200 indicating a successful response for product recommendations.
	Code *string `json:"code,omitempty"`

	// Name The theme name specified in the request.
	Name *string `json:"name,omitempty"`

	// Recommendations A list of recommended products.
	Recommendations *[]SDProductRecommendationV32 `json:"recommendations,omitempty"`
}

SDProductTargetingRecommendationsSuccess Recommendation results for product targeting.

type SDProductTargetingRecommendationsSuccessV34

type SDProductTargetingRecommendationsSuccessV34 struct {
	// Code HTTP status code 200 indicating a successful response for product recommendations.
	Code *string `json:"code,omitempty"`

	// Expression A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.
	// For example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations
	// which are both with greater price and less review rating compared to the goal products.
	// Note: currently the service only support one item in the array.
	Expression *[]SDProductTargetingThemeExpression `json:"expression,omitempty"`

	// Name The theme name specified in the request.
	Name *string `json:"name,omitempty"`

	// Recommendations A list of recommended products.
	Recommendations *[]SDProductRecommendationV32 `json:"recommendations,omitempty"`
}

SDProductTargetingRecommendationsSuccessV34 Recommendation results for product targeting.

type SDProductTargetingTheme

type SDProductTargetingTheme struct {
	// Expression A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.
	// For example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations
	// which are both with greater price and less review rating compared to the goal products.
	// Note: currently the service only support one item in the array.
	Expression []SDProductTargetingThemeExpression `json:"expression"`

	// Name This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.
	// This identifier will also be used to map the recommendations back to the theme in the response body.
	// Note: the value for this field cannot be "default" as that's a reserved keyword in the system.
	Name string `json:"name"`
}

SDProductTargetingTheme Product targeting theme definitions.

type SDProductTargetingThemeExpression

type SDProductTargetingThemeExpression struct {
	// Type The product targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.
	Type SDProductTargetingThemeExpressionType `json:"type"`
}

SDProductTargetingThemeExpression The expression used to define the product targeting theme.

type SDProductTargetingThemeExpressionType

type SDProductTargetingThemeExpressionType string

SDProductTargetingThemeExpressionType The product targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.

const (
	SDProductTargetingThemeExpressionTypeAsinBrandSameAs            SDProductTargetingThemeExpressionType = "asinBrandSameAs"
	SDProductTargetingThemeExpressionTypeAsinGlanceViewsGreaterThan SDProductTargetingThemeExpressionType = "asinGlanceViewsGreaterThan"
	SDProductTargetingThemeExpressionTypeAsinPriceGreaterThan       SDProductTargetingThemeExpressionType = "asinPriceGreaterThan"
	SDProductTargetingThemeExpressionTypeAsinReviewRatingLessThan   SDProductTargetingThemeExpressionType = "asinReviewRatingLessThan"
)

Defines values for SDProductTargetingThemeExpressionType.

type SDProductThemeRecommendations

type SDProductThemeRecommendations = []SDProductThemeRecommendations_Item

SDProductThemeRecommendations A list of product targeting theme recommendations.

type SDProductThemeRecommendationsV34

type SDProductThemeRecommendationsV34 = []SDProductThemeRecommendationsV34_Item

SDProductThemeRecommendationsV34 A list of product targeting theme recommendations.

type SDProductThemeRecommendationsV34_Item

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

SDProductThemeRecommendationsV34_Item defines model for SDProductThemeRecommendationsV34.Item.

func (SDProductThemeRecommendationsV34_Item) AsSDProductTargetingRecommendationsSuccessV34

func (t SDProductThemeRecommendationsV34_Item) AsSDProductTargetingRecommendationsSuccessV34() (SDProductTargetingRecommendationsSuccessV34, error)

AsSDProductTargetingRecommendationsSuccessV34 returns the union data inside the SDProductThemeRecommendationsV34_Item as a SDProductTargetingRecommendationsSuccessV34

func (SDProductThemeRecommendationsV34_Item) AsSDTargetingRecommendationsFailureV34

func (t SDProductThemeRecommendationsV34_Item) AsSDTargetingRecommendationsFailureV34() (SDTargetingRecommendationsFailureV34, error)

AsSDTargetingRecommendationsFailureV34 returns the union data inside the SDProductThemeRecommendationsV34_Item as a SDTargetingRecommendationsFailureV34

func (*SDProductThemeRecommendationsV34_Item) FromSDProductTargetingRecommendationsSuccessV34

func (t *SDProductThemeRecommendationsV34_Item) FromSDProductTargetingRecommendationsSuccessV34(v SDProductTargetingRecommendationsSuccessV34) error

FromSDProductTargetingRecommendationsSuccessV34 overwrites any union data inside the SDProductThemeRecommendationsV34_Item as the provided SDProductTargetingRecommendationsSuccessV34

func (*SDProductThemeRecommendationsV34_Item) FromSDTargetingRecommendationsFailureV34

func (t *SDProductThemeRecommendationsV34_Item) FromSDTargetingRecommendationsFailureV34(v SDTargetingRecommendationsFailureV34) error

FromSDTargetingRecommendationsFailureV34 overwrites any union data inside the SDProductThemeRecommendationsV34_Item as the provided SDTargetingRecommendationsFailureV34

func (SDProductThemeRecommendationsV34_Item) MarshalJSON

func (t SDProductThemeRecommendationsV34_Item) MarshalJSON() ([]byte, error)

func (*SDProductThemeRecommendationsV34_Item) MergeSDProductTargetingRecommendationsSuccessV34

func (t *SDProductThemeRecommendationsV34_Item) MergeSDProductTargetingRecommendationsSuccessV34(v SDProductTargetingRecommendationsSuccessV34) error

MergeSDProductTargetingRecommendationsSuccessV34 performs a merge with any union data inside the SDProductThemeRecommendationsV34_Item, using the provided SDProductTargetingRecommendationsSuccessV34

func (*SDProductThemeRecommendationsV34_Item) MergeSDTargetingRecommendationsFailureV34

func (t *SDProductThemeRecommendationsV34_Item) MergeSDTargetingRecommendationsFailureV34(v SDTargetingRecommendationsFailureV34) error

MergeSDTargetingRecommendationsFailureV34 performs a merge with any union data inside the SDProductThemeRecommendationsV34_Item, using the provided SDTargetingRecommendationsFailureV34

func (*SDProductThemeRecommendationsV34_Item) UnmarshalJSON

func (t *SDProductThemeRecommendationsV34_Item) UnmarshalJSON(b []byte) error

type SDProductThemeRecommendations_Item

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

SDProductThemeRecommendations_Item defines model for SDProductThemeRecommendations.Item.

func (SDProductThemeRecommendations_Item) AsSDProductTargetingRecommendationsSuccess

func (t SDProductThemeRecommendations_Item) AsSDProductTargetingRecommendationsSuccess() (SDProductTargetingRecommendationsSuccess, error)

AsSDProductTargetingRecommendationsSuccess returns the union data inside the SDProductThemeRecommendations_Item as a SDProductTargetingRecommendationsSuccess

func (SDProductThemeRecommendations_Item) AsSDTargetingRecommendationsFailure

func (t SDProductThemeRecommendations_Item) AsSDTargetingRecommendationsFailure() (SDTargetingRecommendationsFailure, error)

AsSDTargetingRecommendationsFailure returns the union data inside the SDProductThemeRecommendations_Item as a SDTargetingRecommendationsFailure

func (*SDProductThemeRecommendations_Item) FromSDProductTargetingRecommendationsSuccess

func (t *SDProductThemeRecommendations_Item) FromSDProductTargetingRecommendationsSuccess(v SDProductTargetingRecommendationsSuccess) error

FromSDProductTargetingRecommendationsSuccess overwrites any union data inside the SDProductThemeRecommendations_Item as the provided SDProductTargetingRecommendationsSuccess

func (*SDProductThemeRecommendations_Item) FromSDTargetingRecommendationsFailure

func (t *SDProductThemeRecommendations_Item) FromSDTargetingRecommendationsFailure(v SDTargetingRecommendationsFailure) error

FromSDTargetingRecommendationsFailure overwrites any union data inside the SDProductThemeRecommendations_Item as the provided SDTargetingRecommendationsFailure

func (SDProductThemeRecommendations_Item) MarshalJSON

func (t SDProductThemeRecommendations_Item) MarshalJSON() ([]byte, error)

func (*SDProductThemeRecommendations_Item) MergeSDProductTargetingRecommendationsSuccess

func (t *SDProductThemeRecommendations_Item) MergeSDProductTargetingRecommendationsSuccess(v SDProductTargetingRecommendationsSuccess) error

MergeSDProductTargetingRecommendationsSuccess performs a merge with any union data inside the SDProductThemeRecommendations_Item, using the provided SDProductTargetingRecommendationsSuccess

func (*SDProductThemeRecommendations_Item) MergeSDTargetingRecommendationsFailure

func (t *SDProductThemeRecommendations_Item) MergeSDTargetingRecommendationsFailure(v SDTargetingRecommendationsFailure) error

MergeSDTargetingRecommendationsFailure performs a merge with any union data inside the SDProductThemeRecommendations_Item, using the provided SDTargetingRecommendationsFailure

func (*SDProductThemeRecommendations_Item) UnmarshalJSON

func (t *SDProductThemeRecommendations_Item) UnmarshalJSON(b []byte) error

type SDProfileHeader

type SDProfileHeader = string

SDProfileHeader defines model for SDProfileHeader.

type SDRecommendationType

type SDRecommendationType string

SDRecommendationType Signifies a type of recommendation

const (
	SDRecommendationTypePRODUCT SDRecommendationType = "PRODUCT"
)

Defines values for SDRecommendationType.

type SDRecommendationTypeV31

type SDRecommendationTypeV31 string

SDRecommendationTypeV31 Signifies a type of recommendation

const (
	SDRecommendationTypeV31CATEGORY SDRecommendationTypeV31 = "CATEGORY"
	SDRecommendationTypeV31PRODUCT  SDRecommendationTypeV31 = "PRODUCT"
)

Defines values for SDRecommendationTypeV31.

type SDRecommendationTypeV32

type SDRecommendationTypeV32 string

SDRecommendationTypeV32 Signifies a type of recommendation

const (
	AUDIENCE SDRecommendationTypeV32 = "AUDIENCE"
	CATEGORY SDRecommendationTypeV32 = "CATEGORY"
	PRODUCT  SDRecommendationTypeV32 = "PRODUCT"
)

Defines values for SDRecommendationTypeV32.

type SDRequestedLocale

type SDRequestedLocale = SDLocale

SDRequestedLocale List of supported locales

type SDRuleBasedBudget

type SDRuleBasedBudget struct {
	AppliedRule *SDBudgetRule `json:"appliedRule,omitempty"`

	// DailyBudgetValue The daily budget value.
	DailyBudgetValue *float32 `json:"dailyBudgetValue,omitempty"`

	// ExecutionTime Epoch time of budget rule execution.
	ExecutionTime *int64 `json:"executionTime,omitempty"`

	// PerformanceMetric An object giving the name of the performance metric and its value when the rule was evaluated
	PerformanceMetric *PerformanceMetricValue `json:"performanceMetric,omitempty"`

	// RuleBasedBudgetValue The budget value.
	RuleBasedBudgetValue *float32 `json:"ruleBasedBudgetValue,omitempty"`
}

SDRuleBasedBudget defines model for SDRuleBasedBudget.

type SDRuleType

type SDRuleType string

SDRuleType The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.

const (
	PERFORMANCE SDRuleType = "PERFORMANCE"
	SCHEDULE    SDRuleType = "SCHEDULE"
)

Defines values for SDRuleType.

type SDSevenDaysMissedOpportunities

type SDSevenDaysMissedOpportunities struct {
	// EndDate End date of the missed opportunities date range (YYYY-MM-DD).
	EndDate *openapi_types.Date `json:"endDate,omitempty"`

	// EstimatedMissedClicksLower Lower bound of the estimated missed clicks.
	EstimatedMissedClicksLower *int `json:"estimatedMissedClicksLower,omitempty"`

	// EstimatedMissedClicksUpper Upper bound of the estimated missed clicks.
	EstimatedMissedClicksUpper *int `json:"estimatedMissedClicksUpper,omitempty"`

	// EstimatedMissedImpressionsLower Lower bound of the estimated missed impressions.
	EstimatedMissedImpressionsLower *int `json:"estimatedMissedImpressionsLower,omitempty"`

	// EstimatedMissedImpressionsUpper Upper bound of the estimated missed impressions.
	EstimatedMissedImpressionsUpper *int `json:"estimatedMissedImpressionsUpper,omitempty"`

	// EstimatedMissedSalesLower Lower bound of the estimated missed sales. This will be in local currency.
	EstimatedMissedSalesLower *float32 `json:"estimatedMissedSalesLower,omitempty"`

	// EstimatedMissedSalesUpper Upper bound of the estimated missed sales. This will be in local currency.
	EstimatedMissedSalesUpper *float32 `json:"estimatedMissedSalesUpper,omitempty"`

	// EstimatedMissedViewableImpressionsLower Lower bound of the estimated missed viewable impressions for vCPM campaigns.
	EstimatedMissedViewableImpressionsLower *int `json:"estimatedMissedViewableImpressionsLower,omitempty"`

	// EstimatedMissedViewableImpressionsUpper Upper bound of the estimated missed viewable impressions for vCPM campaigns.
	EstimatedMissedViewableImpressionsUpper *int `json:"estimatedMissedViewableImpressionsUpper,omitempty"`

	// PercentTimeInBudget Percentage of time the campaign is active with a budget.
	PercentTimeInBudget *float32 `json:"percentTimeInBudget,omitempty"`

	// StartDate Start date of the missed opportunities date range (YYYY-MM-DD).
	StartDate *openapi_types.Date `json:"startDate,omitempty"`
}

SDSevenDaysMissedOpportunities defines model for SDSevenDaysMissedOpportunities.

type SDTactic

type SDTactic string

SDTactic The advertising tactic associated with the campaign. The following table lists available tactic names:

|Tactic Name|Type|Description| |-----------|-----|-----------| |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.| |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.| |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.| |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|

const (
	SDTacticRemarketing SDTactic = "remarketing"
	SDTacticT00001      SDTactic = "T00001"
	SDTacticT00010      SDTactic = "T00010"
	SDTacticT00020      SDTactic = "T00020"
)

Defines values for SDTactic.

type SDTacticV31

type SDTacticV31 string

SDTacticV31 The advertising tactic associated with the campaign. The following table lists available tactic names: |Tactic Name|Type|Description| |-----------|-----|-----------| |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.| |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.| |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.| |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.| |T00030&nbsp;|Audiences&nbsp;|Select individual audiences to show your ads.|

const (
	SDTacticV31Remarketing SDTacticV31 = "remarketing"
	SDTacticV31T00001      SDTacticV31 = "T00001"
	SDTacticV31T00010      SDTacticV31 = "T00010"
	SDTacticV31T00020      SDTacticV31 = "T00020"
	SDTacticV31T00030      SDTacticV31 = "T00030"
)

Defines values for SDTacticV31.

type SDTargetExpressionV31

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

SDTargetExpressionV31 defines model for SDTargetExpressionV31.

func (SDTargetExpressionV31) AsSDTargetingPredicateNestedV31

func (t SDTargetExpressionV31) AsSDTargetingPredicateNestedV31() (SDTargetingPredicateNestedV31, error)

AsSDTargetingPredicateNestedV31 returns the union data inside the SDTargetExpressionV31 as a SDTargetingPredicateNestedV31

func (SDTargetExpressionV31) AsSDTargetingPredicateV31

func (t SDTargetExpressionV31) AsSDTargetingPredicateV31() (SDTargetingPredicateV31, error)

AsSDTargetingPredicateV31 returns the union data inside the SDTargetExpressionV31 as a SDTargetingPredicateV31

func (*SDTargetExpressionV31) FromSDTargetingPredicateNestedV31

func (t *SDTargetExpressionV31) FromSDTargetingPredicateNestedV31(v SDTargetingPredicateNestedV31) error

FromSDTargetingPredicateNestedV31 overwrites any union data inside the SDTargetExpressionV31 as the provided SDTargetingPredicateNestedV31

func (*SDTargetExpressionV31) FromSDTargetingPredicateV31

func (t *SDTargetExpressionV31) FromSDTargetingPredicateV31(v SDTargetingPredicateV31) error

FromSDTargetingPredicateV31 overwrites any union data inside the SDTargetExpressionV31 as the provided SDTargetingPredicateV31

func (SDTargetExpressionV31) MarshalJSON

func (t SDTargetExpressionV31) MarshalJSON() ([]byte, error)

func (*SDTargetExpressionV31) MergeSDTargetingPredicateNestedV31

func (t *SDTargetExpressionV31) MergeSDTargetingPredicateNestedV31(v SDTargetingPredicateNestedV31) error

MergeSDTargetingPredicateNestedV31 performs a merge with any union data inside the SDTargetExpressionV31, using the provided SDTargetingPredicateNestedV31

func (*SDTargetExpressionV31) MergeSDTargetingPredicateV31

func (t *SDTargetExpressionV31) MergeSDTargetingPredicateV31(v SDTargetingPredicateV31) error

MergeSDTargetingPredicateV31 performs a merge with any union data inside the SDTargetExpressionV31, using the provided SDTargetingPredicateV31

func (*SDTargetExpressionV31) UnmarshalJSON

func (t *SDTargetExpressionV31) UnmarshalJSON(b []byte) error

type SDTargetingBidRecommendationsRequestV31

type SDTargetingBidRecommendationsRequestV31 struct {
	// Products A list of products to tailor bid recommendations for category and audience based targeting clauses.
	Products *[]SDGoalProduct `json:"products,omitempty"`

	// TargetingClauses A list of targeting clauses to receive bid recommendations for.
	TargetingClauses []struct {
		// TargetingClause The targeting clause
		TargetingClause SDTargetingClauseV31 `json:"targetingClause"`
	} `json:"targetingClauses"`
}

SDTargetingBidRecommendationsRequestV31 Request for targeting bid recommendations.

type SDTargetingBidRecommendationsRequestV32

type SDTargetingBidRecommendationsRequestV32 struct {
	// BidOptimization Determines what the recommended bids will be optimized for.
	//
	// |Name|CostType|Supported Tactics|Description|
	// |----|----------|-----------|-----------|
	// |clicks|cpc|T00020 T00030|Optimize for page visits|
	// |conversions|cpc|T00020 T00030|Optimize for conversion|
	// |reach|vcpm|T00020 T00030|Optimize for viewable impressions|
	BidOptimization SDBidOptimizationV32 `json:"bidOptimization"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Supported Tactics|Description|
	// |----|----------|-----------|
	// |CPC|T00020 T00030|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |VCPM|T00020 T00030|The bid recommendations will be optimized for viewed impressions triggered by the ad.|
	CostType SDCostTypeV31 `json:"costType"`

	// Products A list of products to tailor bid recommendations for category and audience based targeting clauses.
	Products *[]SDGoalProduct `json:"products,omitempty"`

	// TargetingClauses A list of targeting clauses to receive bid recommendations for.
	TargetingClauses []struct {
		// TargetingClause The targeting clause
		TargetingClause SDTargetingClauseV31 `json:"targetingClause"`
	} `json:"targetingClauses"`
}

SDTargetingBidRecommendationsRequestV32 Request for targeting bid recommendations.

type SDTargetingBidRecommendationsRequestV33

type SDTargetingBidRecommendationsRequestV33 struct {
	// BidOptimization Determines what the recommended bids will be optimized for.
	//
	// |Name|CostType|Supported Tactics|Description|
	// |----|----------|-----------|-----------|
	// |clicks|cpc|T00020 T00030|Optimize for page visits|
	// |conversions|cpc|T00020 T00030|Optimize for conversion|
	// |reach|vcpm|T00020 T00030|Optimize for viewable impressions|
	BidOptimization SDBidOptimizationV32 `json:"bidOptimization"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Supported Tactics|Description|
	// |----|----------|-----------|
	// |CPC|T00020 T00030|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |VCPM|T00020 T00030|The bid recommendations will be optimized for viewed impressions triggered by the ad.|
	CostType SDCostTypeV31 `json:"costType"`

	// CreativeType The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.
	CreativeType *SDCreativeType `json:"creativeType"`

	// Products A list of products to tailor bid recommendations for category and audience based targeting clauses.
	Products *[]SDGoalProduct `json:"products,omitempty"`

	// TargetingClauses A list of targeting clauses to receive bid recommendations for.
	TargetingClauses []struct {
		// TargetingClause The targeting clause
		TargetingClause SDTargetingClauseV31 `json:"targetingClause"`
	} `json:"targetingClauses"`
}

SDTargetingBidRecommendationsRequestV33 Request for targeting bid recommendations.

type SDTargetingBidRecommendationsResponseItemFailureV31

type SDTargetingBidRecommendationsResponseItemFailureV31 struct {
	// Code The HTTP status code of this item.
	Code string `json:"code"`

	// Details A human-readable description of this item on error.
	Details string `json:"details"`
}

SDTargetingBidRecommendationsResponseItemFailureV31 Failed bid recommendation response.

type SDTargetingBidRecommendationsResponseItemSuccessV31

type SDTargetingBidRecommendationsResponseItemSuccessV31 struct {
	// Code The HTTP status code of this item.
	Code *string `json:"code,omitempty"`

	// RangeLower The lowest recommended bid to use to win an ad placement for this target.
	RangeLower float32 `json:"rangeLower"`

	// RangeUpper The highest recommended bid to use to win an ad placement for this target.
	RangeUpper float32 `json:"rangeUpper"`

	// Recommended The recommended bid to use to win an ad placement for this target.
	Recommended float32 `json:"recommended"`
}

SDTargetingBidRecommendationsResponseItemSuccessV31 defines model for SDTargetingBidRecommendationsResponseItemSuccessV31.

type SDTargetingBidRecommendationsResponseV31

type SDTargetingBidRecommendationsResponseV31 struct {
	BidRecommendations interface{} `json:"bidRecommendations"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Supported Tactics|Description|
	// |----|----------|-----------|
	// |CPC|T00020 T00030|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |VCPM|T00020 T00030|The bid recommendations will be optimized for viewed impressions triggered by the ad.|
	CostType SDCostTypeV31 `json:"costType"`
}

SDTargetingBidRecommendationsResponseV31 Response to a request for targeting bid recommendations.

type SDTargetingBidRecommendationsResponseV32

type SDTargetingBidRecommendationsResponseV32 struct {
	// BidOptimization Determines what the recommended bids will be optimized for.
	//
	// |Name|CostType|Supported Tactics|Description|
	// |----|----------|-----------|-----------|
	// |clicks|cpc|T00020 T00030|Optimize for page visits|
	// |conversions|cpc|T00020 T00030|Optimize for conversion|
	// |reach|vcpm|T00020 T00030|Optimize for viewable impressions|
	BidOptimization    SDBidOptimizationV32 `json:"bidOptimization"`
	BidRecommendations interface{}          `json:"bidRecommendations"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Supported Tactics|Description|
	// |----|----------|-----------|
	// |CPC|T00020 T00030|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |VCPM|T00020 T00030|The bid recommendations will be optimized for viewed impressions triggered by the ad.|
	CostType SDCostTypeV31 `json:"costType"`
}

SDTargetingBidRecommendationsResponseV32 Response to a request for targeting bid recommendations.

type SDTargetingClauseV31

type SDTargetingClauseV31 struct {
	// Expression The targeting expression to match against.
	//
	// ------- Applicable to Product targeting (T00020) -------
	// * A 'TargetingExpression' in a Product targeting Campaign can only contain 'TargetingPredicate' components.
	// * Expressions must specify either a category predicate or an ASIN predicate, but never both.
	// * Only one category may be specified per targeting expression.
	// * Only one brand may be specified per targeting expression.
	// * Only one asin may be specified per targeting expression.
	// * To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.
	//
	// ------- Applicable to Audience targeting (T00030) -------
	// * A 'TargetingExpression' in an Audience Campaign can only contain 'TargetingPredicateNested' components.
	// * Expressions must specify either auto ASIN-grain (exact products), manual ASIN-grain (similar products), or manual category-grain targeting.
	// * **Future** To exclude parts of an audience, specify a TargetingPredicateNested component that contains a negative TargetingPredicate type.
	Expression SDTargetingExpressionV31 `json:"expression"`

	// ExpressionType Tactic T00020 ad groups only allow manual targeting.
	ExpressionType SDTargetingClauseV31ExpressionType `json:"expressionType"`
}

SDTargetingClauseV31 The targeting clause

type SDTargetingClauseV31ExpressionType

type SDTargetingClauseV31ExpressionType string

SDTargetingClauseV31ExpressionType Tactic T00020 ad groups only allow manual targeting.

Defines values for SDTargetingClauseV31ExpressionType.

type SDTargetingExpressionV31

type SDTargetingExpressionV31 = []SDTargetExpressionV31

SDTargetingExpressionV31 The targeting expression to match against.

------- Applicable to Product targeting (T00020) ------- * A 'TargetingExpression' in a Product targeting Campaign can only contain 'TargetingPredicate' components. * Expressions must specify either a category predicate or an ASIN predicate, but never both. * Only one category may be specified per targeting expression. * Only one brand may be specified per targeting expression. * Only one asin may be specified per targeting expression. * To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.

------- Applicable to Audience targeting (T00030) ------- * A 'TargetingExpression' in an Audience Campaign can only contain 'TargetingPredicateNested' components. * Expressions must specify either auto ASIN-grain (exact products), manual ASIN-grain (similar products), or manual category-grain targeting. * **Future** To exclude parts of an audience, specify a TargetingPredicateNested component that contains a negative TargetingPredicate type.

type SDTargetingPredicateBaseV31

type SDTargetingPredicateBaseV31 struct {
	Type SDTargetingPredicateBaseV31Type `json:"type"`

	// Value The value to be targeted.
	Value *string `json:"value,omitempty"`
}

SDTargetingPredicateBaseV31 A predicate to match against inside the TargetingPredicateNested component (only applicable to Audience targeting - T00030).

* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Advertising browse system. * Brand, price, and review predicates are optional and may only be specified if category is also specified. * Review predicates accept numbers between 0 and 5 and are inclusive. * When using either of the ‘between’ strings to construct a targeting expression the format of the string is ‘double-double’ where the first double must be smaller than the second double. Prices are not inclusive. * The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field. * The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'. * **Future** A 'negative' TargetingPredicateBase will exclude that TargetingPredicateNested from the overall audience.

type SDTargetingPredicateBaseV31Type

type SDTargetingPredicateBaseV31Type string

SDTargetingPredicateBaseV31Type defines model for SDTargetingPredicateBaseV31.Type.

const (
	SDTargetingPredicateBaseV31TypeAsinAgeRangeSameAs          SDTargetingPredicateBaseV31Type = "asinAgeRangeSameAs"
	SDTargetingPredicateBaseV31TypeAsinBrandSameAs             SDTargetingPredicateBaseV31Type = "asinBrandSameAs"
	SDTargetingPredicateBaseV31TypeAsinCategorySameAs          SDTargetingPredicateBaseV31Type = "asinCategorySameAs"
	SDTargetingPredicateBaseV31TypeAsinGenreSameAs             SDTargetingPredicateBaseV31Type = "asinGenreSameAs"
	SDTargetingPredicateBaseV31TypeAsinIsPrimeShippingEligible SDTargetingPredicateBaseV31Type = "asinIsPrimeShippingEligible"
	SDTargetingPredicateBaseV31TypeAsinPriceBetween            SDTargetingPredicateBaseV31Type = "asinPriceBetween"
	SDTargetingPredicateBaseV31TypeAsinPriceGreaterThan        SDTargetingPredicateBaseV31Type = "asinPriceGreaterThan"
	SDTargetingPredicateBaseV31TypeAsinPriceLessThan           SDTargetingPredicateBaseV31Type = "asinPriceLessThan"
	SDTargetingPredicateBaseV31TypeAsinReviewRatingBetween     SDTargetingPredicateBaseV31Type = "asinReviewRatingBetween"
	SDTargetingPredicateBaseV31TypeAsinReviewRatingGreaterThan SDTargetingPredicateBaseV31Type = "asinReviewRatingGreaterThan"
	SDTargetingPredicateBaseV31TypeAsinReviewRatingLessThan    SDTargetingPredicateBaseV31Type = "asinReviewRatingLessThan"
	SDTargetingPredicateBaseV31TypeAudienceSameAs              SDTargetingPredicateBaseV31Type = "audienceSameAs"
	SDTargetingPredicateBaseV31TypeExactProduct                SDTargetingPredicateBaseV31Type = "exactProduct"
	SDTargetingPredicateBaseV31TypeLookback                    SDTargetingPredicateBaseV31Type = "lookback"
	SDTargetingPredicateBaseV31TypeNegative                    SDTargetingPredicateBaseV31Type = "negative"
	SDTargetingPredicateBaseV31TypeRelatedProduct              SDTargetingPredicateBaseV31Type = "relatedProduct"
	SDTargetingPredicateBaseV31TypeSimilarProduct              SDTargetingPredicateBaseV31Type = "similarProduct"
)

Defines values for SDTargetingPredicateBaseV31Type.

type SDTargetingPredicateNestedV31

type SDTargetingPredicateNestedV31 struct {
	Type  SDTargetingPredicateNestedV31Type `json:"type"`
	Value []SDTargetingPredicateBaseV31     `json:"value"`
}

SDTargetingPredicateNestedV31 A behavioral event and list of targeting predicates that represents an Audience to target (only applicable to Audience targeting - T00030).

* For auto ASIN-grain targeting, the value array must contain only 'exactProduct' and 'lookback' TargetingPredicateBase components. * For manual ASIN-grain targeting, the value array must contain only 'similarProduct' and 'lookback' TargetingPredicateBase components. * For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. * For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'. * **Future** For manual Category-grain targeting, adding a 'negative' TargetingPredicateBase will exclude that TargetingPredicateNested from the overall audience.

type SDTargetingPredicateNestedV31Type

type SDTargetingPredicateNestedV31Type string

SDTargetingPredicateNestedV31Type defines model for SDTargetingPredicateNestedV31.Type.

const (
	Audience  SDTargetingPredicateNestedV31Type = "audience"
	Purchases SDTargetingPredicateNestedV31Type = "purchases"
	Views     SDTargetingPredicateNestedV31Type = "views"
)

Defines values for SDTargetingPredicateNestedV31Type.

type SDTargetingPredicateV31

type SDTargetingPredicateV31 struct {
	Type SDTargetingPredicateV31Type `json:"type"`

	// Value The value to be targeted.
	Value *string `json:"value,omitempty"`
}

SDTargetingPredicateV31 A predicate to match against in the Targeting Expression (only applicable to Product targeting - T00020).

* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Advertising browse system. * Brand, price, and review predicates are optional and may only be specified if category is also specified. * Review predicates accept numbers between 0 and 5 and are inclusive. * When using either of the ‘between’ strings to construct a targeting expression the format of the string is ‘double-double’ where the first double must be smaller than the second double. Prices are not inclusive.

type SDTargetingPredicateV31Type

type SDTargetingPredicateV31Type string

SDTargetingPredicateV31Type defines model for SDTargetingPredicateV31.Type.

const (
	AsinAgeRangeSameAs          SDTargetingPredicateV31Type = "asinAgeRangeSameAs"
	AsinBrandSameAs             SDTargetingPredicateV31Type = "asinBrandSameAs"
	AsinCategorySameAs          SDTargetingPredicateV31Type = "asinCategorySameAs"
	AsinGenreSameAs             SDTargetingPredicateV31Type = "asinGenreSameAs"
	AsinIsPrimeShippingEligible SDTargetingPredicateV31Type = "asinIsPrimeShippingEligible"
	AsinPriceBetween            SDTargetingPredicateV31Type = "asinPriceBetween"
	AsinPriceGreaterThan        SDTargetingPredicateV31Type = "asinPriceGreaterThan"
	AsinPriceLessThan           SDTargetingPredicateV31Type = "asinPriceLessThan"
	AsinReviewRatingBetween     SDTargetingPredicateV31Type = "asinReviewRatingBetween"
	AsinReviewRatingGreaterThan SDTargetingPredicateV31Type = "asinReviewRatingGreaterThan"
	AsinReviewRatingLessThan    SDTargetingPredicateV31Type = "asinReviewRatingLessThan"
	AsinSameAs                  SDTargetingPredicateV31Type = "asinSameAs"
	SimilarProduct              SDTargetingPredicateV31Type = "similarProduct"
)

Defines values for SDTargetingPredicateV31Type.

type SDTargetingRecommendations

type SDTargetingRecommendations struct {
	// Products List of recommended product targets
	Products *[]SDProductRecommendation `json:"products,omitempty"`
}

SDTargetingRecommendations A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.

type SDTargetingRecommendationsFailure

type SDTargetingRecommendationsFailure struct {
	// Code HTTP status code indicating a failure response for targeting recomendations.
	Code *string `json:"code,omitempty"`

	// ErrorMessage A human friendly error message indicating the failure reasons.
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Name The theme name specified in the request. If the themes field is not provided in the request,
	// the value of this field will be set to default.
	Name *string `json:"name,omitempty"`
}

SDTargetingRecommendationsFailure A targeting recommendation failure record.

type SDTargetingRecommendationsFailureV34

type SDTargetingRecommendationsFailureV34 struct {
	// Code HTTP status code indicating a failure response for targeting recomendations.
	Code *string `json:"code,omitempty"`

	// ErrorMessage A human friendly error message indicating the failure reasons.
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Expression A list of expressions that failed to be applied in the product targeting theme.
	Expression *[]SDProductTargetingThemeExpression `json:"expression,omitempty"`

	// Name The theme name specified in the request. If the themes field is not provided in the request,
	// the value of this field will be set to default.
	Name *string `json:"name,omitempty"`
}

SDTargetingRecommendationsFailureV34 A targeting recommendation failure record.

type SDTargetingRecommendationsProducts

type SDTargetingRecommendationsProducts = []SDGoalProduct

SDTargetingRecommendationsProducts A list of products for which to get targeting recommendations

type SDTargetingRecommendationsRequest

type SDTargetingRecommendationsRequest struct {
	// Products A list of products for which to get targeting recommendations
	Products []SDGoalProduct `json:"products"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	//
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.|
	// |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|
	Tactic SDTactic `json:"tactic"`

	// TypeFilter A filter to indicate which types of recommendations to request.
	TypeFilter []SDRecommendationType `json:"typeFilter"`
}

SDTargetingRecommendationsRequest Request for targeting recommendations

type SDTargetingRecommendationsRequestV31

type SDTargetingRecommendationsRequestV31 struct {
	// Products A list of products for which to get targeting recommendations
	Products SDTargetingRecommendationsProducts `json:"products"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.|
	// |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|
	// |T00030&nbsp;|Audiences&nbsp;|Select individual audiences to show your ads.|
	Tactic SDTacticV31 `json:"tactic"`

	// TypeFilter A filter to indicate which types of recommendations to request.
	TypeFilter SDTargetingRecommendationsTypeFilterV31 `json:"typeFilter"`
}

SDTargetingRecommendationsRequestV31 Request for targeting recommendations

type SDTargetingRecommendationsRequestV32

type SDTargetingRecommendationsRequestV32 struct {
	// Products A list of products for which to get targeting recommendations
	Products SDTargetingRecommendationsProducts `json:"products"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.|
	// |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|
	// |T00030&nbsp;|Audiences&nbsp;|Select individual audiences to show your ads.|
	Tactic SDTacticV31 `json:"tactic"`

	// Themes The themes used to refine the recommendations. Currently only product targeting themes are supported.
	Themes *SDTargetingRecommendationsThemes `json:"themes,omitempty"`

	// TypeFilter A filter to indicate which types of recommendations to request.
	TypeFilter SDTargetingRecommendationsTypeFilterV31 `json:"typeFilter"`
}

SDTargetingRecommendationsRequestV32 Request for targeting recommendations

type SDTargetingRecommendationsRequestV33

type SDTargetingRecommendationsRequestV33 struct {
	// Products A list of products for which to get targeting recommendations
	Products SDTargetingRecommendationsProducts `json:"products"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.|
	// |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|
	// |T00030&nbsp;|Audiences&nbsp;|Select individual audiences to show your ads.|
	Tactic SDTacticV31 `json:"tactic"`

	// Themes The themes used to refine the recommendations. Currently only product targeting themes are supported.
	Themes *SDTargetingRecommendationsThemes `json:"themes,omitempty"`

	// TypeFilter A filter to indicate which types of recommendations to request.
	TypeFilter SDTargetingRecommendationsTypeFilterV32 `json:"typeFilter"`
}

SDTargetingRecommendationsRequestV33 Request for targeting recommendations

type SDTargetingRecommendationsRequestV34

type SDTargetingRecommendationsRequestV34 struct {
	// Products A list of products for which to get targeting recommendations
	Products SDTargetingRecommendationsProducts `json:"products"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00001&nbsp;|&nbsp;|This tactic name is only applicable for the `requestReport` operation and does not apply to any other campaign management operations. Reach shoppers who showed interest in categories related to your promoted products, or target specific products or product categories on Amazon. This tactic is for use by only vendors. This tactic is used to retrieve metrics for Sponsored Display campaigns that use interest, product or category audiences, including Sponsored Display campaigns that were previously Product Display Ads campaigns.|
	// |T00010&nbsp;|Views&nbsp;|**Note that this advertising tactic is not currently supported. This note will be removed when this advertising tactic is available.** This is the same tactic as 'remarketing'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |remarketing&nbsp;|Views&nbsp;|This is the same tactic as 'T00010'. Shoppers who viewed the detail pages of your advertised products or similar products.|
	// |T00020&nbsp;|Products&nbsp;|Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|
	// |T00030&nbsp;|Audiences&nbsp;|Select individual audiences to show your ads.|
	Tactic SDTacticV31 `json:"tactic"`

	// Themes The themes used to refine the recommendations. Currently only product targeting themes are supported.
	Themes *SDTargetingRecommendationsThemes `json:"themes,omitempty"`

	// TypeFilter A filter to indicate which types of recommendations to request.
	TypeFilter SDTargetingRecommendationsTypeFilterV32 `json:"typeFilter"`
}

SDTargetingRecommendationsRequestV34 Request for targeting recommendations

type SDTargetingRecommendationsResponse

type SDTargetingRecommendationsResponse struct {
	// Recommendations A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.
	Recommendations *SDTargetingRecommendations `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponse Response to a request for targeting recommendations

type SDTargetingRecommendationsResponseV31

type SDTargetingRecommendationsResponseV31 struct {
	// Recommendations A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.
	Recommendations *SDTargetingRecommendationsV31 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV31 Response to a request for targeting recommendations

type SDTargetingRecommendationsResponseV32

type SDTargetingRecommendationsResponseV32 struct {
	// Recommendations For v3.2 the service will continue to return the recommendations returned for v3.1 in products field,
	// and return recommendations for product targeting themes in themes field.
	Recommendations *SDTargetingRecommendationsV32 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV32 Response body for targeting recommendations v3.2.

type SDTargetingRecommendationsResponseV33

type SDTargetingRecommendationsResponseV33 struct {
	// Recommendations A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.
	Recommendations *SDTargetingRecommendationsV33 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV33 Response to a request for targeting recommendations

type SDTargetingRecommendationsResponseV34

type SDTargetingRecommendationsResponseV34 struct {
	// Recommendations A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.
	Recommendations *SDTargetingRecommendationsV34 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV34 Response to a request for targeting recommendations

type SDTargetingRecommendationsThemes

type SDTargetingRecommendationsThemes struct {
	// Product A list of themes for product targeting recommendations. If this list is empty, the service will return
	// all the current available theme recommendations. Recommendations will be returned for each theme.
	// If specified, each theme should only include unique expressions.
	Product *[]SDProductTargetingTheme `json:"product,omitempty"`
}

SDTargetingRecommendationsThemes The themes used to refine the recommendations. Currently only product targeting themes are supported.

type SDTargetingRecommendationsTypeFilterV31

type SDTargetingRecommendationsTypeFilterV31 = []SDRecommendationTypeV31

SDTargetingRecommendationsTypeFilterV31 A filter to indicate which types of recommendations to request.

type SDTargetingRecommendationsTypeFilterV32

type SDTargetingRecommendationsTypeFilterV32 = []SDRecommendationTypeV32

SDTargetingRecommendationsTypeFilterV32 A filter to indicate which types of recommendations to request.

type SDTargetingRecommendationsV31

type SDTargetingRecommendationsV31 struct {
	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendation `json:"categories,omitempty"`

	// Products List of recommended product targets
	Products *[]SDProductRecommendation `json:"products,omitempty"`
}

SDTargetingRecommendationsV31 defines model for SDTargetingRecommendationsV31.

type SDTargetingRecommendationsV32

type SDTargetingRecommendationsV32 struct {
	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendation `json:"categories,omitempty"`

	// Products List of recommended product targets
	Products *[]SDProductRecommendationV32 `json:"products,omitempty"`
	Themes   *SDThemeRecommendations       `json:"themes,omitempty"`
}

SDTargetingRecommendationsV32 defines model for SDTargetingRecommendationsV32.

type SDTargetingRecommendationsV33

type SDTargetingRecommendationsV33 struct {
	// Audiences List of recommended audience targets, broken down by audience category
	Audiences *[]SDAudienceCategoryRecommendations `json:"audiences,omitempty"`

	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendationV33 `json:"categories,omitempty"`

	// Products List of recommended product targets
	Products *[]SDProductRecommendationV32 `json:"products,omitempty"`
	Themes   *SDThemeRecommendations       `json:"themes,omitempty"`
}

SDTargetingRecommendationsV33 defines model for SDTargetingRecommendationsV33.

type SDTargetingRecommendationsV34

type SDTargetingRecommendationsV34 struct {
	// Audiences List of recommended audience targets, broken down by audience category
	Audiences *[]SDAudienceCategoryRecommendations `json:"audiences,omitempty"`

	// Categories List of recommended category targets
	Categories *[]SDCategoryRecommendationV33 `json:"categories,omitempty"`

	// Products List of recommended product targets
	Products *[]SDProductRecommendationV32 `json:"products,omitempty"`
	Themes   *SDThemeRecommendationsV34    `json:"themes,omitempty"`
}

SDTargetingRecommendationsV34 A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.

type SDThemeRecommendations

type SDThemeRecommendations struct {
	// Products A list of product targeting theme recommendations.
	Products *SDProductThemeRecommendations `json:"products,omitempty"`
}

SDThemeRecommendations defines model for SDThemeRecommendations.

type SDThemeRecommendationsV34

type SDThemeRecommendationsV34 struct {
	// Products A list of product targeting theme recommendations.
	Products *SDProductThemeRecommendationsV34 `json:"products,omitempty"`
}

SDThemeRecommendationsV34 defines model for SDThemeRecommendationsV34.

type SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody

type SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody = BudgetUsageCampaignRequest

SdCampaignsBudgetUsageApplicationVndSdcampaignbudgetusageV1PlusJSONRequestBody defines body for SdCampaignsBudgetUsage for application/vnd.sdcampaignbudgetusage.v1+json ContentType.

type SdCampaignsBudgetUsageParams

type SdCampaignsBudgetUsageParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId interface{} `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope interface{} `json:"Amazon-Advertising-API-Scope"`
}

SdCampaignsBudgetUsageParams defines parameters for SdCampaignsBudgetUsage.

type SdCampaignsBudgetUsageResp

type SdCampaignsBudgetUsageResp struct {
	Body                                         []byte
	HTTPResponse                                 *http.Response
	ApplicationvndSdcampaignbudgetusageV1JSON207 *BudgetUsageCampaignResponse
	JSON400                                      *BudgetUsageError
	JSON401                                      *BudgetUsageError
	JSON403                                      *BudgetUsageError
	JSON422                                      *BudgetUsageError
	JSON429                                      *BudgetUsageError
	JSON500                                      *BudgetUsageError
}

func ParseSdCampaignsBudgetUsageResp

func ParseSdCampaignsBudgetUsageResp(rsp *http.Response) (*SdCampaignsBudgetUsageResp, error)

ParseSdCampaignsBudgetUsageResp parses an HTTP response from a SdCampaignsBudgetUsageWithResponse call

func (SdCampaignsBudgetUsageResp) Status

Status returns HTTPResponse.Status

func (SdCampaignsBudgetUsageResp) StatusCode

func (r SdCampaignsBudgetUsageResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SdDefaultError

type SdDefaultError struct {
	// Code The HTTP status code of the response.
	Code *string `json:"code,omitempty"`

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

SdDefaultError The error response object

type SnapshotRequest

type SnapshotRequest struct {
	// StateFilter Optional. Restricts results to entities with state within the specified comma-separated list. The stateFilter not presenting or passing `null` or `""` would be treated as default behavior is to include enabled and paused.
	StateFilter *SnapshotRequestStateFilter `json:"stateFilter,omitempty"`

	// TacticFilter Optional. Restricts results to entities with the advertising tactic associated with the campaign within the specified comma-separated list. The tacticFilter not presenting or passing `null` or `""` would be treated as default behavior is to return entities for all tactics.
	TacticFilter *SnapshotRequestTacticFilter `json:"tacticFilter,omitempty"`
}

SnapshotRequest defines model for SnapshotRequest.

type SnapshotRequestStateFilter

type SnapshotRequestStateFilter string

SnapshotRequestStateFilter Optional. Restricts results to entities with state within the specified comma-separated list. The stateFilter not presenting or passing `null` or `""` would be treated as default behavior is to include enabled and paused.

const (
	Archived              SnapshotRequestStateFilter = "archived"
	Enabled               SnapshotRequestStateFilter = "enabled"
	EnabledPaused         SnapshotRequestStateFilter = "enabled, paused"
	Enabledarchived       SnapshotRequestStateFilter = "enabled,archived"
	Enabledpausedarchived SnapshotRequestStateFilter = "enabled,paused,archived"
	Paused                SnapshotRequestStateFilter = "paused"
	Pausedarchived        SnapshotRequestStateFilter = "paused,archived"
)

Defines values for SnapshotRequestStateFilter.

type SnapshotRequestTacticFilter

type SnapshotRequestTacticFilter string

SnapshotRequestTacticFilter Optional. Restricts results to entities with the advertising tactic associated with the campaign within the specified comma-separated list. The tacticFilter not presenting or passing `null` or `""` would be treated as default behavior is to return entities for all tactics.

const (
	Remarketing             SnapshotRequestTacticFilter = "remarketing"
	T00010                  SnapshotRequestTacticFilter = "T00010"
	T00010T00020            SnapshotRequestTacticFilter = "T00010,T00020"
	T00010T00020remarketing SnapshotRequestTacticFilter = "T00010,T00020,remarketing"
	T00010remarketing       SnapshotRequestTacticFilter = "T00010,remarketing"
	T00020                  SnapshotRequestTacticFilter = "T00020"
	T00020remarketing       SnapshotRequestTacticFilter = "T00020,remarketing"
)

Defines values for SnapshotRequestTacticFilter.

type SnapshotResponse

type SnapshotResponse struct {
	// Expiration The epoch time for expiration of the snapshot file. It's only available if status is SUCCESS.
	Expiration *float32 `json:"expiration,omitempty"`

	// FileSize The size of the snapshot file in bytes. It's only available if status is SUCCESS.
	FileSize *float32 `json:"fileSize,omitempty"`

	// Location The URI for the snapshot. It's only available if status is SUCCESS.
	Location *string `json:"location,omitempty"`

	// RecordType The record type of the snapshot file.
	RecordType *SnapshotResponseRecordType `json:"recordType,omitempty"`

	// SnapshotId The identifier of the snapshot that was requested.
	SnapshotId *string `json:"snapshotId,omitempty"`

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

	// StatusDetails Status information of the call if SUCCESS or FAILURE status, optional for IN_PROCESS.
	StatusDetails *string `json:"statusDetails,omitempty"`
}

SnapshotResponse defines model for SnapshotResponse.

type SnapshotResponseRecordType

type SnapshotResponseRecordType string

SnapshotResponseRecordType The record type of the snapshot file.

const (
	SnapshotResponseRecordTypeAdGroups        SnapshotResponseRecordType = "adGroups"
	SnapshotResponseRecordTypeCampaigns       SnapshotResponseRecordType = "campaigns"
	SnapshotResponseRecordTypeNegativeTargets SnapshotResponseRecordType = "negativeTargets"
	SnapshotResponseRecordTypeProductAds      SnapshotResponseRecordType = "productAds"
	SnapshotResponseRecordTypeTargets         SnapshotResponseRecordType = "targets"
)

Defines values for SnapshotResponseRecordType.

type SnapshotResponseStatus

type SnapshotResponseStatus string

SnapshotResponseStatus The status of the generation of the snapshot.

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

Defines values for SnapshotResponseStatus.

type State

type State string

State The budget rule state.

const (
	ACTIVE State = "ACTIVE"
	PAUSED State = "PAUSED"
)

Defines values for State.

type UpdateBudgetRulesForSDCampaignsJSONRequestBody

type UpdateBudgetRulesForSDCampaignsJSONRequestBody = UpdateSDBudgetRulesRequest

UpdateBudgetRulesForSDCampaignsJSONRequestBody defines body for UpdateBudgetRulesForSDCampaigns for application/json ContentType.

type UpdateBudgetRulesForSDCampaignsParams

type UpdateBudgetRulesForSDCampaignsParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `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. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

UpdateBudgetRulesForSDCampaignsParams defines parameters for UpdateBudgetRulesForSDCampaigns.

type UpdateBudgetRulesForSDCampaignsResp

type UpdateBudgetRulesForSDCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *UpdateBudgetRulesResponse
	JSON400      *BudgetRuleError
	JSON401      *BudgetRuleError
	JSON403      *BudgetRuleError
	JSON422      *BudgetRuleError
	JSON429      *BudgetRuleError
	JSON500      *BudgetRuleError
}

func ParseUpdateBudgetRulesForSDCampaignsResp

func ParseUpdateBudgetRulesForSDCampaignsResp(rsp *http.Response) (*UpdateBudgetRulesForSDCampaignsResp, error)

ParseUpdateBudgetRulesForSDCampaignsResp parses an HTTP response from a UpdateBudgetRulesForSDCampaignsWithResponse call

func (UpdateBudgetRulesForSDCampaignsResp) Status

Status returns HTTPResponse.Status

func (UpdateBudgetRulesForSDCampaignsResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type UpdateBudgetRulesResponse

type UpdateBudgetRulesResponse struct {
	Responses *[]BudgetRuleResponse `json:"responses,omitempty"`
}

UpdateBudgetRulesResponse defines model for UpdateBudgetRulesResponse.

type UpdateSDBudgetRulesRequest

type UpdateSDBudgetRulesRequest struct {
	// BudgetRulesDetails A list of budget rule details.
	BudgetRulesDetails *[]SDBudgetRule `json:"budgetRulesDetails,omitempty"`
}

UpdateSDBudgetRulesRequest Request object for updating budget rule for SD campaign

Jump to

Keyboard shortcuts

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