sponsoreddisplay

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

Documentation

Overview

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

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

Index

Constants

View Source
const (
	BearerAuthScopes              = "bearerAuth.Scopes"
	Oauth2AuthorizationCodeScopes = "oauth2AuthorizationCode.Scopes"
)

Variables

This section is empty.

Functions

func NewArchiveAdGroupRequest

func NewArchiveAdGroupRequest(server string, adGroupId int64, params *ArchiveAdGroupParams) (*http.Request, error)

NewArchiveAdGroupRequest generates requests for ArchiveAdGroup

func NewArchiveCampaignRequest

func NewArchiveCampaignRequest(server string, campaignId int64, params *ArchiveCampaignParams) (*http.Request, error)

NewArchiveCampaignRequest generates requests for ArchiveCampaign

func NewArchiveNegativeTargetingClauseRequest

func NewArchiveNegativeTargetingClauseRequest(server string, negativeTargetId int64, params *ArchiveNegativeTargetingClauseParams) (*http.Request, error)

NewArchiveNegativeTargetingClauseRequest generates requests for ArchiveNegativeTargetingClause

func NewArchiveProductAdRequest

func NewArchiveProductAdRequest(server string, adId int64, params *ArchiveProductAdParams) (*http.Request, error)

NewArchiveProductAdRequest generates requests for ArchiveProductAd

func NewArchiveTargetingClauseRequest

func NewArchiveTargetingClauseRequest(server string, targetId int64, params *ArchiveTargetingClauseParams) (*http.Request, error)

NewArchiveTargetingClauseRequest generates requests for ArchiveTargetingClause

func NewAssociateOptimizationRulesWithAdGroupRequest

func NewAssociateOptimizationRulesWithAdGroupRequest(server string, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, body AssociateOptimizationRulesWithAdGroupJSONRequestBody) (*http.Request, error)

NewAssociateOptimizationRulesWithAdGroupRequest calls the generic AssociateOptimizationRulesWithAdGroup builder with application/json body

func NewAssociateOptimizationRulesWithAdGroupRequestWithBody

func NewAssociateOptimizationRulesWithAdGroupRequestWithBody(server string, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, contentType string, body io.Reader) (*http.Request, error)

NewAssociateOptimizationRulesWithAdGroupRequestWithBody generates requests for AssociateOptimizationRulesWithAdGroup with any type of body

func NewCreateAdGroupsRequest

func NewCreateAdGroupsRequest(server string, params *CreateAdGroupsParams, body CreateAdGroupsJSONRequestBody) (*http.Request, error)

NewCreateAdGroupsRequest calls the generic CreateAdGroups builder with application/json body

func NewCreateAdGroupsRequestWithBody

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

NewCreateAdGroupsRequestWithBody generates requests for CreateAdGroups 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 NewCreateCampaignsRequest

func NewCreateCampaignsRequest(server string, params *CreateCampaignsParams, body CreateCampaignsJSONRequestBody) (*http.Request, error)

NewCreateCampaignsRequest calls the generic CreateCampaigns builder with application/json body

func NewCreateCampaignsRequestWithBody

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

NewCreateCampaignsRequestWithBody generates requests for CreateCampaigns with any type of body

func NewCreateCreativesRequest

func NewCreateCreativesRequest(server string, params *CreateCreativesParams, body CreateCreativesJSONRequestBody) (*http.Request, error)

NewCreateCreativesRequest calls the generic CreateCreatives builder with application/json body

func NewCreateCreativesRequestWithBody

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

NewCreateCreativesRequestWithBody generates requests for CreateCreatives with any type of body

func NewCreateLocationsRequest

func NewCreateLocationsRequest(server string, params *CreateLocationsParams, body CreateLocationsJSONRequestBody) (*http.Request, error)

NewCreateLocationsRequest calls the generic CreateLocations builder with application/json body

func NewCreateLocationsRequestWithBody

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

NewCreateLocationsRequestWithBody generates requests for CreateLocations with any type of body

func NewCreateNegativeTargetingClausesRequest

func NewCreateNegativeTargetingClausesRequest(server string, params *CreateNegativeTargetingClausesParams, body CreateNegativeTargetingClausesJSONRequestBody) (*http.Request, error)

NewCreateNegativeTargetingClausesRequest calls the generic CreateNegativeTargetingClauses builder with application/json body

func NewCreateNegativeTargetingClausesRequestWithBody

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

NewCreateNegativeTargetingClausesRequestWithBody generates requests for CreateNegativeTargetingClauses with any type of body

func NewCreateOptimizationRulesRequest

func NewCreateOptimizationRulesRequest(server string, params *CreateOptimizationRulesParams, body CreateOptimizationRulesJSONRequestBody) (*http.Request, error)

NewCreateOptimizationRulesRequest calls the generic CreateOptimizationRules builder with application/json body

func NewCreateOptimizationRulesRequestWithBody

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

NewCreateOptimizationRulesRequestWithBody generates requests for CreateOptimizationRules with any type of body

func NewCreateProductAdsRequest

func NewCreateProductAdsRequest(server string, params *CreateProductAdsParams, body CreateProductAdsJSONRequestBody) (*http.Request, error)

NewCreateProductAdsRequest calls the generic CreateProductAds builder with application/json body

func NewCreateProductAdsRequestWithBody

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

NewCreateProductAdsRequestWithBody generates requests for CreateProductAds with any type of body

func NewCreateSDForecastRequestWithApplicationVndSdforecastsV30PlusJSONBody

func NewCreateSDForecastRequestWithApplicationVndSdforecastsV30PlusJSONBody(server string, params *CreateSDForecastParams, body CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody) (*http.Request, error)

NewCreateSDForecastRequestWithApplicationVndSdforecastsV30PlusJSONBody calls the generic CreateSDForecast builder with application/vnd.sdforecasts.v3.0+json body

func NewCreateSDForecastRequestWithBody

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

NewCreateSDForecastRequestWithBody generates requests for CreateSDForecast with any type of body

func NewCreateSnapshotRequest

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

NewCreateSnapshotRequest calls the generic CreateSnapshot builder with application/json body

func NewCreateSnapshotRequestWithBody

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

NewCreateSnapshotRequestWithBody generates requests for CreateSnapshot with any type of body

func NewCreateTargetingClausesRequest

func NewCreateTargetingClausesRequest(server string, params *CreateTargetingClausesParams, body CreateTargetingClausesJSONRequestBody) (*http.Request, error)

NewCreateTargetingClausesRequest calls the generic CreateTargetingClauses builder with application/json body

func NewCreateTargetingClausesRequestWithBody

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

NewCreateTargetingClausesRequestWithBody generates requests for CreateTargetingClauses with any type of body

func NewDeleteBrandSafetyDenyListRequest

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

NewDeleteBrandSafetyDenyListRequest generates requests for DeleteBrandSafetyDenyList

func NewDownloadReportRequest

func NewDownloadReportRequest(server string, reportId string, params *DownloadReportParams) (*http.Request, error)

NewDownloadReportRequest generates requests for DownloadReport

func NewDownloadSnapshotRequest

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

NewDownloadSnapshotRequest generates requests for DownloadSnapshot

func NewGetAdGroupRequest

func NewGetAdGroupRequest(server string, adGroupId int64, params *GetAdGroupParams) (*http.Request, error)

NewGetAdGroupRequest generates requests for GetAdGroup

func NewGetAdGroupResponseExRequest

func NewGetAdGroupResponseExRequest(server string, adGroupId int64, params *GetAdGroupResponseExParams) (*http.Request, error)

NewGetAdGroupResponseExRequest generates requests for GetAdGroupResponseEx

func NewGetBudgetRuleByRuleIdForSDCampaignsRequest

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

NewGetBudgetRuleByRuleIdForSDCampaignsRequest generates requests for GetBudgetRuleByRuleIdForSDCampaigns

func NewGetCampaignRequest

func NewGetCampaignRequest(server string, campaignId int64, params *GetCampaignParams) (*http.Request, error)

NewGetCampaignRequest generates requests for GetCampaign

func NewGetCampaignResponseExRequest

func NewGetCampaignResponseExRequest(server string, campaignId int64, params *GetCampaignResponseExParams) (*http.Request, error)

NewGetCampaignResponseExRequest generates requests for GetCampaignResponseEx

func NewGetNegativeTargetsExRequest

func NewGetNegativeTargetsExRequest(server string, negativeTargetId int64, params *GetNegativeTargetsExParams) (*http.Request, error)

NewGetNegativeTargetsExRequest generates requests for GetNegativeTargetsEx

func NewGetNegativeTargetsRequest

func NewGetNegativeTargetsRequest(server string, negativeTargetId int64, params *GetNegativeTargetsParams) (*http.Request, error)

NewGetNegativeTargetsRequest generates requests for GetNegativeTargets

func NewGetProductAdRequest

func NewGetProductAdRequest(server string, adId int64, params *GetProductAdParams) (*http.Request, error)

NewGetProductAdRequest generates requests for GetProductAd

func NewGetProductAdResponseExRequest

func NewGetProductAdResponseExRequest(server string, adId int64, params *GetProductAdResponseExParams) (*http.Request, error)

NewGetProductAdResponseExRequest generates requests for GetProductAdResponseEx

func NewGetReportStatusRequest

func NewGetReportStatusRequest(server string, reportId string, params *GetReportStatusParams) (*http.Request, error)

NewGetReportStatusRequest generates requests for GetReportStatus

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 NewGetSDBudgetRulesForAdvertiserRequest

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

NewGetSDBudgetRulesForAdvertiserRequest generates requests for GetSDBudgetRulesForAdvertiser

func NewGetSdAdGroupsAdGroupIdOptimizationRulesRequest

func NewGetSdAdGroupsAdGroupIdOptimizationRulesRequest(server string, adGroupId int64, params *GetSdAdGroupsAdGroupIdOptimizationRulesParams) (*http.Request, error)

NewGetSdAdGroupsAdGroupIdOptimizationRulesRequest generates requests for GetSdAdGroupsAdGroupIdOptimizationRules

func NewGetSdOptimizationRulesOptimizationRuleIdRequest

func NewGetSdOptimizationRulesOptimizationRuleIdRequest(server string, optimizationRuleId string, params *GetSdOptimizationRulesOptimizationRuleIdParams) (*http.Request, error)

NewGetSdOptimizationRulesOptimizationRuleIdRequest generates requests for GetSdOptimizationRulesOptimizationRuleId

func NewGetSnapshotRequest

func NewGetSnapshotRequest(server string, snapshotId string, params *GetSnapshotParams) (*http.Request, error)

NewGetSnapshotRequest generates requests for GetSnapshot

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 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 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 NewGetTargetsExRequest

func NewGetTargetsExRequest(server string, targetId int64, params *GetTargetsExParams) (*http.Request, error)

NewGetTargetsExRequest generates requests for GetTargetsEx

func NewGetTargetsRequest

func NewGetTargetsRequest(server string, targetId int64, params *GetTargetsParams) (*http.Request, error)

NewGetTargetsRequest generates requests for GetTargets

func NewListAdGroupsExRequest

func NewListAdGroupsExRequest(server string, params *ListAdGroupsExParams) (*http.Request, error)

NewListAdGroupsExRequest generates requests for ListAdGroupsEx

func NewListAdGroupsRequest

func NewListAdGroupsRequest(server string, params *ListAdGroupsParams) (*http.Request, error)

NewListAdGroupsRequest generates requests for ListAdGroups

func NewListCampaignsExRequest

func NewListCampaignsExRequest(server string, params *ListCampaignsExParams) (*http.Request, error)

NewListCampaignsExRequest generates requests for ListCampaignsEx

func NewListCampaignsRequest

func NewListCampaignsRequest(server string, params *ListCampaignsParams) (*http.Request, error)

NewListCampaignsRequest generates requests for ListCampaigns

func NewListCreativeModerationsRequest

func NewListCreativeModerationsRequest(server string, params *ListCreativeModerationsParams) (*http.Request, error)

NewListCreativeModerationsRequest generates requests for ListCreativeModerations

func NewListCreativesRequest

func NewListCreativesRequest(server string, params *ListCreativesParams) (*http.Request, error)

NewListCreativesRequest generates requests for ListCreatives

func NewListDomainsRequest

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

NewListDomainsRequest generates requests for ListDomains

func NewListLocationsRequest

func NewListLocationsRequest(server string, params *ListLocationsParams) (*http.Request, error)

NewListLocationsRequest generates requests for ListLocations

func NewListNegativeTargetingClausesExRequest

func NewListNegativeTargetingClausesExRequest(server string, params *ListNegativeTargetingClausesExParams) (*http.Request, error)

NewListNegativeTargetingClausesExRequest generates requests for ListNegativeTargetingClausesEx

func NewListNegativeTargetingClausesRequest

func NewListNegativeTargetingClausesRequest(server string, params *ListNegativeTargetingClausesParams) (*http.Request, error)

NewListNegativeTargetingClausesRequest generates requests for ListNegativeTargetingClauses

func NewListOptimizationRulesRequest

func NewListOptimizationRulesRequest(server string, params *ListOptimizationRulesParams) (*http.Request, error)

NewListOptimizationRulesRequest generates requests for ListOptimizationRules

func NewListProductAdsExRequest

func NewListProductAdsExRequest(server string, params *ListProductAdsExParams) (*http.Request, error)

NewListProductAdsExRequest generates requests for ListProductAdsEx

func NewListProductAdsRequest

func NewListProductAdsRequest(server string, params *ListProductAdsParams) (*http.Request, error)

NewListProductAdsRequest generates requests for ListProductAds

func NewListRequestStatusRequest

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

NewListRequestStatusRequest generates requests for ListRequestStatus

func NewListTargetingClausesExRequest

func NewListTargetingClausesExRequest(server string, params *ListTargetingClausesExParams) (*http.Request, error)

NewListTargetingClausesExRequest generates requests for ListTargetingClausesEx

func NewListTargetingClausesRequest

func NewListTargetingClausesRequest(server string, params *ListTargetingClausesParams) (*http.Request, error)

NewListTargetingClausesRequest generates requests for ListTargetingClauses

func NewPostCreativePreviewRequest

func NewPostCreativePreviewRequest(server string, params *PostCreativePreviewParams, body PostCreativePreviewJSONRequestBody) (*http.Request, error)

NewPostCreativePreviewRequest calls the generic PostCreativePreview builder with application/json body

func NewPostCreativePreviewRequestWithBody

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

NewPostCreativePreviewRequestWithBody generates requests for PostCreativePreview with any type of body

func NewRequestReportRequest

func NewRequestReportRequest(server string, recordType RequestReportParamsRecordType, params *RequestReportParams, body RequestReportJSONRequestBody) (*http.Request, error)

NewRequestReportRequest calls the generic RequestReport builder with application/json body

func NewRequestReportRequestWithBody

func NewRequestReportRequestWithBody(server string, recordType RequestReportParamsRecordType, params *RequestReportParams, contentType string, body io.Reader) (*http.Request, error)

NewRequestReportRequestWithBody generates requests for RequestReport with any type of body

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 NewUpdateAdGroupsRequest

func NewUpdateAdGroupsRequest(server string, params *UpdateAdGroupsParams, body UpdateAdGroupsJSONRequestBody) (*http.Request, error)

NewUpdateAdGroupsRequest calls the generic UpdateAdGroups builder with application/json body

func NewUpdateAdGroupsRequestWithBody

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

NewUpdateAdGroupsRequestWithBody generates requests for UpdateAdGroups 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

func NewUpdateCampaignsRequest

func NewUpdateCampaignsRequest(server string, params *UpdateCampaignsParams, body UpdateCampaignsJSONRequestBody) (*http.Request, error)

NewUpdateCampaignsRequest calls the generic UpdateCampaigns builder with application/json body

func NewUpdateCampaignsRequestWithBody

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

NewUpdateCampaignsRequestWithBody generates requests for UpdateCampaigns with any type of body

func NewUpdateCreativesRequest

func NewUpdateCreativesRequest(server string, params *UpdateCreativesParams, body UpdateCreativesJSONRequestBody) (*http.Request, error)

NewUpdateCreativesRequest calls the generic UpdateCreatives builder with application/json body

func NewUpdateCreativesRequestWithBody

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

NewUpdateCreativesRequestWithBody generates requests for UpdateCreatives with any type of body

func NewUpdateNegativeTargetingClausesRequest

func NewUpdateNegativeTargetingClausesRequest(server string, params *UpdateNegativeTargetingClausesParams, body UpdateNegativeTargetingClausesJSONRequestBody) (*http.Request, error)

NewUpdateNegativeTargetingClausesRequest calls the generic UpdateNegativeTargetingClauses builder with application/json body

func NewUpdateNegativeTargetingClausesRequestWithBody

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

NewUpdateNegativeTargetingClausesRequestWithBody generates requests for UpdateNegativeTargetingClauses with any type of body

func NewUpdateOptimizationRulesRequest

func NewUpdateOptimizationRulesRequest(server string, params *UpdateOptimizationRulesParams, body UpdateOptimizationRulesJSONRequestBody) (*http.Request, error)

NewUpdateOptimizationRulesRequest calls the generic UpdateOptimizationRules builder with application/json body

func NewUpdateOptimizationRulesRequestWithBody

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

NewUpdateOptimizationRulesRequestWithBody generates requests for UpdateOptimizationRules with any type of body

func NewUpdateProductAdsRequest

func NewUpdateProductAdsRequest(server string, params *UpdateProductAdsParams, body UpdateProductAdsJSONRequestBody) (*http.Request, error)

NewUpdateProductAdsRequest calls the generic UpdateProductAds builder with application/json body

func NewUpdateProductAdsRequestWithBody

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

NewUpdateProductAdsRequestWithBody generates requests for UpdateProductAds with any type of body

func NewUpdateTargetingClausesRequest

func NewUpdateTargetingClausesRequest(server string, params *UpdateTargetingClausesParams, body UpdateTargetingClausesJSONRequestBody) (*http.Request, error)

NewUpdateTargetingClausesRequest calls the generic UpdateTargetingClauses builder with application/json body

func NewUpdateTargetingClausesRequestWithBody

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

NewUpdateTargetingClausesRequestWithBody generates requests for UpdateTargetingClauses with any type of body

Types

type AdGroup

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

	// BidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.
	// |Name|CostType|Description|
	// |----|--------|-----------|
	// |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks |cpc|[Default] Optimize for page visits.|
	// |conversions |cpc|Optimize for conversion.|
	BidOptimization *AdGroupBidOptimization `json:"bidOptimization,omitempty"`

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

	// CreativeType The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|
	CreativeType *CreativeType `json:"creativeType"`

	// DefaultBid The amount of the default bid associated with the ad group. Used if no bid is specified.
	DefaultBid *float64 `json:"defaultBid,omitempty"`

	// Name The name of the ad group.
	Name *string `json:"name,omitempty"`

	// State The state of the ad group.
	State *AdGroupState `json:"state,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *Tactic `json:"tactic,omitempty"`
}

AdGroup defines model for AdGroup.

type AdGroupBidOptimization

type AdGroupBidOptimization string

AdGroupBidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks. |Name|CostType|Description| |----|--------|-----------| |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks |cpc|[Default] Optimize for page visits.| |conversions |cpc|Optimize for conversion.|

const (
	AdGroupBidOptimizationClicks      AdGroupBidOptimization = "clicks"
	AdGroupBidOptimizationConversions AdGroupBidOptimization = "conversions"
	AdGroupBidOptimizationReach       AdGroupBidOptimization = "reach"
)

Defines values for AdGroupBidOptimization.

type AdGroupId

type AdGroupId = int64

AdGroupId The identifier of the ad group.

type AdGroupResponse

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

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

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

AdGroupResponse defines model for AdGroupResponse.

type AdGroupResponseEx

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

	// BidOptimization Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach and clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK.
	// |Name|CostType|Description|
	// |----|--------|-----------|
	// |reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks [Default]|cpc|Optimize for page visits.|
	// |conversions|cpc|Optimize for conversion.|
	// |leads |cpc| [PREVIEW ONLY] Optimize for lead generation.|
	BidOptimization *AdGroupResponseExBidOptimization `json:"bidOptimization,omitempty"`

	// CampaignId The identifier of the campaign that this ad group is associated with.
	CampaignId *float32 `json:"campaignId,omitempty"`

	// CreationDate Epoch time the ad group was created.
	CreationDate *int64 `json:"creationDate,omitempty"`

	// CreativeType
	// The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided.|
	CreativeType *CreativeTypeInCreativeResponse `json:"creativeType,omitempty"`

	// DefaultBid The amount of the default bid associated with the ad group. Used if no bid is specified.
	DefaultBid *float64 `json:"defaultBid,omitempty"`

	// LastUpdatedDate Epoch time any property in the ad group was last updated.
	LastUpdatedDate *int64 `json:"lastUpdatedDate,omitempty"`

	// Name The name of the ad group.
	Name *string `json:"name,omitempty"`

	// ServingStatus The status of the ad group.
	ServingStatus *AdGroupResponseExServingStatus `json:"servingStatus,omitempty"`

	// State The delivery state of the ad group.
	State *AdGroupResponseExState `json:"state,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *Tactic `json:"tactic,omitempty"`
}

AdGroupResponseEx Object containing an extended set of data fields for an Ad Group.

type AdGroupResponseExBidOptimization

type AdGroupResponseExBidOptimization string

AdGroupResponseExBidOptimization Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach and clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK. |Name|CostType|Description| |----|--------|-----------| |reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks [Default]|cpc|Optimize for page visits.| |conversions|cpc|Optimize for conversion.| |leads |cpc| [PREVIEW ONLY] Optimize for lead generation.|

const (
	AdGroupResponseExBidOptimizationClicks      AdGroupResponseExBidOptimization = "clicks"
	AdGroupResponseExBidOptimizationConversions AdGroupResponseExBidOptimization = "conversions"
	AdGroupResponseExBidOptimizationReach       AdGroupResponseExBidOptimization = "reach"
)

Defines values for AdGroupResponseExBidOptimization.

type AdGroupResponseExServingStatus

type AdGroupResponseExServingStatus string

AdGroupResponseExServingStatus The status of the ad group.

const (
	AdGroupResponseExServingStatusACCOUNTOUTOFBUDGET              AdGroupResponseExServingStatus = "ACCOUNT_OUT_OF_BUDGET"
	AdGroupResponseExServingStatusADGROUPARCHIVED                 AdGroupResponseExServingStatus = "AD_GROUP_ARCHIVED"
	AdGroupResponseExServingStatusADGROUPINCOMPLETE               AdGroupResponseExServingStatus = "AD_GROUP_INCOMPLETE"
	AdGroupResponseExServingStatusADGROUPLOWBID                   AdGroupResponseExServingStatus = "AD_GROUP_LOW_BID"
	AdGroupResponseExServingStatusADGROUPPAUSED                   AdGroupResponseExServingStatus = "AD_GROUP_PAUSED"
	AdGroupResponseExServingStatusADGROUPPOLICINGCREATIVEREJECTED AdGroupResponseExServingStatus = "ADGROUP_POLICING_CREATIVE_REJECTED"
	AdGroupResponseExServingStatusADGROUPPOLICINGPENDINGREVIEW    AdGroupResponseExServingStatus = "ADGROUP_POLICING_PENDING_REVIEW"
	AdGroupResponseExServingStatusADGROUPSTATUSENABLED            AdGroupResponseExServingStatus = "AD_GROUP_STATUS_ENABLED"
	AdGroupResponseExServingStatusADPOLICINGPENDINGREVIEW         AdGroupResponseExServingStatus = "AD_POLICING_PENDING_REVIEW"
	AdGroupResponseExServingStatusADVERTISEREXCEEDSPENDSLIMIT     AdGroupResponseExServingStatus = "ADVERTISER_EXCEED_SPENDS_LIMIT"
	AdGroupResponseExServingStatusADVERTISERPAUSED                AdGroupResponseExServingStatus = "ADVERTISER_PAUSED"
	AdGroupResponseExServingStatusADVERTISERPAYMENTFAILURE        AdGroupResponseExServingStatus = "ADVERTISER_PAYMENT_FAILURE"
	AdGroupResponseExServingStatusADVERTISERSTATUSENABLED         AdGroupResponseExServingStatus = "ADVERTISER_STATUS_ENABLED"
	AdGroupResponseExServingStatusCAMPAIGNARCHIVED                AdGroupResponseExServingStatus = "CAMPAIGN_ARCHIVED"
	AdGroupResponseExServingStatusCAMPAIGNINCOMPLETE              AdGroupResponseExServingStatus = "CAMPAIGN_INCOMPLETE"
	AdGroupResponseExServingStatusCAMPAIGNOUTOFBUDGET             AdGroupResponseExServingStatus = "CAMPAIGN_OUT_OF_BUDGET"
	AdGroupResponseExServingStatusCAMPAIGNPAUSED                  AdGroupResponseExServingStatus = "CAMPAIGN_PAUSED"
	AdGroupResponseExServingStatusENDED                           AdGroupResponseExServingStatus = "ENDED"
	AdGroupResponseExServingStatusINELIGIBLE                      AdGroupResponseExServingStatus = "INELIGIBLE"
	AdGroupResponseExServingStatusPENDINGSTARTDATE                AdGroupResponseExServingStatus = "PENDING_START_DATE"
	AdGroupResponseExServingStatusPORTFOLIOENDED                  AdGroupResponseExServingStatus = "PORTFOLIO_ENDED"
	AdGroupResponseExServingStatusPORTFOLIOOUTOFBUDGET            AdGroupResponseExServingStatus = "PORTFOLIO_OUT_OF_BUDGET"
	AdGroupResponseExServingStatusSTATUSUNAVAILABLE               AdGroupResponseExServingStatus = "STATUS_UNAVAILABLE"
)

Defines values for AdGroupResponseExServingStatus.

type AdGroupResponseExState

type AdGroupResponseExState string

AdGroupResponseExState The delivery state of the ad group.

const (
	AdGroupResponseExStateArchived AdGroupResponseExState = "archived"
	AdGroupResponseExStateEnabled  AdGroupResponseExState = "enabled"
	AdGroupResponseExStatePaused   AdGroupResponseExState = "paused"
)

Defines values for AdGroupResponseExState.

type AdGroupState

type AdGroupState string

AdGroupState The state of the ad group.

const (
	AdGroupStateArchived AdGroupState = "archived"
	AdGroupStateEnabled  AdGroupState = "enabled"
	AdGroupStatePaused   AdGroupState = "paused"
)

Defines values for AdGroupState.

type AdId

type AdId = int64

AdId The identifier of the product ad.

type AdName

type AdName = string

AdName The name of the ad. Note that this field is not supported when using ASIN or SKU fields.

type ArchiveAdGroupParams

type ArchiveAdGroupParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ArchiveAdGroupParams defines parameters for ArchiveAdGroup.

type ArchiveAdGroupResp

type ArchiveAdGroupResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdGroupResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseArchiveAdGroupResp

func ParseArchiveAdGroupResp(rsp *http.Response) (*ArchiveAdGroupResp, error)

ParseArchiveAdGroupResp parses an HTTP response from a ArchiveAdGroupWithResponse call

func (ArchiveAdGroupResp) Status

func (r ArchiveAdGroupResp) Status() string

Status returns HTTPResponse.Status

func (ArchiveAdGroupResp) StatusCode

func (r ArchiveAdGroupResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveCampaignParams

type ArchiveCampaignParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ArchiveCampaignParams defines parameters for ArchiveCampaign.

type ArchiveCampaignResp

type ArchiveCampaignResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CampaignResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseArchiveCampaignResp

func ParseArchiveCampaignResp(rsp *http.Response) (*ArchiveCampaignResp, error)

ParseArchiveCampaignResp parses an HTTP response from a ArchiveCampaignWithResponse call

func (ArchiveCampaignResp) Status

func (r ArchiveCampaignResp) Status() string

Status returns HTTPResponse.Status

func (ArchiveCampaignResp) StatusCode

func (r ArchiveCampaignResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveNegativeTargetingClauseParams

type ArchiveNegativeTargetingClauseParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ArchiveNegativeTargetingClauseParams defines parameters for ArchiveNegativeTargetingClause.

type ArchiveNegativeTargetingClauseResp

type ArchiveNegativeTargetingClauseResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseArchiveNegativeTargetingClauseResp

func ParseArchiveNegativeTargetingClauseResp(rsp *http.Response) (*ArchiveNegativeTargetingClauseResp, error)

ParseArchiveNegativeTargetingClauseResp parses an HTTP response from a ArchiveNegativeTargetingClauseWithResponse call

func (ArchiveNegativeTargetingClauseResp) Status

Status returns HTTPResponse.Status

func (ArchiveNegativeTargetingClauseResp) StatusCode

func (r ArchiveNegativeTargetingClauseResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveProductAdParams

type ArchiveProductAdParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ArchiveProductAdParams defines parameters for ArchiveProductAd.

type ArchiveProductAdResp

type ArchiveProductAdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ProductAdResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseArchiveProductAdResp

func ParseArchiveProductAdResp(rsp *http.Response) (*ArchiveProductAdResp, error)

ParseArchiveProductAdResp parses an HTTP response from a ArchiveProductAdWithResponse call

func (ArchiveProductAdResp) Status

func (r ArchiveProductAdResp) Status() string

Status returns HTTPResponse.Status

func (ArchiveProductAdResp) StatusCode

func (r ArchiveProductAdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveTargetingClauseParams

type ArchiveTargetingClauseParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ArchiveTargetingClauseParams defines parameters for ArchiveTargetingClause.

type ArchiveTargetingClauseResp

type ArchiveTargetingClauseResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseArchiveTargetingClauseResp

func ParseArchiveTargetingClauseResp(rsp *http.Response) (*ArchiveTargetingClauseResp, error)

ParseArchiveTargetingClauseResp parses an HTTP response from a ArchiveTargetingClauseWithResponse call

func (ArchiveTargetingClauseResp) Status

Status returns HTTPResponse.Status

func (ArchiveTargetingClauseResp) StatusCode

func (r ArchiveTargetingClauseResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssociateOptimizationRulesWithAdGroupJSONRequestBody

type AssociateOptimizationRulesWithAdGroupJSONRequestBody = CreateAssociatedOptimizationRulesRequest

AssociateOptimizationRulesWithAdGroupJSONRequestBody defines body for AssociateOptimizationRulesWithAdGroup for application/json ContentType.

type AssociateOptimizationRulesWithAdGroupParams

type AssociateOptimizationRulesWithAdGroupParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

AssociateOptimizationRulesWithAdGroupParams defines parameters for AssociateOptimizationRulesWithAdGroup.

type AssociateOptimizationRulesWithAdGroupResp

type AssociateOptimizationRulesWithAdGroupResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]OptimizationRuleResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseAssociateOptimizationRulesWithAdGroupResp

func ParseAssociateOptimizationRulesWithAdGroupResp(rsp *http.Response) (*AssociateOptimizationRulesWithAdGroupResp, error)

ParseAssociateOptimizationRulesWithAdGroupResp parses an HTTP response from a AssociateOptimizationRulesWithAdGroupWithResponse call

func (AssociateOptimizationRulesWithAdGroupResp) Status

Status returns HTTPResponse.Status

func (AssociateOptimizationRulesWithAdGroupResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type BaseAdGroup

type BaseAdGroup struct {
	// BidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.
	// |Name|CostType|Description|
	// |----|--------|-----------|
	// |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks |cpc|[Default] Optimize for page visits.|
	// |conversions |cpc|Optimize for conversion.|
	BidOptimization *BaseAdGroupBidOptimization `json:"bidOptimization,omitempty"`

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

	// DefaultBid The amount of the default bid associated with the ad group. Used if no bid is specified.
	DefaultBid *float64 `json:"defaultBid,omitempty"`

	// Name The name of the ad group.
	Name *string `json:"name,omitempty"`

	// State The state of the ad group.
	State *BaseAdGroupState `json:"state,omitempty"`
}

BaseAdGroup defines model for BaseAdGroup.

type BaseAdGroupBidOptimization

type BaseAdGroupBidOptimization string

BaseAdGroupBidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks. |Name|CostType|Description| |----|--------|-----------| |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks |cpc|[Default] Optimize for page visits.| |conversions |cpc|Optimize for conversion.|

const (
	BaseAdGroupBidOptimizationClicks      BaseAdGroupBidOptimization = "clicks"
	BaseAdGroupBidOptimizationConversions BaseAdGroupBidOptimization = "conversions"
	BaseAdGroupBidOptimizationReach       BaseAdGroupBidOptimization = "reach"
)

Defines values for BaseAdGroupBidOptimization.

type BaseAdGroupState

type BaseAdGroupState string

BaseAdGroupState The state of the ad group.

const (
	BaseAdGroupStateArchived BaseAdGroupState = "archived"
	BaseAdGroupStateEnabled  BaseAdGroupState = "enabled"
	BaseAdGroupStatePaused   BaseAdGroupState = "paused"
)

Defines values for BaseAdGroupState.

type BaseCampaign

type BaseCampaign struct {
	// Budget The amount of the budget.
	Budget *float64 `json:"budget,omitempty"`

	// BudgetType The time period over which the amount specified in the `budget` property is allocated.
	BudgetType *BaseCampaignBudgetType `json:"budgetType,omitempty"`

	// CostType Determines how the campaign will bid and charge.
	// |Name|Description|
	// |----|----------|
	// |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|
	// |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |
	//
	// To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).
	CostType *BaseCampaignCostType `json:"costType,omitempty"`

	// EndDate The YYYYMMDD end date of the campaign.
	EndDate *string `json:"endDate"`

	// Name The name of the campaign.
	Name *string `json:"name,omitempty"`

	// PortfolioId Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.
	PortfolioId *int64 `json:"portfolioId"`

	// StartDate The YYYYMMDD start date of the campaign. The date must be today or in the future.
	StartDate *string `json:"startDate,omitempty"`

	// State The state of the campaign.
	State *BaseCampaignState `json:"state,omitempty"`
}

BaseCampaign defines model for BaseCampaign.

type BaseCampaignBudgetType

type BaseCampaignBudgetType string

BaseCampaignBudgetType The time period over which the amount specified in the `budget` property is allocated.

const (
	BaseCampaignBudgetTypeDaily BaseCampaignBudgetType = "daily"
)

Defines values for BaseCampaignBudgetType.

type BaseCampaignCostType

type BaseCampaignCostType string

BaseCampaignCostType Determines how the campaign will bid and charge. |Name|Description| |----|----------| |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.| |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |

To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).

const (
	BaseCampaignCostTypeCpc  BaseCampaignCostType = "cpc"
	BaseCampaignCostTypeVcpm BaseCampaignCostType = "vcpm"
)

Defines values for BaseCampaignCostType.

type BaseCampaignState

type BaseCampaignState string

BaseCampaignState The state of the campaign.

const (
	BaseCampaignStateArchived BaseCampaignState = "archived"
	BaseCampaignStateEnabled  BaseCampaignState = "enabled"
	BaseCampaignStatePaused   BaseCampaignState = "paused"
)

Defines values for BaseCampaignState.

type BaseLocation

type BaseLocation struct {
	State *BaseLocationState `json:"state,omitempty"`
}

BaseLocation defines model for BaseLocation.

type BaseLocationState

type BaseLocationState string

BaseLocationState defines model for BaseLocation.State.

const (
	BaseLocationStateEnabled BaseLocationState = "enabled"
)

Defines values for BaseLocationState.

type BaseNegativeTargetingClause

type BaseNegativeTargetingClause struct {
	State *BaseNegativeTargetingClauseState `json:"state,omitempty"`
}

BaseNegativeTargetingClause defines model for BaseNegativeTargetingClause.

type BaseNegativeTargetingClauseState

type BaseNegativeTargetingClauseState string

BaseNegativeTargetingClauseState defines model for BaseNegativeTargetingClause.State.

const (
	BaseNegativeTargetingClauseStateArchived BaseNegativeTargetingClauseState = "archived"
	BaseNegativeTargetingClauseStateEnabled  BaseNegativeTargetingClauseState = "enabled"
	BaseNegativeTargetingClauseStatePaused   BaseNegativeTargetingClauseState = "paused"
)

Defines values for BaseNegativeTargetingClauseState.

type BaseOptimizationRule

type BaseOptimizationRule struct {
	// RuleConditions A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.
	RuleConditions *[]RuleCondition `json:"ruleConditions,omitempty"`

	// RuleName The name of the optimization rule.
	RuleName *string `json:"ruleName,omitempty"`

	// State The state of the optimization rule.
	State *BaseOptimizationRuleState `json:"state,omitempty"`
}

BaseOptimizationRule defines model for BaseOptimizationRule.

type BaseOptimizationRuleState

type BaseOptimizationRuleState string

BaseOptimizationRuleState The state of the optimization rule.

const (
	BaseOptimizationRuleStateEnabled           BaseOptimizationRuleState = "enabled"
	BaseOptimizationRuleStatePausedCOMINGLATER BaseOptimizationRuleState = "paused [COMING LATER]"
)

Defines values for BaseOptimizationRuleState.

type BaseProductAd

type BaseProductAd struct {
	// State The state of the campaign associated with the product ad.
	State *BaseProductAdState `json:"state,omitempty"`
}

BaseProductAd defines model for BaseProductAd.

type BaseProductAdState

type BaseProductAdState string

BaseProductAdState The state of the campaign associated with the product ad.

const (
	BaseProductAdStateArchived BaseProductAdState = "archived"
	BaseProductAdStateEnabled  BaseProductAdState = "enabled"
	BaseProductAdStatePaused   BaseProductAdState = "paused"
)

Defines values for BaseProductAdState.

type BaseTargetingClause

type BaseTargetingClause struct {
	// Bid The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the ["Bid constraints by marketplace" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.
	Bid   *float32                  `json:"bid"`
	State *BaseTargetingClauseState `json:"state,omitempty"`
}

BaseTargetingClause defines model for BaseTargetingClause.

type BaseTargetingClauseState

type BaseTargetingClauseState string

BaseTargetingClauseState defines model for BaseTargetingClause.State.

const (
	BaseTargetingClauseStateArchived BaseTargetingClauseState = "archived"
	BaseTargetingClauseStateEnabled  BaseTargetingClauseState = "enabled"
	BaseTargetingClauseStatePaused   BaseTargetingClauseState = "paused"
)

Defines values for BaseTargetingClauseState.

type BrandSafetyDenyListDomain

type BrandSafetyDenyListDomain 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 BrandSafetyDenyListDomainType `json:"type"`
}

BrandSafetyDenyListDomain defines model for BrandSafetyDenyListDomain.

type BrandSafetyDenyListDomainState

type BrandSafetyDenyListDomainState string

BrandSafetyDenyListDomainState The state of the domain.

const (
	ARCHIVED BrandSafetyDenyListDomainState = "ARCHIVED"
	ENABLED  BrandSafetyDenyListDomainState = "ENABLED"
)

Defines values for BrandSafetyDenyListDomainState.

type BrandSafetyDenyListDomainType

type BrandSafetyDenyListDomainType string

BrandSafetyDenyListDomainType The domain type.

const (
	APP     BrandSafetyDenyListDomainType = "APP"
	WEBSITE BrandSafetyDenyListDomainType = "WEBSITE"
)

Defines values for BrandSafetyDenyListDomainType.

type BrandSafetyDenyListDomainUpdateResultStatus

type BrandSafetyDenyListDomainUpdateResultStatus string

BrandSafetyDenyListDomainUpdateResultStatus The state of the domain.

const (
	BrandSafetyDenyListDomainUpdateResultStatusFAILURE BrandSafetyDenyListDomainUpdateResultStatus = "FAILURE"
	BrandSafetyDenyListDomainUpdateResultStatusSUCCESS BrandSafetyDenyListDomainUpdateResultStatus = "SUCCESS"
)

Defines values for BrandSafetyDenyListDomainUpdateResultStatus.

type BrandSafetyDenyListProcessedDomain

type BrandSafetyDenyListProcessedDomain 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 *BrandSafetyDenyListDomainState `json:"state,omitempty"`

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

BrandSafetyDenyListProcessedDomain defines model for BrandSafetyDenyListProcessedDomain.

type BrandSafetyGetResponse

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

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

BrandSafetyGetResponse Response for Brand Safety Deny List GET requests

type BrandSafetyGetResponsePagination

type BrandSafetyGetResponsePagination 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"`
}

BrandSafetyGetResponsePagination Response pagination info for Brand Safety Deny List GET requests

type BrandSafetyListRequestStatusResponse

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

BrandSafetyListRequestStatusResponse List of all requests' status.

type BrandSafetyPostRequest

type BrandSafetyPostRequest struct {
	Domains []BrandSafetyDenyListDomain `json:"domains"`
}

BrandSafetyPostRequest POST Request for Brand Safety

type BrandSafetyRequestResult

type BrandSafetyRequestResult 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 *BrandSafetyDenyListDomainUpdateResultStatus `json:"status,omitempty"`
}

BrandSafetyRequestResult defines model for BrandSafetyRequestResult.

type BrandSafetyRequestResultsResponse

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

BrandSafetyRequestResultsResponse defines model for BrandSafetyRequestResultsResponse.

type BrandSafetyRequestStatus

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

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

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

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

BrandSafetyRequestStatus defines model for BrandSafetyRequestStatus.

type BrandSafetyRequestStatusResponse

type BrandSafetyRequestStatusResponse struct {
	RequestStatus *BrandSafetyRequestStatus `json:"requestStatus,omitempty"`
}

BrandSafetyRequestStatusResponse The status of the request.

type BrandSafetyRequestStatusStatus

type BrandSafetyRequestStatusStatus string

BrandSafetyRequestStatusStatus The status of the request

const (
	BrandSafetyRequestStatusStatusCOMPLETED  BrandSafetyRequestStatusStatus = "COMPLETED"
	BrandSafetyRequestStatusStatusFAILURE    BrandSafetyRequestStatusStatus = "FAILURE"
	BrandSafetyRequestStatusStatusINPROGRESS BrandSafetyRequestStatusStatus = "IN_PROGRESS"
)

Defines values for BrandSafetyRequestStatusStatus.

type BrandSafetyUpdateResponse

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

BrandSafetyUpdateResponse Response for Brand Safety POST and DELETE requests

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 Campaign

type Campaign struct {
	// Budget The amount of the budget.
	Budget *float64 `json:"budget,omitempty"`

	// BudgetType The time period over which the amount specified in the `budget` property is allocated.
	BudgetType *CampaignBudgetType `json:"budgetType,omitempty"`

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

	// CostType Determines how the campaign will bid and charge.
	// |Name|Description|
	// |----|----------|
	// |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|
	// |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |
	//
	// To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).
	CostType        *CampaignCostType        `json:"costType,omitempty"`
	DeliveryProfile *CampaignDeliveryProfile `json:"deliveryProfile,omitempty"`

	// EndDate The YYYYMMDD end date of the campaign.
	EndDate *string `json:"endDate"`

	// Name The name of the campaign.
	Name *string `json:"name,omitempty"`

	// PortfolioId Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.
	PortfolioId     *int64           `json:"portfolioId"`
	RuleBasedBudget *RuleBasedBudget `json:"ruleBasedBudget,omitempty"`

	// StartDate The YYYYMMDD start date of the campaign. The date must be today or in the future.
	StartDate *string `json:"startDate,omitempty"`

	// State The state of the campaign.
	State *CampaignState `json:"state,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *Tactic `json:"tactic,omitempty"`
}

Campaign defines model for Campaign.

type CampaignBudgetType

type CampaignBudgetType string

CampaignBudgetType The time period over which the amount specified in the `budget` property is allocated.

const (
	CampaignBudgetTypeDaily CampaignBudgetType = "daily"
)

Defines values for CampaignBudgetType.

type CampaignCostType

type CampaignCostType string

CampaignCostType Determines how the campaign will bid and charge. |Name|Description| |----|----------| |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.| |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |

To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).

const (
	CampaignCostTypeCpc  CampaignCostType = "cpc"
	CampaignCostTypeVcpm CampaignCostType = "vcpm"
)

Defines values for CampaignCostType.

type CampaignDeliveryProfile

type CampaignDeliveryProfile string

CampaignDeliveryProfile defines model for Campaign.DeliveryProfile.

const (
	AsSoonAsPossible CampaignDeliveryProfile = "as_soon_as_possible"
)

Defines values for CampaignDeliveryProfile.

type CampaignId

type CampaignId = int64

CampaignId The identifier of the campaign.

type CampaignResponse

type CampaignResponse struct {
	// CampaignId The identifier of the campaign.
	CampaignId *CampaignId `json:"campaignId,omitempty"`

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

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

CampaignResponse defines model for CampaignResponse.

type CampaignResponseEx

type CampaignResponseEx struct {
	// Budget The amount of the budget.
	Budget *float64 `json:"budget,omitempty"`

	// BudgetType The time period over which the amount specified in the `budget` property is allocated.
	BudgetType *CampaignResponseExBudgetType `json:"budgetType,omitempty"`

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

	// CostType Determines how the campaign will bid and charge.
	// |Name|Description|
	// |----|----------|-----------|
	// |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|
	// |vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|
	CostType *CampaignResponseExCostType `json:"costType,omitempty"`

	// CreationDate Epoch date the campaign was created.
	CreationDate *int64 `json:"creationDate,omitempty"`

	// EndDate The YYYYMMDD end date of the campaign.
	EndDate *string `json:"endDate,omitempty"`

	// LastUpdatedDate Epoch date of the last update to any property associated with the campaign.
	LastUpdatedDate *int64 `json:"lastUpdatedDate,omitempty"`

	// Name The name of the campaign.
	Name *string `json:"name,omitempty"`

	// PortfolioId Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.
	PortfolioId     *int64           `json:"portfolioId,omitempty"`
	RuleBasedBudget *RuleBasedBudget `json:"ruleBasedBudget,omitempty"`

	// ServingStatus The status of the campaign.
	ServingStatus *CampaignResponseExServingStatus `json:"servingStatus,omitempty"`

	// StartDate The YYYYMMDD start date of the campaign. The date must be today or in the future.
	StartDate *string `json:"startDate,omitempty"`

	// State The state of the campaign.
	State *CampaignResponseExState `json:"state,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *Tactic `json:"tactic,omitempty"`
}

CampaignResponseEx defines model for CampaignResponseEx.

type CampaignResponseExBudgetType

type CampaignResponseExBudgetType string

CampaignResponseExBudgetType The time period over which the amount specified in the `budget` property is allocated.

const (
	CampaignResponseExBudgetTypeDaily CampaignResponseExBudgetType = "daily"
)

Defines values for CampaignResponseExBudgetType.

type CampaignResponseExCostType

type CampaignResponseExCostType string

CampaignResponseExCostType Determines how the campaign will bid and charge. |Name|Description| |----|----------|-----------| |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.| |vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|

const (
	CampaignResponseExCostTypeCpc  CampaignResponseExCostType = "cpc"
	CampaignResponseExCostTypeVcpm CampaignResponseExCostType = "vcpm"
)

Defines values for CampaignResponseExCostType.

type CampaignResponseExServingStatus

type CampaignResponseExServingStatus string

CampaignResponseExServingStatus The status of the campaign.

const (
	CampaignResponseExServingStatusACCOUNTOUTOFBUDGET          CampaignResponseExServingStatus = "ACCOUNT_OUT_OF_BUDGET"
	CampaignResponseExServingStatusADPOLICINGPENDINGREVIEW     CampaignResponseExServingStatus = "AD_POLICING_PENDING_REVIEW"
	CampaignResponseExServingStatusADVERTISEREXCEEDSPENDSLIMIT CampaignResponseExServingStatus = "ADVERTISER_EXCEED_SPENDS_LIMIT"
	CampaignResponseExServingStatusADVERTISERPAUSED            CampaignResponseExServingStatus = "ADVERTISER_PAUSED"
	CampaignResponseExServingStatusADVERTISERPAYMENTFAILURE    CampaignResponseExServingStatus = "ADVERTISER_PAYMENT_FAILURE"
	CampaignResponseExServingStatusADVERTISERSTATUSENABLED     CampaignResponseExServingStatus = "ADVERTISER_STATUS_ENABLED"
	CampaignResponseExServingStatusCAMPAIGNARCHIVED            CampaignResponseExServingStatus = "CAMPAIGN_ARCHIVED"
	CampaignResponseExServingStatusCAMPAIGNINCOMPLETE          CampaignResponseExServingStatus = "CAMPAIGN_INCOMPLETE"
	CampaignResponseExServingStatusCAMPAIGNOUTOFBUDGET         CampaignResponseExServingStatus = "CAMPAIGN_OUT_OF_BUDGET"
	CampaignResponseExServingStatusCAMPAIGNPAUSED              CampaignResponseExServingStatus = "CAMPAIGN_PAUSED"
	CampaignResponseExServingStatusENDED                       CampaignResponseExServingStatus = "ENDED"
	CampaignResponseExServingStatusINELIGIBLE                  CampaignResponseExServingStatus = "INELIGIBLE"
	CampaignResponseExServingStatusPENDINGSTARTDATE            CampaignResponseExServingStatus = "PENDING_START_DATE"
	CampaignResponseExServingStatusPORTFOLIOENDED              CampaignResponseExServingStatus = "PORTFOLIO_ENDED"
	CampaignResponseExServingStatusPORTFOLIOOUTOFBUDGET        CampaignResponseExServingStatus = "PORTFOLIO_OUT_OF_BUDGET"
	CampaignResponseExServingStatusSTATUSUNAVAILABLE           CampaignResponseExServingStatus = "STATUS_UNAVAILABLE"
)

Defines values for CampaignResponseExServingStatus.

type CampaignResponseExState

type CampaignResponseExState string

CampaignResponseExState The state of the campaign.

const (
	CampaignResponseExStateArchived CampaignResponseExState = "archived"
	CampaignResponseExStateEnabled  CampaignResponseExState = "enabled"
	CampaignResponseExStatePaused   CampaignResponseExState = "paused"
)

Defines values for CampaignResponseExState.

type CampaignState

type CampaignState string

CampaignState The state of the campaign.

const (
	CampaignStateArchived CampaignState = "archived"
	CampaignStateEnabled  CampaignState = "enabled"
	CampaignStatePaused   CampaignState = "paused"
)

Defines values for CampaignState.

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

func (c *Client) ArchiveAdGroup(ctx context.Context, adGroupId int64, params *ArchiveAdGroupParams) (*http.Response, error)

func (*Client) ArchiveCampaign

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

func (*Client) ArchiveNegativeTargetingClause

func (c *Client) ArchiveNegativeTargetingClause(ctx context.Context, negativeTargetId int64, params *ArchiveNegativeTargetingClauseParams) (*http.Response, error)

func (*Client) ArchiveProductAd

func (c *Client) ArchiveProductAd(ctx context.Context, adId int64, params *ArchiveProductAdParams) (*http.Response, error)

func (*Client) ArchiveTargetingClause

func (c *Client) ArchiveTargetingClause(ctx context.Context, targetId int64, params *ArchiveTargetingClauseParams) (*http.Response, error)

func (*Client) AssociateOptimizationRulesWithAdGroupWithBody

func (c *Client) AssociateOptimizationRulesWithAdGroupWithBody(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateAdGroups

func (c *Client) CreateAdGroups(ctx context.Context, params *CreateAdGroupsParams, body CreateAdGroupsJSONRequestBody) (*http.Response, error)

func (*Client) CreateAdGroupsWithBody

func (c *Client) CreateAdGroupsWithBody(ctx context.Context, params *CreateAdGroupsParams, 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) CreateCampaigns

func (c *Client) CreateCampaigns(ctx context.Context, params *CreateCampaignsParams, body CreateCampaignsJSONRequestBody) (*http.Response, error)

func (*Client) CreateCampaignsWithBody

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

func (*Client) CreateCreatives

func (c *Client) CreateCreatives(ctx context.Context, params *CreateCreativesParams, body CreateCreativesJSONRequestBody) (*http.Response, error)

func (*Client) CreateCreativesWithBody

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

func (*Client) CreateLocations

func (c *Client) CreateLocations(ctx context.Context, params *CreateLocationsParams, body CreateLocationsJSONRequestBody) (*http.Response, error)

func (*Client) CreateLocationsWithBody

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

func (*Client) CreateNegativeTargetingClausesWithBody

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

func (*Client) CreateOptimizationRulesWithBody

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

func (*Client) CreateProductAds

func (c *Client) CreateProductAds(ctx context.Context, params *CreateProductAdsParams, body CreateProductAdsJSONRequestBody) (*http.Response, error)

func (*Client) CreateProductAdsWithBody

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

func (*Client) CreateSDForecastWithBody

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

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, recordType string, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*http.Response, error)

func (*Client) CreateSnapshotWithBody

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

func (*Client) CreateTargetingClausesWithBody

func (c *Client) CreateTargetingClausesWithBody(ctx context.Context, params *CreateTargetingClausesParams, 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) DownloadReport

func (c *Client) DownloadReport(ctx context.Context, reportId string, params *DownloadReportParams) (*http.Response, error)

func (*Client) DownloadSnapshot

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

func (*Client) GetAdGroup

func (c *Client) GetAdGroup(ctx context.Context, adGroupId int64, params *GetAdGroupParams) (*http.Response, error)

func (*Client) GetAdGroupResponseEx

func (c *Client) GetAdGroupResponseEx(ctx context.Context, adGroupId int64, params *GetAdGroupResponseExParams) (*http.Response, error)

func (*Client) GetBudgetRuleByRuleIdForSDCampaigns

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

func (*Client) GetCampaign

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

func (*Client) GetCampaignResponseEx

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

func (*Client) GetNegativeTargets

func (c *Client) GetNegativeTargets(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsParams) (*http.Response, error)

func (*Client) GetNegativeTargetsEx

func (c *Client) GetNegativeTargetsEx(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsExParams) (*http.Response, error)

func (*Client) GetProductAd

func (c *Client) GetProductAd(ctx context.Context, adId int64, params *GetProductAdParams) (*http.Response, error)

func (*Client) GetProductAdResponseEx

func (c *Client) GetProductAdResponseEx(ctx context.Context, adId int64, params *GetProductAdResponseExParams) (*http.Response, error)

func (*Client) GetReportStatus

func (c *Client) GetReportStatus(ctx context.Context, reportId string, params *GetReportStatusParams) (*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) GetSDBudgetRulesForAdvertiser

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

func (*Client) GetSdAdGroupsAdGroupIdOptimizationRules

func (c *Client) GetSdAdGroupsAdGroupIdOptimizationRules(ctx context.Context, adGroupId int64, params *GetSdAdGroupsAdGroupIdOptimizationRulesParams) (*http.Response, error)

func (*Client) GetSdOptimizationRulesOptimizationRuleId

func (c *Client) GetSdOptimizationRulesOptimizationRuleId(ctx context.Context, optimizationRuleId string, params *GetSdOptimizationRulesOptimizationRuleIdParams) (*http.Response, error)

func (*Client) GetSnapshot

func (c *Client) GetSnapshot(ctx context.Context, snapshotId string, params *GetSnapshotParams) (*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) GetTargets

func (c *Client) GetTargets(ctx context.Context, targetId int64, params *GetTargetsParams) (*http.Response, error)

func (*Client) GetTargetsEx

func (c *Client) GetTargetsEx(ctx context.Context, targetId int64, params *GetTargetsExParams) (*http.Response, error)

func (*Client) ListAdGroups

func (c *Client) ListAdGroups(ctx context.Context, params *ListAdGroupsParams) (*http.Response, error)

func (*Client) ListAdGroupsEx

func (c *Client) ListAdGroupsEx(ctx context.Context, params *ListAdGroupsExParams) (*http.Response, error)

func (*Client) ListCampaigns

func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsParams) (*http.Response, error)

func (*Client) ListCampaignsEx

func (c *Client) ListCampaignsEx(ctx context.Context, params *ListCampaignsExParams) (*http.Response, error)

func (*Client) ListCreativeModerations

func (c *Client) ListCreativeModerations(ctx context.Context, params *ListCreativeModerationsParams) (*http.Response, error)

func (*Client) ListCreatives

func (c *Client) ListCreatives(ctx context.Context, params *ListCreativesParams) (*http.Response, error)

func (*Client) ListDomains

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

func (*Client) ListLocations

func (c *Client) ListLocations(ctx context.Context, params *ListLocationsParams) (*http.Response, error)

func (*Client) ListNegativeTargetingClauses

func (c *Client) ListNegativeTargetingClauses(ctx context.Context, params *ListNegativeTargetingClausesParams) (*http.Response, error)

func (*Client) ListNegativeTargetingClausesEx

func (c *Client) ListNegativeTargetingClausesEx(ctx context.Context, params *ListNegativeTargetingClausesExParams) (*http.Response, error)

func (*Client) ListOptimizationRules

func (c *Client) ListOptimizationRules(ctx context.Context, params *ListOptimizationRulesParams) (*http.Response, error)

func (*Client) ListProductAds

func (c *Client) ListProductAds(ctx context.Context, params *ListProductAdsParams) (*http.Response, error)

func (*Client) ListProductAdsEx

func (c *Client) ListProductAdsEx(ctx context.Context, params *ListProductAdsExParams) (*http.Response, error)

func (*Client) ListRequestStatus

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

func (*Client) ListTargetingClauses

func (c *Client) ListTargetingClauses(ctx context.Context, params *ListTargetingClausesParams) (*http.Response, error)

func (*Client) ListTargetingClausesEx

func (c *Client) ListTargetingClausesEx(ctx context.Context, params *ListTargetingClausesExParams) (*http.Response, error)

func (*Client) PostCreativePreview

func (*Client) PostCreativePreviewWithBody

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

func (*Client) RequestReport

func (*Client) RequestReportWithBody

func (c *Client) RequestReportWithBody(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, contentType string, body io.Reader) (*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) UpdateAdGroups

func (c *Client) UpdateAdGroups(ctx context.Context, params *UpdateAdGroupsParams, body UpdateAdGroupsJSONRequestBody) (*http.Response, error)

func (*Client) UpdateAdGroupsWithBody

func (c *Client) UpdateAdGroupsWithBody(ctx context.Context, params *UpdateAdGroupsParams, 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)

func (*Client) UpdateCampaigns

func (c *Client) UpdateCampaigns(ctx context.Context, params *UpdateCampaignsParams, body UpdateCampaignsJSONRequestBody) (*http.Response, error)

func (*Client) UpdateCampaignsWithBody

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

func (*Client) UpdateCreatives

func (c *Client) UpdateCreatives(ctx context.Context, params *UpdateCreativesParams, body UpdateCreativesJSONRequestBody) (*http.Response, error)

func (*Client) UpdateCreativesWithBody

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

func (*Client) UpdateNegativeTargetingClausesWithBody

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

func (*Client) UpdateOptimizationRulesWithBody

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

func (*Client) UpdateProductAds

func (c *Client) UpdateProductAds(ctx context.Context, params *UpdateProductAdsParams, body UpdateProductAdsJSONRequestBody) (*http.Response, error)

func (*Client) UpdateProductAdsWithBody

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

func (*Client) UpdateTargetingClausesWithBody

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

type ClientHeader

type ClientHeader = string

ClientHeader defines model for clientHeader.

type ClientInterface

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

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

	CreateAdGroups(ctx context.Context, params *CreateAdGroupsParams, body CreateAdGroupsJSONRequestBody) (*http.Response, error)

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

	UpdateAdGroups(ctx context.Context, params *UpdateAdGroupsParams, body UpdateAdGroupsJSONRequestBody) (*http.Response, error)

	// ListAdGroupsEx request
	ListAdGroupsEx(ctx context.Context, params *ListAdGroupsExParams) (*http.Response, error)

	// GetAdGroupResponseEx request
	GetAdGroupResponseEx(ctx context.Context, adGroupId int64, params *GetAdGroupResponseExParams) (*http.Response, error)

	// ArchiveAdGroup request
	ArchiveAdGroup(ctx context.Context, adGroupId int64, params *ArchiveAdGroupParams) (*http.Response, error)

	// GetAdGroup request
	GetAdGroup(ctx context.Context, adGroupId int64, params *GetAdGroupParams) (*http.Response, error)

	// GetSdAdGroupsAdGroupIdOptimizationRules request
	GetSdAdGroupsAdGroupIdOptimizationRules(ctx context.Context, adGroupId int64, params *GetSdAdGroupsAdGroupIdOptimizationRulesParams) (*http.Response, error)

	// AssociateOptimizationRulesWithAdGroupWithBody request with any body
	AssociateOptimizationRulesWithAdGroupWithBody(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, contentType string, body io.Reader) (*http.Response, error)

	AssociateOptimizationRulesWithAdGroup(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, body AssociateOptimizationRulesWithAdGroupJSONRequestBody) (*http.Response, error)

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

	// ListCampaigns request
	ListCampaigns(ctx context.Context, params *ListCampaignsParams) (*http.Response, error)

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

	CreateCampaigns(ctx context.Context, params *CreateCampaignsParams, body CreateCampaignsJSONRequestBody) (*http.Response, error)

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

	UpdateCampaigns(ctx context.Context, params *UpdateCampaignsParams, body UpdateCampaignsJSONRequestBody) (*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)

	// ListCampaignsEx request
	ListCampaignsEx(ctx context.Context, params *ListCampaignsExParams) (*http.Response, error)

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

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

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

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

	// ListCreatives request
	ListCreatives(ctx context.Context, params *ListCreativesParams) (*http.Response, error)

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

	CreateCreatives(ctx context.Context, params *CreateCreativesParams, body CreateCreativesJSONRequestBody) (*http.Response, error)

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

	UpdateCreatives(ctx context.Context, params *UpdateCreativesParams, body UpdateCreativesJSONRequestBody) (*http.Response, error)

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

	PostCreativePreview(ctx context.Context, params *PostCreativePreviewParams, body PostCreativePreviewJSONRequestBody) (*http.Response, error)

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

	CreateSDForecastWithApplicationVndSdforecastsV30PlusJSONBody(ctx context.Context, params *CreateSDForecastParams, body CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody) (*http.Response, error)

	// ListLocations request
	ListLocations(ctx context.Context, params *ListLocationsParams) (*http.Response, error)

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

	CreateLocations(ctx context.Context, params *CreateLocationsParams, body CreateLocationsJSONRequestBody) (*http.Response, error)

	// ListCreativeModerations request
	ListCreativeModerations(ctx context.Context, params *ListCreativeModerationsParams) (*http.Response, error)

	// ListNegativeTargetingClauses request
	ListNegativeTargetingClauses(ctx context.Context, params *ListNegativeTargetingClausesParams) (*http.Response, error)

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

	CreateNegativeTargetingClauses(ctx context.Context, params *CreateNegativeTargetingClausesParams, body CreateNegativeTargetingClausesJSONRequestBody) (*http.Response, error)

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

	UpdateNegativeTargetingClauses(ctx context.Context, params *UpdateNegativeTargetingClausesParams, body UpdateNegativeTargetingClausesJSONRequestBody) (*http.Response, error)

	// ListNegativeTargetingClausesEx request
	ListNegativeTargetingClausesEx(ctx context.Context, params *ListNegativeTargetingClausesExParams) (*http.Response, error)

	// GetNegativeTargetsEx request
	GetNegativeTargetsEx(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsExParams) (*http.Response, error)

	// ArchiveNegativeTargetingClause request
	ArchiveNegativeTargetingClause(ctx context.Context, negativeTargetId int64, params *ArchiveNegativeTargetingClauseParams) (*http.Response, error)

	// GetNegativeTargets request
	GetNegativeTargets(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsParams) (*http.Response, error)

	// ListOptimizationRules request
	ListOptimizationRules(ctx context.Context, params *ListOptimizationRulesParams) (*http.Response, error)

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

	CreateOptimizationRules(ctx context.Context, params *CreateOptimizationRulesParams, body CreateOptimizationRulesJSONRequestBody) (*http.Response, error)

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

	UpdateOptimizationRules(ctx context.Context, params *UpdateOptimizationRulesParams, body UpdateOptimizationRulesJSONRequestBody) (*http.Response, error)

	// GetSdOptimizationRulesOptimizationRuleId request
	GetSdOptimizationRulesOptimizationRuleId(ctx context.Context, optimizationRuleId string, params *GetSdOptimizationRulesOptimizationRuleIdParams) (*http.Response, error)

	// ListProductAds request
	ListProductAds(ctx context.Context, params *ListProductAdsParams) (*http.Response, error)

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

	CreateProductAds(ctx context.Context, params *CreateProductAdsParams, body CreateProductAdsJSONRequestBody) (*http.Response, error)

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

	UpdateProductAds(ctx context.Context, params *UpdateProductAdsParams, body UpdateProductAdsJSONRequestBody) (*http.Response, error)

	// ListProductAdsEx request
	ListProductAdsEx(ctx context.Context, params *ListProductAdsExParams) (*http.Response, error)

	// GetProductAdResponseEx request
	GetProductAdResponseEx(ctx context.Context, adId int64, params *GetProductAdResponseExParams) (*http.Response, error)

	// ArchiveProductAd request
	ArchiveProductAd(ctx context.Context, adId int64, params *ArchiveProductAdParams) (*http.Response, error)

	// GetProductAd request
	GetProductAd(ctx context.Context, adId int64, params *GetProductAdParams) (*http.Response, error)

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

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

	// ListTargetingClauses request
	ListTargetingClauses(ctx context.Context, params *ListTargetingClausesParams) (*http.Response, error)

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

	CreateTargetingClauses(ctx context.Context, params *CreateTargetingClausesParams, body CreateTargetingClausesJSONRequestBody) (*http.Response, error)

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

	UpdateTargetingClauses(ctx context.Context, params *UpdateTargetingClausesParams, body UpdateTargetingClausesJSONRequestBody) (*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)

	// ListTargetingClausesEx request
	ListTargetingClausesEx(ctx context.Context, params *ListTargetingClausesExParams) (*http.Response, error)

	// GetTargetsEx request
	GetTargetsEx(ctx context.Context, targetId int64, params *GetTargetsExParams) (*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)

	// ArchiveTargetingClause request
	ArchiveTargetingClause(ctx context.Context, targetId int64, params *ArchiveTargetingClauseParams) (*http.Response, error)

	// GetTargets request
	GetTargets(ctx context.Context, targetId int64, params *GetTargetsParams) (*http.Response, error)

	// RequestReportWithBody request with any body
	RequestReportWithBody(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, contentType string, body io.Reader) (*http.Response, error)

	RequestReport(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, body RequestReportJSONRequestBody) (*http.Response, error)

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

	CreateSnapshot(ctx context.Context, recordType string, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*http.Response, error)

	// GetReportStatus request
	GetReportStatus(ctx context.Context, reportId string, params *GetReportStatusParams) (*http.Response, error)

	// DownloadReport request
	DownloadReport(ctx context.Context, reportId string, params *DownloadReportParams) (*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) ArchiveAdGroupWithResponse

func (c *ClientWithResponses) ArchiveAdGroupWithResponse(ctx context.Context, adGroupId int64, params *ArchiveAdGroupParams) (*ArchiveAdGroupResp, error)

ArchiveAdGroupWithResponse request returning *ArchiveAdGroupResp

func (*ClientWithResponses) ArchiveCampaignWithResponse

func (c *ClientWithResponses) ArchiveCampaignWithResponse(ctx context.Context, campaignId int64, params *ArchiveCampaignParams) (*ArchiveCampaignResp, error)

ArchiveCampaignWithResponse request returning *ArchiveCampaignResp

func (*ClientWithResponses) ArchiveNegativeTargetingClauseWithResponse

func (c *ClientWithResponses) ArchiveNegativeTargetingClauseWithResponse(ctx context.Context, negativeTargetId int64, params *ArchiveNegativeTargetingClauseParams) (*ArchiveNegativeTargetingClauseResp, error)

ArchiveNegativeTargetingClauseWithResponse request returning *ArchiveNegativeTargetingClauseResp

func (*ClientWithResponses) ArchiveProductAdWithResponse

func (c *ClientWithResponses) ArchiveProductAdWithResponse(ctx context.Context, adId int64, params *ArchiveProductAdParams) (*ArchiveProductAdResp, error)

ArchiveProductAdWithResponse request returning *ArchiveProductAdResp

func (*ClientWithResponses) ArchiveTargetingClauseWithResponse

func (c *ClientWithResponses) ArchiveTargetingClauseWithResponse(ctx context.Context, targetId int64, params *ArchiveTargetingClauseParams) (*ArchiveTargetingClauseResp, error)

ArchiveTargetingClauseWithResponse request returning *ArchiveTargetingClauseResp

func (*ClientWithResponses) AssociateOptimizationRulesWithAdGroupWithBodyWithResponse

func (c *ClientWithResponses) AssociateOptimizationRulesWithAdGroupWithBodyWithResponse(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, contentType string, body io.Reader) (*AssociateOptimizationRulesWithAdGroupResp, error)

AssociateOptimizationRulesWithAdGroupWithBodyWithResponse request with arbitrary body returning *AssociateOptimizationRulesWithAdGroupResp

func (*ClientWithResponses) CreateAdGroupsWithBodyWithResponse

func (c *ClientWithResponses) CreateAdGroupsWithBodyWithResponse(ctx context.Context, params *CreateAdGroupsParams, contentType string, body io.Reader) (*CreateAdGroupsResp, error)

CreateAdGroupsWithBodyWithResponse request with arbitrary body returning *CreateAdGroupsResp

func (*ClientWithResponses) CreateAdGroupsWithResponse

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

func (c *ClientWithResponses) CreateCampaignsWithBodyWithResponse(ctx context.Context, params *CreateCampaignsParams, contentType string, body io.Reader) (*CreateCampaignsResp, error)

CreateCampaignsWithBodyWithResponse request with arbitrary body returning *CreateCampaignsResp

func (*ClientWithResponses) CreateCampaignsWithResponse

func (*ClientWithResponses) CreateCreativesWithBodyWithResponse

func (c *ClientWithResponses) CreateCreativesWithBodyWithResponse(ctx context.Context, params *CreateCreativesParams, contentType string, body io.Reader) (*CreateCreativesResp, error)

CreateCreativesWithBodyWithResponse request with arbitrary body returning *CreateCreativesResp

func (*ClientWithResponses) CreateCreativesWithResponse

func (*ClientWithResponses) CreateLocationsWithBodyWithResponse

func (c *ClientWithResponses) CreateLocationsWithBodyWithResponse(ctx context.Context, params *CreateLocationsParams, contentType string, body io.Reader) (*CreateLocationsResp, error)

CreateLocationsWithBodyWithResponse request with arbitrary body returning *CreateLocationsResp

func (*ClientWithResponses) CreateLocationsWithResponse

func (*ClientWithResponses) CreateNegativeTargetingClausesWithBodyWithResponse

func (c *ClientWithResponses) CreateNegativeTargetingClausesWithBodyWithResponse(ctx context.Context, params *CreateNegativeTargetingClausesParams, contentType string, body io.Reader) (*CreateNegativeTargetingClausesResp, error)

CreateNegativeTargetingClausesWithBodyWithResponse request with arbitrary body returning *CreateNegativeTargetingClausesResp

func (*ClientWithResponses) CreateOptimizationRulesWithBodyWithResponse

func (c *ClientWithResponses) CreateOptimizationRulesWithBodyWithResponse(ctx context.Context, params *CreateOptimizationRulesParams, contentType string, body io.Reader) (*CreateOptimizationRulesResp, error)

CreateOptimizationRulesWithBodyWithResponse request with arbitrary body returning *CreateOptimizationRulesResp

func (*ClientWithResponses) CreateProductAdsWithBodyWithResponse

func (c *ClientWithResponses) CreateProductAdsWithBodyWithResponse(ctx context.Context, params *CreateProductAdsParams, contentType string, body io.Reader) (*CreateProductAdsResp, error)

CreateProductAdsWithBodyWithResponse request with arbitrary body returning *CreateProductAdsResp

func (*ClientWithResponses) CreateProductAdsWithResponse

func (*ClientWithResponses) CreateSDForecastWithApplicationVndSdforecastsV30PlusJSONBodyWithResponse

func (c *ClientWithResponses) CreateSDForecastWithApplicationVndSdforecastsV30PlusJSONBodyWithResponse(ctx context.Context, params *CreateSDForecastParams, body CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody) (*CreateSDForecastResp, error)

func (*ClientWithResponses) CreateSDForecastWithBodyWithResponse

func (c *ClientWithResponses) CreateSDForecastWithBodyWithResponse(ctx context.Context, params *CreateSDForecastParams, contentType string, body io.Reader) (*CreateSDForecastResp, error)

CreateSDForecastWithBodyWithResponse request with arbitrary body returning *CreateSDForecastResp

func (*ClientWithResponses) CreateSnapshotWithBodyWithResponse

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

CreateSnapshotWithBodyWithResponse request with arbitrary body returning *CreateSnapshotResp

func (*ClientWithResponses) CreateSnapshotWithResponse

func (c *ClientWithResponses) CreateSnapshotWithResponse(ctx context.Context, recordType string, params *CreateSnapshotParams, body CreateSnapshotJSONRequestBody) (*CreateSnapshotResp, error)

func (*ClientWithResponses) CreateTargetingClausesWithBodyWithResponse

func (c *ClientWithResponses) CreateTargetingClausesWithBodyWithResponse(ctx context.Context, params *CreateTargetingClausesParams, contentType string, body io.Reader) (*CreateTargetingClausesResp, error)

CreateTargetingClausesWithBodyWithResponse request with arbitrary body returning *CreateTargetingClausesResp

func (*ClientWithResponses) DeleteBrandSafetyDenyListWithResponse

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

DeleteBrandSafetyDenyListWithResponse request returning *DeleteBrandSafetyDenyListResp

func (*ClientWithResponses) DownloadReportWithResponse

func (c *ClientWithResponses) DownloadReportWithResponse(ctx context.Context, reportId string, params *DownloadReportParams) (*DownloadReportResp, error)

DownloadReportWithResponse request returning *DownloadReportResp

func (*ClientWithResponses) DownloadSnapshotWithResponse

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

DownloadSnapshotWithResponse request returning *DownloadSnapshotResp

func (*ClientWithResponses) GetAdGroupResponseExWithResponse

func (c *ClientWithResponses) GetAdGroupResponseExWithResponse(ctx context.Context, adGroupId int64, params *GetAdGroupResponseExParams) (*GetAdGroupResponseExResp, error)

GetAdGroupResponseExWithResponse request returning *GetAdGroupResponseExResp

func (*ClientWithResponses) GetAdGroupWithResponse

func (c *ClientWithResponses) GetAdGroupWithResponse(ctx context.Context, adGroupId int64, params *GetAdGroupParams) (*GetAdGroupResp, error)

GetAdGroupWithResponse request returning *GetAdGroupResp

func (*ClientWithResponses) GetBudgetRuleByRuleIdForSDCampaignsWithResponse

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

GetBudgetRuleByRuleIdForSDCampaignsWithResponse request returning *GetBudgetRuleByRuleIdForSDCampaignsResp

func (*ClientWithResponses) GetCampaignResponseExWithResponse

func (c *ClientWithResponses) GetCampaignResponseExWithResponse(ctx context.Context, campaignId int64, params *GetCampaignResponseExParams) (*GetCampaignResponseExResp, error)

GetCampaignResponseExWithResponse request returning *GetCampaignResponseExResp

func (*ClientWithResponses) GetCampaignWithResponse

func (c *ClientWithResponses) GetCampaignWithResponse(ctx context.Context, campaignId int64, params *GetCampaignParams) (*GetCampaignResp, error)

GetCampaignWithResponse request returning *GetCampaignResp

func (*ClientWithResponses) GetNegativeTargetsExWithResponse

func (c *ClientWithResponses) GetNegativeTargetsExWithResponse(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsExParams) (*GetNegativeTargetsExResp, error)

GetNegativeTargetsExWithResponse request returning *GetNegativeTargetsExResp

func (*ClientWithResponses) GetNegativeTargetsWithResponse

func (c *ClientWithResponses) GetNegativeTargetsWithResponse(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsParams) (*GetNegativeTargetsResp, error)

GetNegativeTargetsWithResponse request returning *GetNegativeTargetsResp

func (*ClientWithResponses) GetProductAdResponseExWithResponse

func (c *ClientWithResponses) GetProductAdResponseExWithResponse(ctx context.Context, adId int64, params *GetProductAdResponseExParams) (*GetProductAdResponseExResp, error)

GetProductAdResponseExWithResponse request returning *GetProductAdResponseExResp

func (*ClientWithResponses) GetProductAdWithResponse

func (c *ClientWithResponses) GetProductAdWithResponse(ctx context.Context, adId int64, params *GetProductAdParams) (*GetProductAdResp, error)

GetProductAdWithResponse request returning *GetProductAdResp

func (*ClientWithResponses) GetReportStatusWithResponse

func (c *ClientWithResponses) GetReportStatusWithResponse(ctx context.Context, reportId string, params *GetReportStatusParams) (*GetReportStatusResp, error)

GetReportStatusWithResponse request returning *GetReportStatusResp

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

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

GetSDBudgetRulesForAdvertiserWithResponse request returning *GetSDBudgetRulesForAdvertiserResp

func (*ClientWithResponses) GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse

func (c *ClientWithResponses) GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse(ctx context.Context, adGroupId int64, params *GetSdAdGroupsAdGroupIdOptimizationRulesParams) (*GetSdAdGroupsAdGroupIdOptimizationRulesResp, error)

GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse request returning *GetSdAdGroupsAdGroupIdOptimizationRulesResp

func (*ClientWithResponses) GetSdOptimizationRulesOptimizationRuleIdWithResponse

func (c *ClientWithResponses) GetSdOptimizationRulesOptimizationRuleIdWithResponse(ctx context.Context, optimizationRuleId string, params *GetSdOptimizationRulesOptimizationRuleIdParams) (*GetSdOptimizationRulesOptimizationRuleIdResp, error)

GetSdOptimizationRulesOptimizationRuleIdWithResponse request returning *GetSdOptimizationRulesOptimizationRuleIdResp

func (*ClientWithResponses) GetSnapshotWithResponse

func (c *ClientWithResponses) GetSnapshotWithResponse(ctx context.Context, snapshotId string, params *GetSnapshotParams) (*GetSnapshotResp, error)

GetSnapshotWithResponse request returning *GetSnapshotResp

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

func (c *ClientWithResponses) GetTargetsExWithResponse(ctx context.Context, targetId int64, params *GetTargetsExParams) (*GetTargetsExResp, error)

GetTargetsExWithResponse request returning *GetTargetsExResp

func (*ClientWithResponses) GetTargetsWithResponse

func (c *ClientWithResponses) GetTargetsWithResponse(ctx context.Context, targetId int64, params *GetTargetsParams) (*GetTargetsResp, error)

GetTargetsWithResponse request returning *GetTargetsResp

func (*ClientWithResponses) ListAdGroupsExWithResponse

func (c *ClientWithResponses) ListAdGroupsExWithResponse(ctx context.Context, params *ListAdGroupsExParams) (*ListAdGroupsExResp, error)

ListAdGroupsExWithResponse request returning *ListAdGroupsExResp

func (*ClientWithResponses) ListAdGroupsWithResponse

func (c *ClientWithResponses) ListAdGroupsWithResponse(ctx context.Context, params *ListAdGroupsParams) (*ListAdGroupsResp, error)

ListAdGroupsWithResponse request returning *ListAdGroupsResp

func (*ClientWithResponses) ListCampaignsExWithResponse

func (c *ClientWithResponses) ListCampaignsExWithResponse(ctx context.Context, params *ListCampaignsExParams) (*ListCampaignsExResp, error)

ListCampaignsExWithResponse request returning *ListCampaignsExResp

func (*ClientWithResponses) ListCampaignsWithResponse

func (c *ClientWithResponses) ListCampaignsWithResponse(ctx context.Context, params *ListCampaignsParams) (*ListCampaignsResp, error)

ListCampaignsWithResponse request returning *ListCampaignsResp

func (*ClientWithResponses) ListCreativeModerationsWithResponse

func (c *ClientWithResponses) ListCreativeModerationsWithResponse(ctx context.Context, params *ListCreativeModerationsParams) (*ListCreativeModerationsResp, error)

ListCreativeModerationsWithResponse request returning *ListCreativeModerationsResp

func (*ClientWithResponses) ListCreativesWithResponse

func (c *ClientWithResponses) ListCreativesWithResponse(ctx context.Context, params *ListCreativesParams) (*ListCreativesResp, error)

ListCreativesWithResponse request returning *ListCreativesResp

func (*ClientWithResponses) ListDomainsWithResponse

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

ListDomainsWithResponse request returning *ListDomainsResp

func (*ClientWithResponses) ListLocationsWithResponse

func (c *ClientWithResponses) ListLocationsWithResponse(ctx context.Context, params *ListLocationsParams) (*ListLocationsResp, error)

ListLocationsWithResponse request returning *ListLocationsResp

func (*ClientWithResponses) ListNegativeTargetingClausesExWithResponse

func (c *ClientWithResponses) ListNegativeTargetingClausesExWithResponse(ctx context.Context, params *ListNegativeTargetingClausesExParams) (*ListNegativeTargetingClausesExResp, error)

ListNegativeTargetingClausesExWithResponse request returning *ListNegativeTargetingClausesExResp

func (*ClientWithResponses) ListNegativeTargetingClausesWithResponse

func (c *ClientWithResponses) ListNegativeTargetingClausesWithResponse(ctx context.Context, params *ListNegativeTargetingClausesParams) (*ListNegativeTargetingClausesResp, error)

ListNegativeTargetingClausesWithResponse request returning *ListNegativeTargetingClausesResp

func (*ClientWithResponses) ListOptimizationRulesWithResponse

func (c *ClientWithResponses) ListOptimizationRulesWithResponse(ctx context.Context, params *ListOptimizationRulesParams) (*ListOptimizationRulesResp, error)

ListOptimizationRulesWithResponse request returning *ListOptimizationRulesResp

func (*ClientWithResponses) ListProductAdsExWithResponse

func (c *ClientWithResponses) ListProductAdsExWithResponse(ctx context.Context, params *ListProductAdsExParams) (*ListProductAdsExResp, error)

ListProductAdsExWithResponse request returning *ListProductAdsExResp

func (*ClientWithResponses) ListProductAdsWithResponse

func (c *ClientWithResponses) ListProductAdsWithResponse(ctx context.Context, params *ListProductAdsParams) (*ListProductAdsResp, error)

ListProductAdsWithResponse request returning *ListProductAdsResp

func (*ClientWithResponses) ListRequestStatusWithResponse

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

ListRequestStatusWithResponse request returning *ListRequestStatusResp

func (*ClientWithResponses) ListTargetingClausesExWithResponse

func (c *ClientWithResponses) ListTargetingClausesExWithResponse(ctx context.Context, params *ListTargetingClausesExParams) (*ListTargetingClausesExResp, error)

ListTargetingClausesExWithResponse request returning *ListTargetingClausesExResp

func (*ClientWithResponses) ListTargetingClausesWithResponse

func (c *ClientWithResponses) ListTargetingClausesWithResponse(ctx context.Context, params *ListTargetingClausesParams) (*ListTargetingClausesResp, error)

ListTargetingClausesWithResponse request returning *ListTargetingClausesResp

func (*ClientWithResponses) PostCreativePreviewWithBodyWithResponse

func (c *ClientWithResponses) PostCreativePreviewWithBodyWithResponse(ctx context.Context, params *PostCreativePreviewParams, contentType string, body io.Reader) (*PostCreativePreviewResp, error)

PostCreativePreviewWithBodyWithResponse request with arbitrary body returning *PostCreativePreviewResp

func (*ClientWithResponses) PostCreativePreviewWithResponse

func (*ClientWithResponses) RequestReportWithBodyWithResponse

func (c *ClientWithResponses) RequestReportWithBodyWithResponse(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, contentType string, body io.Reader) (*RequestReportResp, error)

RequestReportWithBodyWithResponse request with arbitrary body returning *RequestReportResp

func (*ClientWithResponses) RequestReportWithResponse

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

func (c *ClientWithResponses) UpdateAdGroupsWithBodyWithResponse(ctx context.Context, params *UpdateAdGroupsParams, contentType string, body io.Reader) (*UpdateAdGroupsResp, error)

UpdateAdGroupsWithBodyWithResponse request with arbitrary body returning *UpdateAdGroupsResp

func (*ClientWithResponses) UpdateAdGroupsWithResponse

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

func (*ClientWithResponses) UpdateCampaignsWithBodyWithResponse

func (c *ClientWithResponses) UpdateCampaignsWithBodyWithResponse(ctx context.Context, params *UpdateCampaignsParams, contentType string, body io.Reader) (*UpdateCampaignsResp, error)

UpdateCampaignsWithBodyWithResponse request with arbitrary body returning *UpdateCampaignsResp

func (*ClientWithResponses) UpdateCampaignsWithResponse

func (*ClientWithResponses) UpdateCreativesWithBodyWithResponse

func (c *ClientWithResponses) UpdateCreativesWithBodyWithResponse(ctx context.Context, params *UpdateCreativesParams, contentType string, body io.Reader) (*UpdateCreativesResp, error)

UpdateCreativesWithBodyWithResponse request with arbitrary body returning *UpdateCreativesResp

func (*ClientWithResponses) UpdateCreativesWithResponse

func (*ClientWithResponses) UpdateNegativeTargetingClausesWithBodyWithResponse

func (c *ClientWithResponses) UpdateNegativeTargetingClausesWithBodyWithResponse(ctx context.Context, params *UpdateNegativeTargetingClausesParams, contentType string, body io.Reader) (*UpdateNegativeTargetingClausesResp, error)

UpdateNegativeTargetingClausesWithBodyWithResponse request with arbitrary body returning *UpdateNegativeTargetingClausesResp

func (*ClientWithResponses) UpdateOptimizationRulesWithBodyWithResponse

func (c *ClientWithResponses) UpdateOptimizationRulesWithBodyWithResponse(ctx context.Context, params *UpdateOptimizationRulesParams, contentType string, body io.Reader) (*UpdateOptimizationRulesResp, error)

UpdateOptimizationRulesWithBodyWithResponse request with arbitrary body returning *UpdateOptimizationRulesResp

func (*ClientWithResponses) UpdateProductAdsWithBodyWithResponse

func (c *ClientWithResponses) UpdateProductAdsWithBodyWithResponse(ctx context.Context, params *UpdateProductAdsParams, contentType string, body io.Reader) (*UpdateProductAdsResp, error)

UpdateProductAdsWithBodyWithResponse request with arbitrary body returning *UpdateProductAdsResp

func (*ClientWithResponses) UpdateProductAdsWithResponse

func (*ClientWithResponses) UpdateTargetingClausesWithBodyWithResponse

func (c *ClientWithResponses) UpdateTargetingClausesWithBodyWithResponse(ctx context.Context, params *UpdateTargetingClausesParams, contentType string, body io.Reader) (*UpdateTargetingClausesResp, error)

UpdateTargetingClausesWithBodyWithResponse request with arbitrary body returning *UpdateTargetingClausesResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListAdGroupsWithResponse request
	ListAdGroupsWithResponse(ctx context.Context, params *ListAdGroupsParams) (*ListAdGroupsResp, error)

	// CreateAdGroupsWithBodyWithResponse request with any body
	CreateAdGroupsWithBodyWithResponse(ctx context.Context, params *CreateAdGroupsParams, contentType string, body io.Reader) (*CreateAdGroupsResp, error)

	CreateAdGroupsWithResponse(ctx context.Context, params *CreateAdGroupsParams, body CreateAdGroupsJSONRequestBody) (*CreateAdGroupsResp, error)

	// UpdateAdGroupsWithBodyWithResponse request with any body
	UpdateAdGroupsWithBodyWithResponse(ctx context.Context, params *UpdateAdGroupsParams, contentType string, body io.Reader) (*UpdateAdGroupsResp, error)

	UpdateAdGroupsWithResponse(ctx context.Context, params *UpdateAdGroupsParams, body UpdateAdGroupsJSONRequestBody) (*UpdateAdGroupsResp, error)

	// ListAdGroupsExWithResponse request
	ListAdGroupsExWithResponse(ctx context.Context, params *ListAdGroupsExParams) (*ListAdGroupsExResp, error)

	// GetAdGroupResponseExWithResponse request
	GetAdGroupResponseExWithResponse(ctx context.Context, adGroupId int64, params *GetAdGroupResponseExParams) (*GetAdGroupResponseExResp, error)

	// ArchiveAdGroupWithResponse request
	ArchiveAdGroupWithResponse(ctx context.Context, adGroupId int64, params *ArchiveAdGroupParams) (*ArchiveAdGroupResp, error)

	// GetAdGroupWithResponse request
	GetAdGroupWithResponse(ctx context.Context, adGroupId int64, params *GetAdGroupParams) (*GetAdGroupResp, error)

	// GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse request
	GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse(ctx context.Context, adGroupId int64, params *GetSdAdGroupsAdGroupIdOptimizationRulesParams) (*GetSdAdGroupsAdGroupIdOptimizationRulesResp, error)

	// AssociateOptimizationRulesWithAdGroupWithBodyWithResponse request with any body
	AssociateOptimizationRulesWithAdGroupWithBodyWithResponse(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, contentType string, body io.Reader) (*AssociateOptimizationRulesWithAdGroupResp, error)

	AssociateOptimizationRulesWithAdGroupWithResponse(ctx context.Context, adGroupId int64, params *AssociateOptimizationRulesWithAdGroupParams, body AssociateOptimizationRulesWithAdGroupJSONRequestBody) (*AssociateOptimizationRulesWithAdGroupResp, error)

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

	// ListCampaignsWithResponse request
	ListCampaignsWithResponse(ctx context.Context, params *ListCampaignsParams) (*ListCampaignsResp, error)

	// CreateCampaignsWithBodyWithResponse request with any body
	CreateCampaignsWithBodyWithResponse(ctx context.Context, params *CreateCampaignsParams, contentType string, body io.Reader) (*CreateCampaignsResp, error)

	CreateCampaignsWithResponse(ctx context.Context, params *CreateCampaignsParams, body CreateCampaignsJSONRequestBody) (*CreateCampaignsResp, error)

	// UpdateCampaignsWithBodyWithResponse request with any body
	UpdateCampaignsWithBodyWithResponse(ctx context.Context, params *UpdateCampaignsParams, contentType string, body io.Reader) (*UpdateCampaignsResp, error)

	UpdateCampaignsWithResponse(ctx context.Context, params *UpdateCampaignsParams, body UpdateCampaignsJSONRequestBody) (*UpdateCampaignsResp, 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)

	// ListCampaignsExWithResponse request
	ListCampaignsExWithResponse(ctx context.Context, params *ListCampaignsExParams) (*ListCampaignsExResp, error)

	// GetCampaignResponseExWithResponse request
	GetCampaignResponseExWithResponse(ctx context.Context, campaignId int64, params *GetCampaignResponseExParams) (*GetCampaignResponseExResp, error)

	// ArchiveCampaignWithResponse request
	ArchiveCampaignWithResponse(ctx context.Context, campaignId int64, params *ArchiveCampaignParams) (*ArchiveCampaignResp, error)

	// GetCampaignWithResponse request
	GetCampaignWithResponse(ctx context.Context, campaignId int64, params *GetCampaignParams) (*GetCampaignResp, error)

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

	// ListCreativesWithResponse request
	ListCreativesWithResponse(ctx context.Context, params *ListCreativesParams) (*ListCreativesResp, error)

	// CreateCreativesWithBodyWithResponse request with any body
	CreateCreativesWithBodyWithResponse(ctx context.Context, params *CreateCreativesParams, contentType string, body io.Reader) (*CreateCreativesResp, error)

	CreateCreativesWithResponse(ctx context.Context, params *CreateCreativesParams, body CreateCreativesJSONRequestBody) (*CreateCreativesResp, error)

	// UpdateCreativesWithBodyWithResponse request with any body
	UpdateCreativesWithBodyWithResponse(ctx context.Context, params *UpdateCreativesParams, contentType string, body io.Reader) (*UpdateCreativesResp, error)

	UpdateCreativesWithResponse(ctx context.Context, params *UpdateCreativesParams, body UpdateCreativesJSONRequestBody) (*UpdateCreativesResp, error)

	// PostCreativePreviewWithBodyWithResponse request with any body
	PostCreativePreviewWithBodyWithResponse(ctx context.Context, params *PostCreativePreviewParams, contentType string, body io.Reader) (*PostCreativePreviewResp, error)

	PostCreativePreviewWithResponse(ctx context.Context, params *PostCreativePreviewParams, body PostCreativePreviewJSONRequestBody) (*PostCreativePreviewResp, error)

	// CreateSDForecastWithBodyWithResponse request with any body
	CreateSDForecastWithBodyWithResponse(ctx context.Context, params *CreateSDForecastParams, contentType string, body io.Reader) (*CreateSDForecastResp, error)

	CreateSDForecastWithApplicationVndSdforecastsV30PlusJSONBodyWithResponse(ctx context.Context, params *CreateSDForecastParams, body CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody) (*CreateSDForecastResp, error)

	// ListLocationsWithResponse request
	ListLocationsWithResponse(ctx context.Context, params *ListLocationsParams) (*ListLocationsResp, error)

	// CreateLocationsWithBodyWithResponse request with any body
	CreateLocationsWithBodyWithResponse(ctx context.Context, params *CreateLocationsParams, contentType string, body io.Reader) (*CreateLocationsResp, error)

	CreateLocationsWithResponse(ctx context.Context, params *CreateLocationsParams, body CreateLocationsJSONRequestBody) (*CreateLocationsResp, error)

	// ListCreativeModerationsWithResponse request
	ListCreativeModerationsWithResponse(ctx context.Context, params *ListCreativeModerationsParams) (*ListCreativeModerationsResp, error)

	// ListNegativeTargetingClausesWithResponse request
	ListNegativeTargetingClausesWithResponse(ctx context.Context, params *ListNegativeTargetingClausesParams) (*ListNegativeTargetingClausesResp, error)

	// CreateNegativeTargetingClausesWithBodyWithResponse request with any body
	CreateNegativeTargetingClausesWithBodyWithResponse(ctx context.Context, params *CreateNegativeTargetingClausesParams, contentType string, body io.Reader) (*CreateNegativeTargetingClausesResp, error)

	CreateNegativeTargetingClausesWithResponse(ctx context.Context, params *CreateNegativeTargetingClausesParams, body CreateNegativeTargetingClausesJSONRequestBody) (*CreateNegativeTargetingClausesResp, error)

	// UpdateNegativeTargetingClausesWithBodyWithResponse request with any body
	UpdateNegativeTargetingClausesWithBodyWithResponse(ctx context.Context, params *UpdateNegativeTargetingClausesParams, contentType string, body io.Reader) (*UpdateNegativeTargetingClausesResp, error)

	UpdateNegativeTargetingClausesWithResponse(ctx context.Context, params *UpdateNegativeTargetingClausesParams, body UpdateNegativeTargetingClausesJSONRequestBody) (*UpdateNegativeTargetingClausesResp, error)

	// ListNegativeTargetingClausesExWithResponse request
	ListNegativeTargetingClausesExWithResponse(ctx context.Context, params *ListNegativeTargetingClausesExParams) (*ListNegativeTargetingClausesExResp, error)

	// GetNegativeTargetsExWithResponse request
	GetNegativeTargetsExWithResponse(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsExParams) (*GetNegativeTargetsExResp, error)

	// ArchiveNegativeTargetingClauseWithResponse request
	ArchiveNegativeTargetingClauseWithResponse(ctx context.Context, negativeTargetId int64, params *ArchiveNegativeTargetingClauseParams) (*ArchiveNegativeTargetingClauseResp, error)

	// GetNegativeTargetsWithResponse request
	GetNegativeTargetsWithResponse(ctx context.Context, negativeTargetId int64, params *GetNegativeTargetsParams) (*GetNegativeTargetsResp, error)

	// ListOptimizationRulesWithResponse request
	ListOptimizationRulesWithResponse(ctx context.Context, params *ListOptimizationRulesParams) (*ListOptimizationRulesResp, error)

	// CreateOptimizationRulesWithBodyWithResponse request with any body
	CreateOptimizationRulesWithBodyWithResponse(ctx context.Context, params *CreateOptimizationRulesParams, contentType string, body io.Reader) (*CreateOptimizationRulesResp, error)

	CreateOptimizationRulesWithResponse(ctx context.Context, params *CreateOptimizationRulesParams, body CreateOptimizationRulesJSONRequestBody) (*CreateOptimizationRulesResp, error)

	// UpdateOptimizationRulesWithBodyWithResponse request with any body
	UpdateOptimizationRulesWithBodyWithResponse(ctx context.Context, params *UpdateOptimizationRulesParams, contentType string, body io.Reader) (*UpdateOptimizationRulesResp, error)

	UpdateOptimizationRulesWithResponse(ctx context.Context, params *UpdateOptimizationRulesParams, body UpdateOptimizationRulesJSONRequestBody) (*UpdateOptimizationRulesResp, error)

	// GetSdOptimizationRulesOptimizationRuleIdWithResponse request
	GetSdOptimizationRulesOptimizationRuleIdWithResponse(ctx context.Context, optimizationRuleId string, params *GetSdOptimizationRulesOptimizationRuleIdParams) (*GetSdOptimizationRulesOptimizationRuleIdResp, error)

	// ListProductAdsWithResponse request
	ListProductAdsWithResponse(ctx context.Context, params *ListProductAdsParams) (*ListProductAdsResp, error)

	// CreateProductAdsWithBodyWithResponse request with any body
	CreateProductAdsWithBodyWithResponse(ctx context.Context, params *CreateProductAdsParams, contentType string, body io.Reader) (*CreateProductAdsResp, error)

	CreateProductAdsWithResponse(ctx context.Context, params *CreateProductAdsParams, body CreateProductAdsJSONRequestBody) (*CreateProductAdsResp, error)

	// UpdateProductAdsWithBodyWithResponse request with any body
	UpdateProductAdsWithBodyWithResponse(ctx context.Context, params *UpdateProductAdsParams, contentType string, body io.Reader) (*UpdateProductAdsResp, error)

	UpdateProductAdsWithResponse(ctx context.Context, params *UpdateProductAdsParams, body UpdateProductAdsJSONRequestBody) (*UpdateProductAdsResp, error)

	// ListProductAdsExWithResponse request
	ListProductAdsExWithResponse(ctx context.Context, params *ListProductAdsExParams) (*ListProductAdsExResp, error)

	// GetProductAdResponseExWithResponse request
	GetProductAdResponseExWithResponse(ctx context.Context, adId int64, params *GetProductAdResponseExParams) (*GetProductAdResponseExResp, error)

	// ArchiveProductAdWithResponse request
	ArchiveProductAdWithResponse(ctx context.Context, adId int64, params *ArchiveProductAdParams) (*ArchiveProductAdResp, error)

	// GetProductAdWithResponse request
	GetProductAdWithResponse(ctx context.Context, adId int64, params *GetProductAdParams) (*GetProductAdResp, error)

	// GetSnapshotWithResponse request
	GetSnapshotWithResponse(ctx context.Context, snapshotId string, params *GetSnapshotParams) (*GetSnapshotResp, error)

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

	// ListTargetingClausesWithResponse request
	ListTargetingClausesWithResponse(ctx context.Context, params *ListTargetingClausesParams) (*ListTargetingClausesResp, error)

	// CreateTargetingClausesWithBodyWithResponse request with any body
	CreateTargetingClausesWithBodyWithResponse(ctx context.Context, params *CreateTargetingClausesParams, contentType string, body io.Reader) (*CreateTargetingClausesResp, error)

	CreateTargetingClausesWithResponse(ctx context.Context, params *CreateTargetingClausesParams, body CreateTargetingClausesJSONRequestBody) (*CreateTargetingClausesResp, error)

	// UpdateTargetingClausesWithBodyWithResponse request with any body
	UpdateTargetingClausesWithBodyWithResponse(ctx context.Context, params *UpdateTargetingClausesParams, contentType string, body io.Reader) (*UpdateTargetingClausesResp, error)

	UpdateTargetingClausesWithResponse(ctx context.Context, params *UpdateTargetingClausesParams, body UpdateTargetingClausesJSONRequestBody) (*UpdateTargetingClausesResp, 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)

	// ListTargetingClausesExWithResponse request
	ListTargetingClausesExWithResponse(ctx context.Context, params *ListTargetingClausesExParams) (*ListTargetingClausesExResp, error)

	// GetTargetsExWithResponse request
	GetTargetsExWithResponse(ctx context.Context, targetId int64, params *GetTargetsExParams) (*GetTargetsExResp, 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)

	// ArchiveTargetingClauseWithResponse request
	ArchiveTargetingClauseWithResponse(ctx context.Context, targetId int64, params *ArchiveTargetingClauseParams) (*ArchiveTargetingClauseResp, error)

	// GetTargetsWithResponse request
	GetTargetsWithResponse(ctx context.Context, targetId int64, params *GetTargetsParams) (*GetTargetsResp, error)

	// RequestReportWithBodyWithResponse request with any body
	RequestReportWithBodyWithResponse(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, contentType string, body io.Reader) (*RequestReportResp, error)

	RequestReportWithResponse(ctx context.Context, recordType RequestReportParamsRecordType, params *RequestReportParams, body RequestReportJSONRequestBody) (*RequestReportResp, error)

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

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

	// GetReportStatusWithResponse request
	GetReportStatusWithResponse(ctx context.Context, reportId string, params *GetReportStatusParams) (*GetReportStatusResp, error)

	// DownloadReportWithResponse request
	DownloadReportWithResponse(ctx context.Context, reportId string, params *DownloadReportParams) (*DownloadReportResp, error)
}

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

type ComparisonOperator

type ComparisonOperator string

ComparisonOperator The comparison operator.

const (
	ComparisonOperatorGREATERTHAN          ComparisonOperator = "GREATER_THAN"
	ComparisonOperatorGREATERTHANOREQUALTO ComparisonOperator = "GREATER_THAN_OR_EQUAL_TO"
	ComparisonOperatorLESSTHAN             ComparisonOperator = "LESS_THAN"
	ComparisonOperatorLESSTHANOREQUALTO    ComparisonOperator = "LESS_THAN_OR_EQUAL_TO"
)

Defines values for ComparisonOperator.

type CreateAdGroup

type CreateAdGroup struct {
	// BidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.
	// |Name|CostType|Description|
	// |----|--------|-----------|
	// |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks |cpc|[Default] Optimize for page visits.|
	// |conversions |cpc|Optimize for conversion.|
	BidOptimization *CreateAdGroupBidOptimization `json:"bidOptimization,omitempty"`

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

	// CreativeType The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|
	CreativeType *CreativeType `json:"creativeType"`

	// DefaultBid The amount of the default bid associated with the ad group. Used if no bid is specified.
	DefaultBid *float64 `json:"defaultBid,omitempty"`

	// Name The name of the ad group.
	Name *string `json:"name,omitempty"`

	// State The state of the ad group.
	State *CreateAdGroupState `json:"state,omitempty"`
}

CreateAdGroup defines model for CreateAdGroup.

type CreateAdGroupBidOptimization

type CreateAdGroupBidOptimization string

CreateAdGroupBidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks. |Name|CostType|Description| |----|--------|-----------| |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks |cpc|[Default] Optimize for page visits.| |conversions |cpc|Optimize for conversion.|

const (
	CreateAdGroupBidOptimizationClicks      CreateAdGroupBidOptimization = "clicks"
	CreateAdGroupBidOptimizationConversions CreateAdGroupBidOptimization = "conversions"
	CreateAdGroupBidOptimizationReach       CreateAdGroupBidOptimization = "reach"
)

Defines values for CreateAdGroupBidOptimization.

type CreateAdGroupState

type CreateAdGroupState string

CreateAdGroupState The state of the ad group.

const (
	CreateAdGroupStateArchived CreateAdGroupState = "archived"
	CreateAdGroupStateEnabled  CreateAdGroupState = "enabled"
	CreateAdGroupStatePaused   CreateAdGroupState = "paused"
)

Defines values for CreateAdGroupState.

type CreateAdGroupsJSONBody

type CreateAdGroupsJSONBody = []CreateAdGroup

CreateAdGroupsJSONBody defines parameters for CreateAdGroups.

type CreateAdGroupsJSONRequestBody

type CreateAdGroupsJSONRequestBody = CreateAdGroupsJSONBody

CreateAdGroupsJSONRequestBody defines body for CreateAdGroups for application/json ContentType.

type CreateAdGroupsParams

type CreateAdGroupsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateAdGroupsParams defines parameters for CreateAdGroups.

type CreateAdGroupsResp

type CreateAdGroupsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]AdGroupResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateAdGroupsResp

func ParseCreateAdGroupsResp(rsp *http.Response) (*CreateAdGroupsResp, error)

ParseCreateAdGroupsResp parses an HTTP response from a CreateAdGroupsWithResponse call

func (CreateAdGroupsResp) Status

func (r CreateAdGroupsResp) Status() string

Status returns HTTPResponse.Status

func (CreateAdGroupsResp) StatusCode

func (r CreateAdGroupsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateAssociatedOptimizationRulesRequest

type CreateAssociatedOptimizationRulesRequest struct {
	// OptimizationRuleIds A list of optimization rule identifiers.
	OptimizationRuleIds *[]RuleId `json:"optimizationRuleIds,omitempty"`
}

CreateAssociatedOptimizationRulesRequest defines model for CreateAssociatedOptimizationRulesRequest.

type CreateBrandSafetyDenyListDomainsJSONRequestBody

type CreateBrandSafetyDenyListDomainsJSONRequestBody = BrandSafetyPostRequest

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

CreateBrandSafetyDenyListDomainsParams defines parameters for CreateBrandSafetyDenyListDomains.

type CreateBrandSafetyDenyListDomainsResp

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

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 CreateCampaign

type CreateCampaign struct {
	// Budget The amount of the budget.
	Budget *float64 `json:"budget,omitempty"`

	// BudgetType The time period over which the amount specified in the `budget` property is allocated.
	BudgetType *CreateCampaignBudgetType `json:"budgetType,omitempty"`

	// CostType Determines how the campaign will bid and charge.
	// |Name|Description|
	// |----|----------|
	// |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|
	// |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |
	//
	// To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).
	CostType *CreateCampaignCostType `json:"costType,omitempty"`

	// EndDate The YYYYMMDD end date of the campaign.
	EndDate *string `json:"endDate"`

	// Name The name of the campaign.
	Name *string `json:"name,omitempty"`

	// PortfolioId Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.
	PortfolioId *int64 `json:"portfolioId"`

	// StartDate The YYYYMMDD start date of the campaign. The date must be today or in the future.
	StartDate *string `json:"startDate,omitempty"`

	// State The state of the campaign.
	State *CreateCampaignState `json:"state,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *Tactic `json:"tactic,omitempty"`
}

CreateCampaign defines model for CreateCampaign.

type CreateCampaignBudgetType

type CreateCampaignBudgetType string

CreateCampaignBudgetType The time period over which the amount specified in the `budget` property is allocated.

const (
	CreateCampaignBudgetTypeDaily CreateCampaignBudgetType = "daily"
)

Defines values for CreateCampaignBudgetType.

type CreateCampaignCostType

type CreateCampaignCostType string

CreateCampaignCostType Determines how the campaign will bid and charge. |Name|Description| |----|----------| |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.| |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |

To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).

const (
	CreateCampaignCostTypeCpc  CreateCampaignCostType = "cpc"
	CreateCampaignCostTypeVcpm CreateCampaignCostType = "vcpm"
)

Defines values for CreateCampaignCostType.

type CreateCampaignState

type CreateCampaignState string

CreateCampaignState The state of the campaign.

const (
	CreateCampaignStateArchived CreateCampaignState = "archived"
	CreateCampaignStateEnabled  CreateCampaignState = "enabled"
	CreateCampaignStatePaused   CreateCampaignState = "paused"
)

Defines values for CreateCampaignState.

type CreateCampaignsJSONBody

type CreateCampaignsJSONBody = []CreateCampaign

CreateCampaignsJSONBody defines parameters for CreateCampaigns.

type CreateCampaignsJSONRequestBody

type CreateCampaignsJSONRequestBody = CreateCampaignsJSONBody

CreateCampaignsJSONRequestBody defines body for CreateCampaigns for application/json ContentType.

type CreateCampaignsParams

type CreateCampaignsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateCampaignsParams defines parameters for CreateCampaigns.

type CreateCampaignsResp

type CreateCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]CampaignResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateCampaignsResp

func ParseCreateCampaignsResp(rsp *http.Response) (*CreateCampaignsResp, error)

ParseCreateCampaignsResp parses an HTTP response from a CreateCampaignsWithResponse call

func (CreateCampaignsResp) Status

func (r CreateCampaignsResp) Status() string

Status returns HTTPResponse.Status

func (CreateCampaignsResp) StatusCode

func (r CreateCampaignsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateCreative

type CreateCreative struct {
	// AdGroupId Unqiue identifier for the ad group associated with the creative.
	AdGroupId float32 `json:"adGroupId"`

	// CreativeType The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|
	CreativeType *CreativeTypeInCreativeRequest `json:"creativeType"`

	// Properties Select customizations on your creative from any combination of headline, logo, and custom image.
	Properties CreativeProperties `json:"properties"`
}

CreateCreative Creative create model.

type CreateCreativesJSONBody

type CreateCreativesJSONBody = []CreateCreative

CreateCreativesJSONBody defines parameters for CreateCreatives.

type CreateCreativesJSONRequestBody

type CreateCreativesJSONRequestBody = CreateCreativesJSONBody

CreateCreativesJSONRequestBody defines body for CreateCreatives for application/json ContentType.

type CreateCreativesParams

type CreateCreativesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateCreativesParams defines parameters for CreateCreatives.

type CreateCreativesResp

type CreateCreativesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]CreativeResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateCreativesResp

func ParseCreateCreativesResp(rsp *http.Response) (*CreateCreativesResp, error)

ParseCreateCreativesResp parses an HTTP response from a CreateCreativesWithResponse call

func (CreateCreativesResp) Status

func (r CreateCreativesResp) Status() string

Status returns HTTPResponse.Status

func (CreateCreativesResp) StatusCode

func (r CreateCreativesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateLocation

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

	// Expression The location definition.
	Expression *[]LocationExpression `json:"expression,omitempty"`
	State      *CreateLocationState  `json:"state,omitempty"`
}

CreateLocation defines model for CreateLocation.

type CreateLocationState

type CreateLocationState string

CreateLocationState defines model for CreateLocation.State.

const (
	CreateLocationStateEnabled CreateLocationState = "enabled"
)

Defines values for CreateLocationState.

type CreateLocationsJSONBody

type CreateLocationsJSONBody = []CreateLocation

CreateLocationsJSONBody defines parameters for CreateLocations.

type CreateLocationsJSONRequestBody

type CreateLocationsJSONRequestBody = CreateLocationsJSONBody

CreateLocationsJSONRequestBody defines body for CreateLocations for application/json ContentType.

type CreateLocationsParams

type CreateLocationsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateLocationsParams defines parameters for CreateLocations.

type CreateLocationsResp

type CreateLocationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Location
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateLocationsResp

func ParseCreateLocationsResp(rsp *http.Response) (*CreateLocationsResp, error)

ParseCreateLocationsResp parses an HTTP response from a CreateLocationsWithResponse call

func (CreateLocationsResp) Status

func (r CreateLocationsResp) Status() string

Status returns HTTPResponse.Status

func (CreateLocationsResp) StatusCode

func (r CreateLocationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateNegativeTargetingClause

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

	// Expression The expression to negatively match against.
	// * 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.
	Expression     *[]NegativeTargetingExpression               `json:"expression,omitempty"`
	ExpressionType *CreateNegativeTargetingClauseExpressionType `json:"expressionType,omitempty"`
	State          *CreateNegativeTargetingClauseState          `json:"state,omitempty"`
}

CreateNegativeTargetingClause defines model for CreateNegativeTargetingClause.

type CreateNegativeTargetingClauseExpressionType

type CreateNegativeTargetingClauseExpressionType string

CreateNegativeTargetingClauseExpressionType defines model for CreateNegativeTargetingClause.ExpressionType.

const (
	CreateNegativeTargetingClauseExpressionTypeAuto   CreateNegativeTargetingClauseExpressionType = "auto"
	CreateNegativeTargetingClauseExpressionTypeManual CreateNegativeTargetingClauseExpressionType = "manual"
)

Defines values for CreateNegativeTargetingClauseExpressionType.

type CreateNegativeTargetingClauseState

type CreateNegativeTargetingClauseState string

CreateNegativeTargetingClauseState defines model for CreateNegativeTargetingClause.State.

const (
	CreateNegativeTargetingClauseStateArchived CreateNegativeTargetingClauseState = "archived"
	CreateNegativeTargetingClauseStateEnabled  CreateNegativeTargetingClauseState = "enabled"
	CreateNegativeTargetingClauseStatePaused   CreateNegativeTargetingClauseState = "paused"
)

Defines values for CreateNegativeTargetingClauseState.

type CreateNegativeTargetingClausesJSONBody

type CreateNegativeTargetingClausesJSONBody = []CreateNegativeTargetingClause

CreateNegativeTargetingClausesJSONBody defines parameters for CreateNegativeTargetingClauses.

type CreateNegativeTargetingClausesJSONRequestBody

type CreateNegativeTargetingClausesJSONRequestBody = CreateNegativeTargetingClausesJSONBody

CreateNegativeTargetingClausesJSONRequestBody defines body for CreateNegativeTargetingClauses for application/json ContentType.

type CreateNegativeTargetingClausesParams

type CreateNegativeTargetingClausesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateNegativeTargetingClausesParams defines parameters for CreateNegativeTargetingClauses.

type CreateNegativeTargetingClausesResp

type CreateNegativeTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateNegativeTargetingClausesResp

func ParseCreateNegativeTargetingClausesResp(rsp *http.Response) (*CreateNegativeTargetingClausesResp, error)

ParseCreateNegativeTargetingClausesResp parses an HTTP response from a CreateNegativeTargetingClausesWithResponse call

func (CreateNegativeTargetingClausesResp) Status

Status returns HTTPResponse.Status

func (CreateNegativeTargetingClausesResp) StatusCode

func (r CreateNegativeTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOptimizationRule

type CreateOptimizationRule = BaseOptimizationRule

CreateOptimizationRule defines model for CreateOptimizationRule.

type CreateOptimizationRulesJSONBody

type CreateOptimizationRulesJSONBody = []CreateOptimizationRule

CreateOptimizationRulesJSONBody defines parameters for CreateOptimizationRules.

type CreateOptimizationRulesJSONRequestBody

type CreateOptimizationRulesJSONRequestBody = CreateOptimizationRulesJSONBody

CreateOptimizationRulesJSONRequestBody defines body for CreateOptimizationRules for application/json ContentType.

type CreateOptimizationRulesParams

type CreateOptimizationRulesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateOptimizationRulesParams defines parameters for CreateOptimizationRules.

type CreateOptimizationRulesResp

type CreateOptimizationRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]OptimizationRuleResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateOptimizationRulesResp

func ParseCreateOptimizationRulesResp(rsp *http.Response) (*CreateOptimizationRulesResp, error)

ParseCreateOptimizationRulesResp parses an HTTP response from a CreateOptimizationRulesWithResponse call

func (CreateOptimizationRulesResp) Status

Status returns HTTPResponse.Status

func (CreateOptimizationRulesResp) StatusCode

func (r CreateOptimizationRulesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateProductAd

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

	// AdName The name of the ad. Note that this field is not supported when using ASIN or SKU fields.
	AdName *AdName `json:"adName,omitempty"`

	// Asin The ASIN of the product advertised by the product ad.
	Asin *string `json:"asin,omitempty"`

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

	// LandingPageType The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.
	LandingPageType *LandingPageType `json:"landingPageType,omitempty"`

	// LandingPageURL The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.
	// ||Specifications|
	// |------------------|------------------|
	// |LandingPageType| Description|
	// |STORE| Not yet supported. The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|
	// |MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|
	// |OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |
	LandingPageURL *LandingPageURL `json:"landingPageURL,omitempty"`

	// Sku The SKU of the product advertised by the product ad.
	Sku *string `json:"sku,omitempty"`

	// State The state of the campaign associated with the product ad.
	State *CreateProductAdState `json:"state,omitempty"`
}

CreateProductAd defines model for CreateProductAd.

type CreateProductAdState

type CreateProductAdState string

CreateProductAdState The state of the campaign associated with the product ad.

const (
	CreateProductAdStateArchived CreateProductAdState = "archived"
	CreateProductAdStateEnabled  CreateProductAdState = "enabled"
	CreateProductAdStatePaused   CreateProductAdState = "paused"
)

Defines values for CreateProductAdState.

type CreateProductAdsJSONBody

type CreateProductAdsJSONBody = []CreateProductAd

CreateProductAdsJSONBody defines parameters for CreateProductAds.

type CreateProductAdsJSONRequestBody

type CreateProductAdsJSONRequestBody = CreateProductAdsJSONBody

CreateProductAdsJSONRequestBody defines body for CreateProductAds for application/json ContentType.

type CreateProductAdsParams

type CreateProductAdsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateProductAdsParams defines parameters for CreateProductAds.

type CreateProductAdsResp

type CreateProductAdsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]ProductAdResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateProductAdsResp

func ParseCreateProductAdsResp(rsp *http.Response) (*CreateProductAdsResp, error)

ParseCreateProductAdsResp parses an HTTP response from a CreateProductAdsWithResponse call

func (CreateProductAdsResp) Status

func (r CreateProductAdsResp) Status() string

Status returns HTTPResponse.Status

func (CreateProductAdsResp) StatusCode

func (r CreateProductAdsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSDBudgetRulesRequest

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

CreateSDBudgetRulesRequest defines model for CreateSDBudgetRulesRequest.

type CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody

type CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody = SDForecastRequest

CreateSDForecastApplicationVndSdforecastsV30PlusJSONRequestBody defines body for CreateSDForecast for application/vnd.sdforecasts.v3.0+json ContentType.

type CreateSDForecastParams

type CreateSDForecastParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateSDForecastParams defines parameters for CreateSDForecast.

type CreateSDForecastResp

type CreateSDForecastResp struct {
	Body                                []byte
	HTTPResponse                        *http.Response
	ApplicationvndSdforecastsV30JSON200 *SDForecastResponse
	ApplicationvndSdforecastsV30JSON400 *SDForecastErrorResponse
	ApplicationvndSdforecastsV30JSON401 *SDForecastErrorResponse
	ApplicationvndSdforecastsV30JSON403 *SDForecastErrorResponse
	ApplicationvndSdforecastsV30JSON429 *SDForecastErrorResponse
	ApplicationvndSdforecastsV30JSON500 *SDForecastErrorResponse
}

func ParseCreateSDForecastResp

func ParseCreateSDForecastResp(rsp *http.Response) (*CreateSDForecastResp, error)

ParseCreateSDForecastResp parses an HTTP response from a CreateSDForecastWithResponse call

func (CreateSDForecastResp) Status

func (r CreateSDForecastResp) Status() string

Status returns HTTPResponse.Status

func (CreateSDForecastResp) StatusCode

func (r CreateSDForecastResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

CreateSnapshotParams defines parameters for CreateSnapshot.

type CreateSnapshotResp

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

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 CreateTargetingClause

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

	// Bid The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the ["Bid constraints by marketplace" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.
	Bid *float32 `json:"bid"`

	// Expression The targeting expression to match against.
	//
	// ------- Applicable to contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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.
	Expression *CreateTargetingExpression `json:"expression,omitempty"`

	// ExpressionType Tactic T00020 ad groups only allow manual targeting.
	ExpressionType *CreateTargetingClauseExpressionType `json:"expressionType,omitempty"`
	State          *CreateTargetingClauseState          `json:"state,omitempty"`
}

CreateTargetingClause defines model for CreateTargetingClause.

type CreateTargetingClauseExpressionType

type CreateTargetingClauseExpressionType string

CreateTargetingClauseExpressionType Tactic T00020 ad groups only allow manual targeting.

const (
	CreateTargetingClauseExpressionTypeAuto   CreateTargetingClauseExpressionType = "auto"
	CreateTargetingClauseExpressionTypeManual CreateTargetingClauseExpressionType = "manual"
)

Defines values for CreateTargetingClauseExpressionType.

type CreateTargetingClauseState

type CreateTargetingClauseState string

CreateTargetingClauseState defines model for CreateTargetingClause.State.

const (
	CreateTargetingClauseStateArchived CreateTargetingClauseState = "archived"
	CreateTargetingClauseStateEnabled  CreateTargetingClauseState = "enabled"
	CreateTargetingClauseStatePaused   CreateTargetingClauseState = "paused"
)

Defines values for CreateTargetingClauseState.

type CreateTargetingClausesJSONBody

type CreateTargetingClausesJSONBody = []CreateTargetingClause

CreateTargetingClausesJSONBody defines parameters for CreateTargetingClauses.

type CreateTargetingClausesJSONRequestBody

type CreateTargetingClausesJSONRequestBody = CreateTargetingClausesJSONBody

CreateTargetingClausesJSONRequestBody defines body for CreateTargetingClauses for application/json ContentType.

type CreateTargetingClausesParams

type CreateTargetingClausesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

CreateTargetingClausesParams defines parameters for CreateTargetingClauses.

type CreateTargetingClausesResp

type CreateTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseCreateTargetingClausesResp

func ParseCreateTargetingClausesResp(rsp *http.Response) (*CreateTargetingClausesResp, error)

ParseCreateTargetingClausesResp parses an HTTP response from a CreateTargetingClausesWithResponse call

func (CreateTargetingClausesResp) Status

Status returns HTTPResponse.Status

func (CreateTargetingClausesResp) StatusCode

func (r CreateTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTargetingExpression

type CreateTargetingExpression = []CreateTargetingExpression_Item

CreateTargetingExpression The targeting expression to match against.

------- Applicable to contextual targeting (T00020) ------- * A 'TargetingExpression' in a contextual 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.

type CreateTargetingExpression_Item

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

CreateTargetingExpression_Item defines model for CreateTargetingExpression.Item.

func (CreateTargetingExpression_Item) AsTargetingPredicate

func (t CreateTargetingExpression_Item) AsTargetingPredicate() (TargetingPredicate, error)

AsTargetingPredicate returns the union data inside the CreateTargetingExpression_Item as a TargetingPredicate

func (CreateTargetingExpression_Item) AsTargetingPredicateNested

func (t CreateTargetingExpression_Item) AsTargetingPredicateNested() (TargetingPredicateNested, error)

AsTargetingPredicateNested returns the union data inside the CreateTargetingExpression_Item as a TargetingPredicateNested

func (*CreateTargetingExpression_Item) FromTargetingPredicate

func (t *CreateTargetingExpression_Item) FromTargetingPredicate(v TargetingPredicate) error

FromTargetingPredicate overwrites any union data inside the CreateTargetingExpression_Item as the provided TargetingPredicate

func (*CreateTargetingExpression_Item) FromTargetingPredicateNested

func (t *CreateTargetingExpression_Item) FromTargetingPredicateNested(v TargetingPredicateNested) error

FromTargetingPredicateNested overwrites any union data inside the CreateTargetingExpression_Item as the provided TargetingPredicateNested

func (CreateTargetingExpression_Item) MarshalJSON

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

func (*CreateTargetingExpression_Item) MergeTargetingPredicate

func (t *CreateTargetingExpression_Item) MergeTargetingPredicate(v TargetingPredicate) error

MergeTargetingPredicate performs a merge with any union data inside the CreateTargetingExpression_Item, using the provided TargetingPredicate

func (*CreateTargetingExpression_Item) MergeTargetingPredicateNested

func (t *CreateTargetingExpression_Item) MergeTargetingPredicateNested(v TargetingPredicateNested) error

MergeTargetingPredicateNested performs a merge with any union data inside the CreateTargetingExpression_Item, using the provided TargetingPredicateNested

func (*CreateTargetingExpression_Item) UnmarshalJSON

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

type Creative

type Creative struct {
	// AdGroupId The identifier of the ad group.
	AdGroupId AdGroupId `json:"adGroupId"`

	// CreativeId Unique identifier of the creative.
	CreativeId float32 `json:"creativeId"`

	// CreativeType
	// The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided.|
	CreativeType CreativeTypeInCreativeResponse `json:"creativeType"`

	// ModerationStatus The moderation status of the creative
	ModerationStatus CreativeModerationStatus `json:"moderationStatus"`

	// Properties Select customizations on your creative from any combination of headline, logo, and custom image.
	Properties CreativeProperties `json:"properties"`
}

Creative Creative model.

type CreativeModeration

type CreativeModeration struct {
	// CreativeId Unique identifier of the creative.
	CreativeId float32 `json:"creativeId"`

	// CreativeType
	// The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided.|
	CreativeType CreativeTypeInCreativeResponse `json:"creativeType"`

	// EtaForModeration Expected date and time by which moderation will be complete.
	EtaForModeration time.Time `json:"etaForModeration"`

	// ModerationStatus The moderation status of the creative.
	// |Status|Description|
	// |------|-----------|
	// |APPROVED|Moderation for the creative is complete.|
	// |IN_PROGRESS|Moderation for the creative is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.|
	// |REJECTED|The creative has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|
	ModerationStatus CreativeModerationModerationStatus `json:"moderationStatus"`

	// PolicyViolations A list of policy violations for a creative that has failed moderation.
	PolicyViolations []struct {
		// PolicyDescription A human-readable description of the policy.
		PolicyDescription *string `json:"policyDescription,omitempty"`

		// PolicyLinkUrl Address of the policy documentation. Follow the link to learn more about the specified policy.
		PolicyLinkUrl *string `json:"policyLinkUrl,omitempty"`

		// ViolatingBrandLogoContents Information about the brand logo that violates the specified policy.
		ViolatingBrandLogoContents *[]struct {
			ImageEvidences *[]struct {
				ViolatingImageCrop *struct {
					// Height The height of the content that violates the specfied policy within the image.
					Height *int `json:"height,omitempty"`

					// TopLeftX The top left X-coordinate of the content that violates the specfied policy within the image.
					TopLeftX *int `json:"topLeftX,omitempty"`

					// TopLeftY The top left Y-coordinate of the content that violates the specfied policy within the image.
					TopLeftY *int `json:"topLeftY,omitempty"`

					// Width The width of the content that violates the specfied policy within the image.
					Width *int `json:"width,omitempty"`
				} `json:"violatingImageCrop,omitempty"`
			} `json:"imageEvidences,omitempty"`

			// ReviewedImageUrl Address of the image reviewed during moderation.
			ReviewedImageUrl *string `json:"reviewedImageUrl,omitempty"`
		} `json:"violatingBrandLogoContents,omitempty"`

		// ViolatingCustomImageContents Information about the custom image that violates the specified policy.
		ViolatingCustomImageContents *[]struct {
			ImageEvidences *[]struct {
				ViolatingImageCrop *struct {
					// Height The height of the content that violates the specfied policy within the image.
					Height *int `json:"height,omitempty"`

					// TopLeftX The top left X-coordinate of the content that violates the specfied policy within the image.
					TopLeftX *int `json:"topLeftX,omitempty"`

					// TopLeftY The top left Y-coordinate of the content that violates the specfied policy within the image.
					TopLeftY *int `json:"topLeftY,omitempty"`

					// Width The width of the content that violates the specfied policy within the image.
					Width *int `json:"width,omitempty"`
				} `json:"violatingImageCrop,omitempty"`
			} `json:"imageEvidences,omitempty"`

			// ReviewedImageUrl Address of the image reviewed during moderation.
			ReviewedImageUrl *string `json:"reviewedImageUrl,omitempty"`
		} `json:"violatingCustomImageContents,omitempty"`

		// ViolatingHeadlineContents Information about the headline text that violates the specified policy.
		ViolatingHeadlineContents *[]struct {
			// ReviewedText The specific text reviewed during moderation.
			ReviewedText *string `json:"reviewedText,omitempty"`
			TextEvidence *[]struct {
				// ViolatingText The specific text determined to violate the specified policy in reviewedText
				ViolatingText         *string `json:"violatingText,omitempty"`
				ViolatingTextPosition *struct {
					// End Zero-based index into the text in reviewedText where the text specified in violatingText ends
					End *int `json:"end,omitempty"`

					// Start Zero-based index into the text in reviewedText where the text specified in violatingText starts
					Start *int `json:"start,omitempty"`
				} `json:"violatingTextPosition,omitempty"`
			} `json:"textEvidence,omitempty"`
		} `json:"violatingHeadlineContents,omitempty"`

		// ViolatingVideoContents Information about the video that violates the specified policy.
		ViolatingVideoContents *[]struct {
			// ReviewedVideoUrl Address of the video reviewed during moderation.
			ReviewedVideoUrl *string `json:"reviewedVideoUrl,omitempty"`
			VideoEvidences   *[]struct {
				ViolatingVideoPosition *struct {
					// End Time at which policy violation within the video asset ends.
					End *int `json:"end,omitempty"`

					// Start Time at which policy violation within video asset starts.
					Start *int `json:"start,omitempty"`
				} `json:"violatingVideoPosition,omitempty"`
			} `json:"videoEvidences,omitempty"`
		} `json:"violatingVideoContents,omitempty"`
	} `json:"policyViolations"`
}

CreativeModeration System generated Creative moderation.

type CreativeModerationModerationStatus

type CreativeModerationModerationStatus string

CreativeModerationModerationStatus The moderation status of the creative. |Status|Description| |------|-----------| |APPROVED|Moderation for the creative is complete.| |IN_PROGRESS|Moderation for the creative is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.| |REJECTED|The creative has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|

const (
	CreativeModerationModerationStatusAPPROVED      CreativeModerationModerationStatus = "APPROVED"
	CreativeModerationModerationStatusPENDINGREVIEW CreativeModerationModerationStatus = "PENDING_REVIEW"
	CreativeModerationModerationStatusREJECTED      CreativeModerationModerationStatus = "REJECTED"
)

Defines values for CreativeModerationModerationStatus.

type CreativeModerationStatus

type CreativeModerationStatus string

CreativeModerationStatus The moderation status of the creative

const (
	CreativeModerationStatusAPPROVED      CreativeModerationStatus = "APPROVED"
	CreativeModerationStatusPENDINGREVIEW CreativeModerationStatus = "PENDING_REVIEW"
	CreativeModerationStatusREJECTED      CreativeModerationStatus = "REJECTED"
)

Defines values for CreativeModerationStatus.

type CreativePreviewConfiguration

type CreativePreviewConfiguration struct {
	// AdName The name of the ad. Note that this field is not supported when using ASIN or SKU fields.
	AdName *AdName `json:"adName,omitempty"`

	// IsMobile Preview the creative as if it is on a mobile environment.
	IsMobile *bool `json:"isMobile,omitempty"`

	// IsOnAmazon Preview the creative as if it is on an amazon site or third party site. The main difference is whether the preview will contain an AdChoices icon.
	IsOnAmazon *bool `json:"isOnAmazon,omitempty"`

	// LandingPageType The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.
	LandingPageType *LandingPageType `json:"landingPageType,omitempty"`

	// LandingPageURL The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.
	// ||Specifications|
	// |------------------|------------------|
	// |LandingPageType| Description|
	// |STORE| Not yet supported. The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|
	// |MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|
	// |OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |
	LandingPageURL *LandingPageURL `json:"landingPageURL,omitempty"`

	// Products The products to preview. Currently only the first product is previewable.
	Products *[]struct {
		// Asin The ASIN of the product.
		Asin *string `json:"asin,omitempty"`
	} `json:"products,omitempty"`

	// Size The slot dimension to render the creative. Sponsored Display creatives are responsive to a limited list of width and height pairs, including 300x250, 650x130, 245x250, 414x125, 600x160, 600x300, 728x90, 980x55, 320x50, 970x250 and 270x150.
	Size *struct {
		Height *int `json:"height,omitempty"`
		Width  *int `json:"width,omitempty"`
	} `json:"size,omitempty"`
}

CreativePreviewConfiguration Optional configuration for creative preview.

type CreativePreviewConfigurations

type CreativePreviewConfigurations = []CreativePreviewConfiguration

CreativePreviewConfigurations defines model for CreativePreviewConfigurations.

type CreativePreviewRequest

type CreativePreviewRequest struct {
	// Creative Creative model for preview.
	Creative PreviewCreativeModel `json:"creative"`

	// PreviewConfiguration Optional configuration for creative preview.
	PreviewConfiguration  CreativePreviewConfiguration   `json:"previewConfiguration"`
	PreviewConfigurations *CreativePreviewConfigurations `json:"previewConfigurations,omitempty"`
}

CreativePreviewRequest defines model for CreativePreviewRequest.

type CreativePreviewResponse

type CreativePreviewResponse struct {
	PreviewHtml  string    `json:"previewHtml"`
	PreviewHtmls *[]string `json:"previewHtmls,omitempty"`
}

CreativePreviewResponse defines model for CreativePreviewResponse.

type CreativeProperties

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

CreativeProperties Select customizations on your creative from any combination of headline, logo, and custom image.

func (CreativeProperties) AsCustomImageCreativeProperties

func (t CreativeProperties) AsCustomImageCreativeProperties() (CustomImageCreativeProperties, error)

AsCustomImageCreativeProperties returns the union data inside the CreativeProperties as a CustomImageCreativeProperties

func (CreativeProperties) AsHeadlineCreativeProperties

func (t CreativeProperties) AsHeadlineCreativeProperties() (HeadlineCreativeProperties, error)

AsHeadlineCreativeProperties returns the union data inside the CreativeProperties as a HeadlineCreativeProperties

func (CreativeProperties) AsLogoCreativeProperties

func (t CreativeProperties) AsLogoCreativeProperties() (LogoCreativeProperties, error)

AsLogoCreativeProperties returns the union data inside the CreativeProperties as a LogoCreativeProperties

func (CreativeProperties) AsVideoCreativeProperties

func (t CreativeProperties) AsVideoCreativeProperties() (VideoCreativeProperties, error)

AsVideoCreativeProperties returns the union data inside the CreativeProperties as a VideoCreativeProperties

func (*CreativeProperties) FromCustomImageCreativeProperties

func (t *CreativeProperties) FromCustomImageCreativeProperties(v CustomImageCreativeProperties) error

FromCustomImageCreativeProperties overwrites any union data inside the CreativeProperties as the provided CustomImageCreativeProperties

func (*CreativeProperties) FromHeadlineCreativeProperties

func (t *CreativeProperties) FromHeadlineCreativeProperties(v HeadlineCreativeProperties) error

FromHeadlineCreativeProperties overwrites any union data inside the CreativeProperties as the provided HeadlineCreativeProperties

func (*CreativeProperties) FromLogoCreativeProperties

func (t *CreativeProperties) FromLogoCreativeProperties(v LogoCreativeProperties) error

FromLogoCreativeProperties overwrites any union data inside the CreativeProperties as the provided LogoCreativeProperties

func (*CreativeProperties) FromVideoCreativeProperties

func (t *CreativeProperties) FromVideoCreativeProperties(v VideoCreativeProperties) error

FromVideoCreativeProperties overwrites any union data inside the CreativeProperties as the provided VideoCreativeProperties

func (CreativeProperties) MarshalJSON

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

func (*CreativeProperties) MergeCustomImageCreativeProperties

func (t *CreativeProperties) MergeCustomImageCreativeProperties(v CustomImageCreativeProperties) error

MergeCustomImageCreativeProperties performs a merge with any union data inside the CreativeProperties, using the provided CustomImageCreativeProperties

func (*CreativeProperties) MergeHeadlineCreativeProperties

func (t *CreativeProperties) MergeHeadlineCreativeProperties(v HeadlineCreativeProperties) error

MergeHeadlineCreativeProperties performs a merge with any union data inside the CreativeProperties, using the provided HeadlineCreativeProperties

func (*CreativeProperties) MergeLogoCreativeProperties

func (t *CreativeProperties) MergeLogoCreativeProperties(v LogoCreativeProperties) error

MergeLogoCreativeProperties performs a merge with any union data inside the CreativeProperties, using the provided LogoCreativeProperties

func (*CreativeProperties) MergeVideoCreativeProperties

func (t *CreativeProperties) MergeVideoCreativeProperties(v VideoCreativeProperties) error

MergeVideoCreativeProperties performs a merge with any union data inside the CreativeProperties, using the provided VideoCreativeProperties

func (*CreativeProperties) UnmarshalJSON

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

type CreativeResponse

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

	// CreativeId The identifier of the creative.
	CreativeId *float32 `json:"creativeId,omitempty"`

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

CreativeResponse defines model for CreativeResponse.

type CreativeType

type CreativeType string

CreativeType The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time. |Name|Description| |----|-----------| |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).| |VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|

const (
	CreativeTypeIMAGE CreativeType = "IMAGE"
	CreativeTypeVIDEO CreativeType = "VIDEO"
)

Defines values for CreativeType.

type CreativeTypeInCreativeRequest

type CreativeTypeInCreativeRequest string

CreativeTypeInCreativeRequest The type of the creative. |Name|Description| |----|-----------| |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).| |VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|

const (
	CreativeTypeInCreativeRequestIMAGE CreativeTypeInCreativeRequest = "IMAGE"
	CreativeTypeInCreativeRequestVIDEO CreativeTypeInCreativeRequest = "VIDEO"
)

Defines values for CreativeTypeInCreativeRequest.

type CreativeTypeInCreativeResponse

type CreativeTypeInCreativeResponse string

CreativeTypeInCreativeResponse The type of the creative. |Name|Description| |----|-----------| |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).| |VIDEO |The creative will display video assets. This type of creative must have video assets provided.|

const (
	IMAGE CreativeTypeInCreativeResponse = "IMAGE"
	VIDEO CreativeTypeInCreativeResponse = "VIDEO"
)

Defines values for CreativeTypeInCreativeResponse.

type CreativeUpdate

type CreativeUpdate struct {
	// CreativeId Unique identifier of the creative.
	CreativeId float32 `json:"creativeId"`

	// CreativeType The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|
	CreativeType *CreativeTypeInCreativeRequest `json:"creativeType"`

	// Properties Select customizations on your creative from any combination of headline, logo, and custom image.
	Properties CreativeProperties `json:"properties"`
}

CreativeUpdate Creative update model.

type CustomImageCreativeProperties

type CustomImageCreativeProperties struct {
	// LandscapeImages An optional collection of 16:9 landscape images which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	LandscapeImages *[]Image `json:"landscapeImages,omitempty"`

	// PortraitImages An optional collection of 9:16 portrait images which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	PortraitImages *[]Image `json:"portraitImages,omitempty"`

	// RectCustomImage This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.
	// |Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|
	// |------|-----------|-----------|-----------|-----------|
	// |Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|
	// |Brand Logo|1MB|600|100|JPEG, JPG, PNG|
	// Note: For square custom images the cropped image should be 628x628 at minimum.
	RectCustomImage *Image `json:"rectCustomImage,omitempty"`

	// SquareCustomImage This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.
	// |Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|
	// |------|-----------|-----------|-----------|-----------|
	// |Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|
	// |Brand Logo|1MB|600|100|JPEG, JPG, PNG|
	// Note: For square custom images the cropped image should be 628x628 at minimum.
	SquareCustomImage *Image `json:"squareCustomImage,omitempty"`

	// SquareImages An optional collection of 1:1 square images which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	SquareImages *[]Image `json:"squareImages,omitempty"`
}

CustomImageCreativeProperties User-customizable properties of a custom image creative.

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

DeleteBrandSafetyDenyListParams defines parameters for DeleteBrandSafetyDenyList.

type DeleteBrandSafetyDenyListResp

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

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 DownloadReportParams

type DownloadReportParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

DownloadReportParams defines parameters for DownloadReport.

type DownloadReportResp

type DownloadReportResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseDownloadReportResp

func ParseDownloadReportResp(rsp *http.Response) (*DownloadReportResp, error)

ParseDownloadReportResp parses an HTTP response from a DownloadReportWithResponse call

func (DownloadReportResp) Status

func (r DownloadReportResp) Status() string

Status returns HTTPResponse.Status

func (DownloadReportResp) StatusCode

func (r DownloadReportResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DownloadSnapshotParams

type DownloadSnapshotParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

DownloadSnapshotParams defines parameters for DownloadSnapshot.

type DownloadSnapshotResp

type DownloadSnapshotResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseDownloadSnapshotResp

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

ParseDownloadSnapshotResp parses an HTTP response from a DownloadSnapshotWithResponse call

func (DownloadSnapshotResp) Status

func (r DownloadSnapshotResp) Status() string

Status returns HTTPResponse.Status

func (DownloadSnapshotResp) StatusCode

func (r DownloadSnapshotResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	// Code 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"`
}

Error The error response object.

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 Forecast

type Forecast struct {
	// Metric Describes which metric is forecasted.
	// |Name|Description|
	// |-----------|------------------------|
	// |IMPRESSIONS|Available impressions|
	// |REACH      |[Preview only] Delivered viewable impressions|
	// |CLICKS     |[Preview only] Delivered page visits|
	// |CONVERSIONS|[Preview only] Delivered conversions|
	Metric *ForecastMetric `json:"metric,omitempty"`

	// Value Forecast range values.
	Value *ForecastRange `json:"value,omitempty"`
}

Forecast Forecast impressions, clicks, reach, or conversions.

type ForecastMetric

type ForecastMetric string

ForecastMetric Describes which metric is forecasted. |Name|Description| |-----------|------------------------| |IMPRESSIONS|Available impressions| |REACH |[Preview only] Delivered viewable impressions| |CLICKS |[Preview only] Delivered page visits| |CONVERSIONS|[Preview only] Delivered conversions|

const (
	CLICKS      ForecastMetric = "CLICKS"
	CONVERSIONS ForecastMetric = "CONVERSIONS"
	IMPRESSIONS ForecastMetric = "IMPRESSIONS"
	REACH       ForecastMetric = "REACH"
)

Defines values for ForecastMetric.

type ForecastRange

type ForecastRange struct {
	Max *int64 `json:"max,omitempty"`
	Min *int64 `json:"min,omitempty"`
}

ForecastRange Forecast range values.

type GetAdGroupParams

type GetAdGroupParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAdGroupParams defines parameters for GetAdGroup.

type GetAdGroupResp

type GetAdGroupResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdGroup
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetAdGroupResp

func ParseGetAdGroupResp(rsp *http.Response) (*GetAdGroupResp, error)

ParseGetAdGroupResp parses an HTTP response from a GetAdGroupWithResponse call

func (GetAdGroupResp) Status

func (r GetAdGroupResp) Status() string

Status returns HTTPResponse.Status

func (GetAdGroupResp) StatusCode

func (r GetAdGroupResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdGroupResponseExParams

type GetAdGroupResponseExParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetAdGroupResponseExParams defines parameters for GetAdGroupResponseEx.

type GetAdGroupResponseExResp

type GetAdGroupResponseExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdGroupResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetAdGroupResponseExResp

func ParseGetAdGroupResponseExResp(rsp *http.Response) (*GetAdGroupResponseExResp, error)

ParseGetAdGroupResponseExResp parses an HTTP response from a GetAdGroupResponseExWithResponse call

func (GetAdGroupResponseExResp) Status

func (r GetAdGroupResponseExResp) Status() string

Status returns HTTPResponse.Status

func (GetAdGroupResponseExResp) StatusCode

func (r GetAdGroupResponseExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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 GetCampaignParams

type GetCampaignParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetCampaignParams defines parameters for GetCampaign.

type GetCampaignResp

type GetCampaignResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Campaign
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetCampaignResp

func ParseGetCampaignResp(rsp *http.Response) (*GetCampaignResp, error)

ParseGetCampaignResp parses an HTTP response from a GetCampaignWithResponse call

func (GetCampaignResp) Status

func (r GetCampaignResp) Status() string

Status returns HTTPResponse.Status

func (GetCampaignResp) StatusCode

func (r GetCampaignResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCampaignResponseExParams

type GetCampaignResponseExParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetCampaignResponseExParams defines parameters for GetCampaignResponseEx.

type GetCampaignResponseExResp

type GetCampaignResponseExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CampaignResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetCampaignResponseExResp

func ParseGetCampaignResponseExResp(rsp *http.Response) (*GetCampaignResponseExResp, error)

ParseGetCampaignResponseExResp parses an HTTP response from a GetCampaignResponseExWithResponse call

func (GetCampaignResponseExResp) Status

func (r GetCampaignResponseExResp) Status() string

Status returns HTTPResponse.Status

func (GetCampaignResponseExResp) StatusCode

func (r GetCampaignResponseExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNegativeTargetsExParams

type GetNegativeTargetsExParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetNegativeTargetsExParams defines parameters for GetNegativeTargetsEx.

type GetNegativeTargetsExResp

type GetNegativeTargetsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NegativeTargetingClauseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetNegativeTargetsExResp

func ParseGetNegativeTargetsExResp(rsp *http.Response) (*GetNegativeTargetsExResp, error)

ParseGetNegativeTargetsExResp parses an HTTP response from a GetNegativeTargetsExWithResponse call

func (GetNegativeTargetsExResp) Status

func (r GetNegativeTargetsExResp) Status() string

Status returns HTTPResponse.Status

func (GetNegativeTargetsExResp) StatusCode

func (r GetNegativeTargetsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNegativeTargetsParams

type GetNegativeTargetsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetNegativeTargetsParams defines parameters for GetNegativeTargets.

type GetNegativeTargetsResp

type GetNegativeTargetsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NegativeTargetingClause
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetNegativeTargetsResp

func ParseGetNegativeTargetsResp(rsp *http.Response) (*GetNegativeTargetsResp, error)

ParseGetNegativeTargetsResp parses an HTTP response from a GetNegativeTargetsWithResponse call

func (GetNegativeTargetsResp) Status

func (r GetNegativeTargetsResp) Status() string

Status returns HTTPResponse.Status

func (GetNegativeTargetsResp) StatusCode

func (r GetNegativeTargetsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProductAdParams

type GetProductAdParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetProductAdParams defines parameters for GetProductAd.

type GetProductAdResp

type GetProductAdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ProductAd
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetProductAdResp

func ParseGetProductAdResp(rsp *http.Response) (*GetProductAdResp, error)

ParseGetProductAdResp parses an HTTP response from a GetProductAdWithResponse call

func (GetProductAdResp) Status

func (r GetProductAdResp) Status() string

Status returns HTTPResponse.Status

func (GetProductAdResp) StatusCode

func (r GetProductAdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProductAdResponseExParams

type GetProductAdResponseExParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetProductAdResponseExParams defines parameters for GetProductAdResponseEx.

type GetProductAdResponseExResp

type GetProductAdResponseExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ProductAdResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetProductAdResponseExResp

func ParseGetProductAdResponseExResp(rsp *http.Response) (*GetProductAdResponseExResp, error)

ParseGetProductAdResponseExResp parses an HTTP response from a GetProductAdResponseExWithResponse call

func (GetProductAdResponseExResp) Status

Status returns HTTPResponse.Status

func (GetProductAdResponseExResp) StatusCode

func (r GetProductAdResponseExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetReportStatusParams

type GetReportStatusParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetReportStatusParams defines parameters for GetReportStatus.

type GetReportStatusResp

type GetReportStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ReportResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetReportStatusResp

func ParseGetReportStatusResp(rsp *http.Response) (*GetReportStatusResp, error)

ParseGetReportStatusResp parses an HTTP response from a GetReportStatusWithResponse call

func (GetReportStatusResp) Status

func (r GetReportStatusResp) Status() string

Status returns HTTPResponse.Status

func (GetReportStatusResp) StatusCode

func (r GetReportStatusResp) StatusCode() int

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

GetRequestResultsParams defines parameters for GetRequestResults.

type GetRequestResultsResp

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

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

GetRequestStatusParams defines parameters for GetRequestStatus.

type GetRequestStatusResp

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

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 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 GetSdAdGroupsAdGroupIdOptimizationRulesParams

type GetSdAdGroupsAdGroupIdOptimizationRulesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetSdAdGroupsAdGroupIdOptimizationRulesParams defines parameters for GetSdAdGroupsAdGroupIdOptimizationRules.

type GetSdAdGroupsAdGroupIdOptimizationRulesResp

type GetSdAdGroupsAdGroupIdOptimizationRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]OptimizationRule
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetSdAdGroupsAdGroupIdOptimizationRulesResp

func ParseGetSdAdGroupsAdGroupIdOptimizationRulesResp(rsp *http.Response) (*GetSdAdGroupsAdGroupIdOptimizationRulesResp, error)

ParseGetSdAdGroupsAdGroupIdOptimizationRulesResp parses an HTTP response from a GetSdAdGroupsAdGroupIdOptimizationRulesWithResponse call

func (GetSdAdGroupsAdGroupIdOptimizationRulesResp) Status

Status returns HTTPResponse.Status

func (GetSdAdGroupsAdGroupIdOptimizationRulesResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetSdOptimizationRulesOptimizationRuleIdParams

type GetSdOptimizationRulesOptimizationRuleIdParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetSdOptimizationRulesOptimizationRuleIdParams defines parameters for GetSdOptimizationRulesOptimizationRuleId.

type GetSdOptimizationRulesOptimizationRuleIdResp

type GetSdOptimizationRulesOptimizationRuleIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OptimizationRule
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetSdOptimizationRulesOptimizationRuleIdResp

func ParseGetSdOptimizationRulesOptimizationRuleIdResp(rsp *http.Response) (*GetSdOptimizationRulesOptimizationRuleIdResp, error)

ParseGetSdOptimizationRulesOptimizationRuleIdResp parses an HTTP response from a GetSdOptimizationRulesOptimizationRuleIdWithResponse call

func (GetSdOptimizationRulesOptimizationRuleIdResp) Status

Status returns HTTPResponse.Status

func (GetSdOptimizationRulesOptimizationRuleIdResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetSnapshotParams

type GetSnapshotParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetSnapshotParams defines parameters for GetSnapshot.

type GetSnapshotResp

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

func ParseGetSnapshotResp

func ParseGetSnapshotResp(rsp *http.Response) (*GetSnapshotResp, error)

ParseGetSnapshotResp parses an HTTP response from a GetSnapshotWithResponse call

func (GetSnapshotResp) Status

func (r GetSnapshotResp) Status() string

Status returns HTTPResponse.Status

func (GetSnapshotResp) StatusCode

func (r GetSnapshotResp) 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 GetTargetBidRecommendationsParams

type GetTargetBidRecommendationsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetTargetBidRecommendationsParams defines parameters for GetTargetBidRecommendations.

type GetTargetBidRecommendationsResp

type GetTargetBidRecommendationsResp struct {
	Body                                               []byte
	HTTPResponse                                       *http.Response
	ApplicationvndSdtargetingrecommendationsV31JSON207 *SDTargetingBidRecommendationsResponseV31
	ApplicationvndSdtargetingrecommendationsV32JSON207 *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 GetTargetRecommendationsParams

type GetTargetRecommendationsParams struct {
	// Locale The requested locale from query parameter to return translated category recommendations.
	Locale *SDTargetingRecommendationsLocale `form:"locale,omitempty" json:"locale,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `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
	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 GetTargetsExParams

type GetTargetsExParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetTargetsExParams defines parameters for GetTargetsEx.

type GetTargetsExResp

type GetTargetsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TargetingClauseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetTargetsExResp

func ParseGetTargetsExResp(rsp *http.Response) (*GetTargetsExResp, error)

ParseGetTargetsExResp parses an HTTP response from a GetTargetsExWithResponse call

func (GetTargetsExResp) Status

func (r GetTargetsExResp) Status() string

Status returns HTTPResponse.Status

func (GetTargetsExResp) StatusCode

func (r GetTargetsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTargetsParams

type GetTargetsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

GetTargetsParams defines parameters for GetTargets.

type GetTargetsResp

type GetTargetsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TargetingClause
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseGetTargetsResp

func ParseGetTargetsResp(rsp *http.Response) (*GetTargetsResp, error)

ParseGetTargetsResp parses an HTTP response from a GetTargetsWithResponse call

func (GetTargetsResp) Status

func (r GetTargetsResp) Status() string

Status returns HTTPResponse.Status

func (GetTargetsResp) StatusCode

func (r GetTargetsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HeadlineCreativeProperties

type HeadlineCreativeProperties struct {
	// Headline A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50.
	Headline *string `json:"headline,omitempty"`
}

HeadlineCreativeProperties User-customizable properties of a creative with headline.

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Image

type Image struct {
	// AssetId The unique identifier of the image asset. This assetId comes from the Creative Asset Library.
	AssetId string `json:"assetId"`

	// AssetVersion The identifier of the particular image assetversion.
	AssetVersion string `json:"assetVersion"`

	// CroppingCoordinates Optional cropping coordinates to apply to the image.
	CroppingCoordinates *struct {
		// Height Pixel height of the cropping zone.
		Height int `json:"height"`

		// Left Pixel distance from the left edge of the cropping zone to the left edge of the original image.
		Left int `json:"left"`

		// Top Pixel distance from the top edge of the cropping zone to the top edge of the original image.
		Top int `json:"top"`

		// Width Pixel width of the cropping zone.
		Width int `json:"width"`
	} `json:"croppingCoordinates,omitempty"`
}

Image This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table. |Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats| |------|-----------|-----------|-----------|-----------| |Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF| |Brand Logo|1MB|600|100|JPEG, JPG, PNG| Note: For square custom images the cropped image should be 628x628 at minimum.

type LandingPageType

type LandingPageType string

LandingPageType The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.

const (
	MOMENT        LandingPageType = "MOMENT"
	OFFAMAZONLINK LandingPageType = "OFF_AMAZON_LINK"
	STORE         LandingPageType = "STORE"
)

Defines values for LandingPageType.

type LandingPageURL

type LandingPageURL = string

LandingPageURL The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields. ||Specifications| |------------------|------------------| |LandingPageType| Description| |STORE| Not yet supported. The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)| |MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)| |OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |

type ListAdGroupsExParams

type ListAdGroupsExParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of ad groups. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

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

	// StateFilter Optional. The returned array is filtered to include only campaigns with state set to one of the values in the comma-delimited list.
	StateFilter *ListAdGroupsExParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// CampaignIdFilter Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the comma-delimited list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// AdGroupIdFilter Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// Name Optional. The returned array includes only ad groups with the specified name.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListAdGroupsExParams defines parameters for ListAdGroupsEx.

type ListAdGroupsExParamsStateFilter

type ListAdGroupsExParamsStateFilter string

ListAdGroupsExParamsStateFilter defines parameters for ListAdGroupsEx.

const (
	ListAdGroupsExParamsStateFilterArchived              ListAdGroupsExParamsStateFilter = "archived"
	ListAdGroupsExParamsStateFilterEnabled               ListAdGroupsExParamsStateFilter = "enabled"
	ListAdGroupsExParamsStateFilterEnabledArchived       ListAdGroupsExParamsStateFilter = "enabled, archived"
	ListAdGroupsExParamsStateFilterEnabledPaused         ListAdGroupsExParamsStateFilter = "enabled, paused"
	ListAdGroupsExParamsStateFilterEnabledPausedArchived ListAdGroupsExParamsStateFilter = "enabled, paused, archived"
	ListAdGroupsExParamsStateFilterPaused                ListAdGroupsExParamsStateFilter = "paused"
	ListAdGroupsExParamsStateFilterPausedArchived        ListAdGroupsExParamsStateFilter = "paused, archived"
)

Defines values for ListAdGroupsExParamsStateFilter.

type ListAdGroupsExResp

type ListAdGroupsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]AdGroupResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListAdGroupsExResp

func ParseListAdGroupsExResp(rsp *http.Response) (*ListAdGroupsExResp, error)

ParseListAdGroupsExResp parses an HTTP response from a ListAdGroupsExWithResponse call

func (ListAdGroupsExResp) Status

func (r ListAdGroupsExResp) Status() string

Status returns HTTPResponse.Status

func (ListAdGroupsExResp) StatusCode

func (r ListAdGroupsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAdGroupsParams

type ListAdGroupsParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of campaigns. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of AdGroup objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten ad groups set `startIndex=0` and `count=10`. To return the next ten ad groups, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list.
	StateFilter *ListAdGroupsParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// CampaignIdFilter Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the specified comma-delimited list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// AdGroupIdFilter Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// Name Optional. The returned array includes only ad groups with the specified name.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListAdGroupsParams defines parameters for ListAdGroups.

type ListAdGroupsParamsStateFilter

type ListAdGroupsParamsStateFilter string

ListAdGroupsParamsStateFilter defines parameters for ListAdGroups.

const (
	ListAdGroupsParamsStateFilterArchived              ListAdGroupsParamsStateFilter = "archived"
	ListAdGroupsParamsStateFilterEnabled               ListAdGroupsParamsStateFilter = "enabled"
	ListAdGroupsParamsStateFilterEnabledArchived       ListAdGroupsParamsStateFilter = "enabled, archived"
	ListAdGroupsParamsStateFilterEnabledPaused         ListAdGroupsParamsStateFilter = "enabled, paused"
	ListAdGroupsParamsStateFilterEnabledPausedArchived ListAdGroupsParamsStateFilter = "enabled, paused, archived"
	ListAdGroupsParamsStateFilterPaused                ListAdGroupsParamsStateFilter = "paused"
	ListAdGroupsParamsStateFilterPausedArchived        ListAdGroupsParamsStateFilter = "paused, archived"
)

Defines values for ListAdGroupsParamsStateFilter.

type ListAdGroupsResp

type ListAdGroupsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]AdGroup
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListAdGroupsResp

func ParseListAdGroupsResp(rsp *http.Response) (*ListAdGroupsResp, error)

ParseListAdGroupsResp parses an HTTP response from a ListAdGroupsWithResponse call

func (ListAdGroupsResp) Status

func (r ListAdGroupsResp) Status() string

Status returns HTTPResponse.Status

func (ListAdGroupsResp) StatusCode

func (r ListAdGroupsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCampaignsExParams

type ListCampaignsExParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of campaigns. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

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

	// StateFilter Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.
	StateFilter *ListCampaignsExParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// Name Optional. The returned array includes only campaign with the specified name using an exact string match.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// CampaignIdFilter Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// PortfolioIdFilter Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.
	PortfolioIdFilter *string `form:"portfolioIdFilter,omitempty" json:"portfolioIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListCampaignsExParams defines parameters for ListCampaignsEx.

type ListCampaignsExParamsStateFilter

type ListCampaignsExParamsStateFilter string

ListCampaignsExParamsStateFilter defines parameters for ListCampaignsEx.

const (
	ListCampaignsExParamsStateFilterArchived              ListCampaignsExParamsStateFilter = "archived"
	ListCampaignsExParamsStateFilterEnabled               ListCampaignsExParamsStateFilter = "enabled"
	ListCampaignsExParamsStateFilterEnabledArchived       ListCampaignsExParamsStateFilter = "enabled, archived"
	ListCampaignsExParamsStateFilterEnabledPaused         ListCampaignsExParamsStateFilter = "enabled, paused"
	ListCampaignsExParamsStateFilterEnabledPausedArchived ListCampaignsExParamsStateFilter = "enabled, paused, archived"
	ListCampaignsExParamsStateFilterPaused                ListCampaignsExParamsStateFilter = "paused"
	ListCampaignsExParamsStateFilterPausedArchived        ListCampaignsExParamsStateFilter = "paused, archived"
)

Defines values for ListCampaignsExParamsStateFilter.

type ListCampaignsExResp

type ListCampaignsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]CampaignResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListCampaignsExResp

func ParseListCampaignsExResp(rsp *http.Response) (*ListCampaignsExResp, error)

ParseListCampaignsExResp parses an HTTP response from a ListCampaignsExWithResponse call

func (ListCampaignsExResp) Status

func (r ListCampaignsExResp) Status() string

Status returns HTTPResponse.Status

func (ListCampaignsExResp) StatusCode

func (r ListCampaignsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCampaignsParams

type ListCampaignsParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of campaigns. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

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

	// StateFilter Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.
	StateFilter *ListCampaignsParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// Name Optional. The returned array includes only campaign with the specified name using an exact string match.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// CampaignIdFilter Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// PortfolioIdFilter Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.
	PortfolioIdFilter *string `form:"portfolioIdFilter,omitempty" json:"portfolioIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListCampaignsParams defines parameters for ListCampaigns.

type ListCampaignsParamsStateFilter

type ListCampaignsParamsStateFilter string

ListCampaignsParamsStateFilter defines parameters for ListCampaigns.

const (
	ListCampaignsParamsStateFilterArchived              ListCampaignsParamsStateFilter = "archived"
	ListCampaignsParamsStateFilterEnabled               ListCampaignsParamsStateFilter = "enabled"
	ListCampaignsParamsStateFilterEnabledArchived       ListCampaignsParamsStateFilter = "enabled, archived"
	ListCampaignsParamsStateFilterEnabledPaused         ListCampaignsParamsStateFilter = "enabled, paused"
	ListCampaignsParamsStateFilterEnabledPausedArchived ListCampaignsParamsStateFilter = "enabled, paused, archived"
	ListCampaignsParamsStateFilterPaused                ListCampaignsParamsStateFilter = "paused"
	ListCampaignsParamsStateFilterPausedArchived        ListCampaignsParamsStateFilter = "paused, archived"
)

Defines values for ListCampaignsParamsStateFilter.

type ListCampaignsResp

type ListCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Campaign
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListCampaignsResp

func ParseListCampaignsResp(rsp *http.Response) (*ListCampaignsResp, error)

ParseListCampaignsResp parses an HTTP response from a ListCampaignsWithResponse call

func (ListCampaignsResp) Status

func (r ListCampaignsResp) Status() string

Status returns HTTPResponse.Status

func (ListCampaignsResp) StatusCode

func (r ListCampaignsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCreativeModerationsParams

type ListCreativeModerationsParams struct {
	// Language The language of the returned creative moderation metadata.
	Language Locale `form:"language" json:"language"`

	// StartIndex Sets a cursor into the requested set of creative moderations. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creative moderations set `startIndex=0` and `count=10`. To return the next ten creative moderations, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// AdGroupIdFilter The returned array includes only creative moderations associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CreativeIdFilter The returned array includes only creative moderations with creative identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.
	CreativeIdFilter *string `form:"creativeIdFilter,omitempty" json:"creativeIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListCreativeModerationsParams defines parameters for ListCreativeModerations.

type ListCreativeModerationsResp

type ListCreativeModerationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]CreativeModeration
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListCreativeModerationsResp

func ParseListCreativeModerationsResp(rsp *http.Response) (*ListCreativeModerationsResp, error)

ParseListCreativeModerationsResp parses an HTTP response from a ListCreativeModerationsWithResponse call

func (ListCreativeModerationsResp) Status

Status returns HTTPResponse.Status

func (ListCreativeModerationsResp) StatusCode

func (r ListCreativeModerationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCreativesParams

type ListCreativesParams struct {
	// StartIndex Sets a cursor into the requested set of creatives. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creatives set `startIndex=0` and `count=10`. To return the next ten creatives, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// AdGroupIdFilter The returned array includes only creatives associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CreativeIdFilter The returned array includes only creatives with identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.
	CreativeIdFilter *string `form:"creativeIdFilter,omitempty" json:"creativeIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListCreativesParams defines parameters for ListCreatives.

type ListCreativesResp

type ListCreativesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Creative
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListCreativesResp

func ParseListCreativesResp(rsp *http.Response) (*ListCreativesResp, error)

ParseListCreativesResp parses an HTTP response from a ListCreativesWithResponse call

func (ListCreativesResp) Status

func (r ListCreativesResp) Status() string

Status returns HTTPResponse.Status

func (ListCreativesResp) StatusCode

func (r ListCreativesResp) StatusCode() int

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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

ListDomainsParams defines parameters for ListDomains.

type ListDomainsResp

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

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 ListLocationsParams

type ListLocationsParams struct {
	// StartIndex Optional. 0-indexed record offset for the result set. Defaults to 0.
	StartIndex *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Number of records to include in the paged response. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`.
	StateFilter *ListLocationsParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// AdGroupIdFilter Optional list of comma separated adGroupIds. Restricts results to locations with the specified `adGroupId`.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional list of comma separated campaignIds. Restricts results to locations with the specified `campaignId`.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListLocationsParams defines parameters for ListLocations.

type ListLocationsParamsStateFilter

type ListLocationsParamsStateFilter string

ListLocationsParamsStateFilter defines parameters for ListLocations.

const (
	ListLocationsParamsStateFilterEnabled ListLocationsParamsStateFilter = "enabled"
)

Defines values for ListLocationsParamsStateFilter.

type ListLocationsResp

type ListLocationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Location
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListLocationsResp

func ParseListLocationsResp(rsp *http.Response) (*ListLocationsResp, error)

ParseListLocationsResp parses an HTTP response from a ListLocationsWithResponse call

func (ListLocationsResp) Status

func (r ListLocationsResp) Status() string

Status returns HTTPResponse.Status

func (ListLocationsResp) StatusCode

func (r ListLocationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNegativeTargetingClausesExParams

type ListNegativeTargetingClausesExParams struct {
	// StartIndex Optional. 0-indexed record offset for the result set. Defaults to 0.
	StartIndex *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Number of records to include in the paged response. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include `enabled`, `paused`, and `archived`.
	StateFilter *ListNegativeTargetingClausesExParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// TargetIdFilter Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list
	TargetIdFilter *string `form:"targetIdFilter,omitempty" json:"targetIdFilter,omitempty"`

	// AdGroupIdFilter Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. Restricts results to ads within campaigns specified in the comma-separated list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListNegativeTargetingClausesExParams defines parameters for ListNegativeTargetingClausesEx.

type ListNegativeTargetingClausesExParamsStateFilter

type ListNegativeTargetingClausesExParamsStateFilter string

ListNegativeTargetingClausesExParamsStateFilter defines parameters for ListNegativeTargetingClausesEx.

const (
	ListNegativeTargetingClausesExParamsStateFilterArchived              ListNegativeTargetingClausesExParamsStateFilter = "archived"
	ListNegativeTargetingClausesExParamsStateFilterEnabled               ListNegativeTargetingClausesExParamsStateFilter = "enabled"
	ListNegativeTargetingClausesExParamsStateFilterEnabledArchived       ListNegativeTargetingClausesExParamsStateFilter = "enabled, archived"
	ListNegativeTargetingClausesExParamsStateFilterEnabledPaused         ListNegativeTargetingClausesExParamsStateFilter = "enabled, paused"
	ListNegativeTargetingClausesExParamsStateFilterEnabledPausedArchived ListNegativeTargetingClausesExParamsStateFilter = "enabled, paused, archived"
	ListNegativeTargetingClausesExParamsStateFilterPaused                ListNegativeTargetingClausesExParamsStateFilter = "paused"
	ListNegativeTargetingClausesExParamsStateFilterPausedArchived        ListNegativeTargetingClausesExParamsStateFilter = "paused, archived"
)

Defines values for ListNegativeTargetingClausesExParamsStateFilter.

type ListNegativeTargetingClausesExResp

type ListNegativeTargetingClausesExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]NegativeTargetingClauseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListNegativeTargetingClausesExResp

func ParseListNegativeTargetingClausesExResp(rsp *http.Response) (*ListNegativeTargetingClausesExResp, error)

ParseListNegativeTargetingClausesExResp parses an HTTP response from a ListNegativeTargetingClausesExWithResponse call

func (ListNegativeTargetingClausesExResp) Status

Status returns HTTPResponse.Status

func (ListNegativeTargetingClausesExResp) StatusCode

func (r ListNegativeTargetingClausesExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNegativeTargetingClausesParams

type ListNegativeTargetingClausesParams struct {
	// StartIndex Optional. 0-indexed record offset for the result set. Defaults to 0.
	StartIndex *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Number of records to include in the paged response. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.
	StateFilter *ListNegativeTargetingClausesParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// AdGroupIdFilter Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListNegativeTargetingClausesParams defines parameters for ListNegativeTargetingClauses.

type ListNegativeTargetingClausesParamsStateFilter

type ListNegativeTargetingClausesParamsStateFilter string

ListNegativeTargetingClausesParamsStateFilter defines parameters for ListNegativeTargetingClauses.

const (
	ListNegativeTargetingClausesParamsStateFilterArchived              ListNegativeTargetingClausesParamsStateFilter = "archived"
	ListNegativeTargetingClausesParamsStateFilterEnabled               ListNegativeTargetingClausesParamsStateFilter = "enabled"
	ListNegativeTargetingClausesParamsStateFilterEnabledArchived       ListNegativeTargetingClausesParamsStateFilter = "enabled, archived"
	ListNegativeTargetingClausesParamsStateFilterEnabledPaused         ListNegativeTargetingClausesParamsStateFilter = "enabled, paused"
	ListNegativeTargetingClausesParamsStateFilterEnabledPausedArchived ListNegativeTargetingClausesParamsStateFilter = "enabled, paused, archived"
	ListNegativeTargetingClausesParamsStateFilterPaused                ListNegativeTargetingClausesParamsStateFilter = "paused"
	ListNegativeTargetingClausesParamsStateFilterPausedArchived        ListNegativeTargetingClausesParamsStateFilter = "paused, archived"
)

Defines values for ListNegativeTargetingClausesParamsStateFilter.

type ListNegativeTargetingClausesResp

type ListNegativeTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]NegativeTargetingClause
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListNegativeTargetingClausesResp

func ParseListNegativeTargetingClausesResp(rsp *http.Response) (*ListNegativeTargetingClausesResp, error)

ParseListNegativeTargetingClausesResp parses an HTTP response from a ListNegativeTargetingClausesWithResponse call

func (ListNegativeTargetingClausesResp) Status

Status returns HTTPResponse.Status

func (ListNegativeTargetingClausesResp) StatusCode

func (r ListNegativeTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListOptimizationRulesParams

type ListOptimizationRulesParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of optimization rules. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of OptimizationRule objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten optimization rules set `startIndex=0` and `count=10`. To return the next ten optimization rules, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. The returned array is filtered to include only optimization rules with state set to one of the values in the specified comma-delimited list.
	// Available values:
	//   - enabled
	//   - paused [COMING LATER]
	//   - enabled, paused [COMING LATER]
	StateFilter *string `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// Name Optional. The returned array includes only optimization rules with the specified name using an exact string match.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// OptimizationRuleIdFilter Optional. The returned array is filtered to include only optimization rules associated with the optimization rule identifiers in the specified comma-delimited list.
	//
	// Maximum size limit 50.
	OptimizationRuleIdFilter *string `form:"optimizationRuleIdFilter,omitempty" json:"optimizationRuleIdFilter,omitempty"`

	// AdGroupIdFilter Optional. The returned array is filtered to include only optimization rules associated with the ad group identifiers in the comma-delimited list.
	//
	// Maximum size limit 50.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListOptimizationRulesParams defines parameters for ListOptimizationRules.

type ListOptimizationRulesResp

type ListOptimizationRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]OptimizationRule
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListOptimizationRulesResp

func ParseListOptimizationRulesResp(rsp *http.Response) (*ListOptimizationRulesResp, error)

ParseListOptimizationRulesResp parses an HTTP response from a ListOptimizationRulesWithResponse call

func (ListOptimizationRulesResp) Status

func (r ListOptimizationRulesResp) Status() string

Status returns HTTPResponse.Status

func (ListOptimizationRulesResp) StatusCode

func (r ListOptimizationRulesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListProductAdsExParams

type ListProductAdsExParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of product ads. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of ProduceAdEx objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ads set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.
	StateFilter *ListProductAdsExParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// AdIdFilter Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.
	AdIdFilter *string `form:"adIdFilter,omitempty" json:"adIdFilter,omitempty"`

	// AdGroupIdFilter Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListProductAdsExParams defines parameters for ListProductAdsEx.

type ListProductAdsExParamsStateFilter

type ListProductAdsExParamsStateFilter string

ListProductAdsExParamsStateFilter defines parameters for ListProductAdsEx.

const (
	ListProductAdsExParamsStateFilterArchived              ListProductAdsExParamsStateFilter = "archived"
	ListProductAdsExParamsStateFilterEnabled               ListProductAdsExParamsStateFilter = "enabled"
	ListProductAdsExParamsStateFilterEnabledArchived       ListProductAdsExParamsStateFilter = "enabled, archived"
	ListProductAdsExParamsStateFilterEnabledPaused         ListProductAdsExParamsStateFilter = "enabled, paused"
	ListProductAdsExParamsStateFilterEnabledPausedArchived ListProductAdsExParamsStateFilter = "enabled, paused, archived"
	ListProductAdsExParamsStateFilterPaused                ListProductAdsExParamsStateFilter = "paused"
	ListProductAdsExParamsStateFilterPausedArchived        ListProductAdsExParamsStateFilter = "paused, archived"
)

Defines values for ListProductAdsExParamsStateFilter.

type ListProductAdsExResp

type ListProductAdsExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ProductAdResponseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListProductAdsExResp

func ParseListProductAdsExResp(rsp *http.Response) (*ListProductAdsExResp, error)

ParseListProductAdsExResp parses an HTTP response from a ListProductAdsExWithResponse call

func (ListProductAdsExResp) Status

func (r ListProductAdsExResp) Status() string

Status returns HTTPResponse.Status

func (ListProductAdsExResp) StatusCode

func (r ListProductAdsExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListProductAdsParams

type ListProductAdsParams struct {
	// StartIndex Optional. Sets a cursor into the requested set of product ads. 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 *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Sets the number of ProductAd objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ad set `startIndex=0` and `count=10`. To return the next ten product ads, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. The returned array is filtered to include only products ads associated with campaigns that have state set to one of the values in the comma-delimited list.
	StateFilter *ListProductAdsParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// AdIdFilter Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.
	AdIdFilter *string `form:"adIdFilter,omitempty" json:"adIdFilter,omitempty"`

	// AdGroupIdFilter Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListProductAdsParams defines parameters for ListProductAds.

type ListProductAdsParamsStateFilter

type ListProductAdsParamsStateFilter string

ListProductAdsParamsStateFilter defines parameters for ListProductAds.

const (
	ListProductAdsParamsStateFilterArchived              ListProductAdsParamsStateFilter = "archived"
	ListProductAdsParamsStateFilterEnabled               ListProductAdsParamsStateFilter = "enabled"
	ListProductAdsParamsStateFilterEnabledArchived       ListProductAdsParamsStateFilter = "enabled, archived"
	ListProductAdsParamsStateFilterEnabledPaused         ListProductAdsParamsStateFilter = "enabled, paused"
	ListProductAdsParamsStateFilterEnabledPausedArchived ListProductAdsParamsStateFilter = "enabled, paused, archived"
	ListProductAdsParamsStateFilterPaused                ListProductAdsParamsStateFilter = "paused"
	ListProductAdsParamsStateFilterPausedArchived        ListProductAdsParamsStateFilter = "paused, archived"
)

Defines values for ListProductAdsParamsStateFilter.

type ListProductAdsResp

type ListProductAdsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ProductAd
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListProductAdsResp

func ParseListProductAdsResp(rsp *http.Response) (*ListProductAdsResp, error)

ParseListProductAdsResp parses an HTTP response from a ListProductAdsWithResponse call

func (ListProductAdsResp) Status

func (r ListProductAdsResp) Status() string

Status returns HTTPResponse.Status

func (ListProductAdsResp) StatusCode

func (r ListProductAdsResp) 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 ClientHeader `json:"Amazon-Advertising-API-ClientId"`

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

ListRequestStatusParams defines parameters for ListRequestStatus.

type ListRequestStatusResp

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

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 ListTargetingClausesExParams

type ListTargetingClausesExParams struct {
	// StartIndex Optional. 0-indexed record offset for the result set. Defaults to 0.
	StartIndex *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Number of records to include in the paged response. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.
	StateFilter *ListTargetingClausesExParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// TargetIdFilter Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list
	TargetIdFilter *string `form:"targetIdFilter,omitempty" json:"targetIdFilter,omitempty"`

	// AdGroupIdFilter Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. Restricts results to ads within campaigns specified in comma-separated list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListTargetingClausesExParams defines parameters for ListTargetingClausesEx.

type ListTargetingClausesExParamsStateFilter

type ListTargetingClausesExParamsStateFilter string

ListTargetingClausesExParamsStateFilter defines parameters for ListTargetingClausesEx.

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

Defines values for ListTargetingClausesExParamsStateFilter.

type ListTargetingClausesExResp

type ListTargetingClausesExResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]TargetingClauseEx
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON404      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListTargetingClausesExResp

func ParseListTargetingClausesExResp(rsp *http.Response) (*ListTargetingClausesExResp, error)

ParseListTargetingClausesExResp parses an HTTP response from a ListTargetingClausesExWithResponse call

func (ListTargetingClausesExResp) Status

Status returns HTTPResponse.Status

func (ListTargetingClausesExResp) StatusCode

func (r ListTargetingClausesExResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTargetingClausesParams

type ListTargetingClausesParams struct {
	// StartIndex Optional. 0-indexed record offset for the result set. Defaults to 0.
	StartIndex *int32 `form:"startIndex,omitempty" json:"startIndex,omitempty"`

	// Count Optional. Number of records to include in the paged response. Defaults to max page size.
	Count *int32 `form:"count,omitempty" json:"count,omitempty"`

	// StateFilter Optional. Restricts results to those with `state` set to values in the specified comma-separated list.
	StateFilter *ListTargetingClausesParamsStateFilter `form:"stateFilter,omitempty" json:"stateFilter,omitempty"`

	// AdGroupIdFilter Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.
	AdGroupIdFilter *string `form:"adGroupIdFilter,omitempty" json:"adGroupIdFilter,omitempty"`

	// CampaignIdFilter Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.
	CampaignIdFilter *string `form:"campaignIdFilter,omitempty" json:"campaignIdFilter,omitempty"`

	// 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

ListTargetingClausesParams defines parameters for ListTargetingClauses.

type ListTargetingClausesParamsStateFilter

type ListTargetingClausesParamsStateFilter string

ListTargetingClausesParamsStateFilter defines parameters for ListTargetingClauses.

const (
	ListTargetingClausesParamsStateFilterArchived              ListTargetingClausesParamsStateFilter = "archived"
	ListTargetingClausesParamsStateFilterEnabled               ListTargetingClausesParamsStateFilter = "enabled"
	ListTargetingClausesParamsStateFilterEnabledArchived       ListTargetingClausesParamsStateFilter = "enabled, archived"
	ListTargetingClausesParamsStateFilterEnabledPaused         ListTargetingClausesParamsStateFilter = "enabled, paused"
	ListTargetingClausesParamsStateFilterEnabledPausedArchived ListTargetingClausesParamsStateFilter = "enabled, paused, archived"
	ListTargetingClausesParamsStateFilterPaused                ListTargetingClausesParamsStateFilter = "paused"
	ListTargetingClausesParamsStateFilterPausedArchived        ListTargetingClausesParamsStateFilter = "paused, archived"
)

Defines values for ListTargetingClausesParamsStateFilter.

type ListTargetingClausesResp

type ListTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]TargetingClause
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseListTargetingClausesResp

func ParseListTargetingClausesResp(rsp *http.Response) (*ListTargetingClausesResp, error)

ParseListTargetingClausesResp parses an HTTP response from a ListTargetingClausesWithResponse call

func (ListTargetingClausesResp) Status

func (r ListTargetingClausesResp) Status() string

Status returns HTTPResponse.Status

func (ListTargetingClausesResp) StatusCode

func (r ListTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Locale

type Locale string

Locale Locale string as described in [BCP 47](https://tools.ietf.org/html/bcp47). For example, `en-US`

const (
	LocaleArAE Locale = "ar-AE"
	LocaleDeDE Locale = "de-DE"
	LocaleEnAE Locale = "en-AE"
	LocaleEnCA Locale = "en-CA"
	LocaleEnDE Locale = "en-DE"
	LocaleEnES Locale = "en-ES"
	LocaleEnFR Locale = "en-FR"
	LocaleEnGB Locale = "en-GB"
	LocaleEnIN Locale = "en-IN"
	LocaleEnIT Locale = "en-IT"
	LocaleEnJP Locale = "en-JP"
	LocaleEnUS Locale = "en-US"
	LocaleEsES Locale = "es-ES"
	LocaleEsMX Locale = "es-MX"
	LocaleFrCA Locale = "fr-CA"
	LocaleFrFR Locale = "fr-FR"
	LocaleHiIN Locale = "hi-IN"
	LocaleItIT Locale = "it-IT"
	LocaleJaJP Locale = "ja-JP"
	LocaleKoKR Locale = "ko-KR"
	LocaleZhCN Locale = "zh-CN"
)

Defines values for Locale.

type Location

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

	// Expression The Location definition.
	Expression *[]LocationExpression `json:"expression,omitempty"`

	// LocationExpressionId The identifier of the location.
	LocationExpressionId *LocationExpressionId `json:"locationExpressionId,omitempty"`

	// ResolvedExpression The human-readable location definition.
	ResolvedExpression *[]ResolvedLocationExpression `json:"resolvedExpression,omitempty"`
	State              *LocationState                `json:"state,omitempty"`
}

Location defines model for Location.

type LocationExpression

type LocationExpression struct {
	// Type The location category.
	Type *LocationPredicate `json:"type,omitempty"`

	// Value The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.
	Value *string `json:"value,omitempty"`
}

LocationExpression defines model for LocationExpression.

type LocationExpressionId

type LocationExpressionId = int64

LocationExpressionId The identifier of the location.

type LocationPredicate

type LocationPredicate string

LocationPredicate The location category.

const (
	LocationPredicateLocation LocationPredicate = "location"
)

Defines values for LocationPredicate.

type LocationState

type LocationState string

LocationState defines model for Location.State.

const (
	LocationStateEnabled LocationState = "enabled"
)

Defines values for LocationState.

type LogoCreativeProperties

type LogoCreativeProperties struct {
	// |Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|
	// |------|-----------|-----------|-----------|-----------|
	// |Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|
	// |Brand Logo|1MB|600|100|JPEG, JPG, PNG|
	// Note: For square custom images the cropped image should be 628x628 at minimum.
	BrandLogo *Image `json:"brandLogo,omitempty"`
}

LogoCreativeProperties User-customizable properties of a creative with a logo.

type NegativeTargetingClause

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

	// Expression The expression to negatively match against.
	// * 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.
	Expression     *[]NegativeTargetingExpression         `json:"expression,omitempty"`
	ExpressionType *NegativeTargetingClauseExpressionType `json:"expressionType,omitempty"`

	// ResolvedExpression The resolved negative targeting expression.
	ResolvedExpression *[]NegativeTargetingExpression `json:"resolvedExpression,omitempty"`
	State              *NegativeTargetingClauseState  `json:"state,omitempty"`
	TargetId           *TargetId                      `json:"targetId,omitempty"`
}

NegativeTargetingClause defines model for NegativeTargetingClause.

type NegativeTargetingClauseEx

type NegativeTargetingClauseEx struct {
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// CreationDate Epoch date the target was created.
	CreationDate *int64 `json:"creationDate,omitempty"`

	// Expression The expression to negatively match against.
	// * 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.
	Expression *[]struct {
		// Type The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.
		Type *NegativeTargetingClauseExExpressionType `json:"type,omitempty"`

		// Value The value to be negatively targeted. Used only in manual expressions.
		Value *string `json:"value,omitempty"`
	} `json:"expression,omitempty"`

	// LastUpdatedDate Epoch date of the last update to any property associated with the target.
	LastUpdatedDate      *int64                                         `json:"lastUpdatedDate,omitempty"`
	RenameExpressionType *NegativeTargetingClauseExRenameExpressionType `json:"renameExpressionType,omitempty"`

	// ServingStatus The status of the target.
	ServingStatus *NegativeTargetingClauseExServingStatus `json:"servingStatus,omitempty"`
	State         *NegativeTargetingClauseExState         `json:"state,omitempty"`
	TargetId      *float32                                `json:"targetId,omitempty"`
}

NegativeTargetingClauseEx defines model for NegativeTargetingClauseEx.

type NegativeTargetingClauseExExpressionType

type NegativeTargetingClauseExExpressionType string

NegativeTargetingClauseExExpressionType The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.

const (
	NegativeTargetingClauseExExpressionTypeAsinBrandSameAs NegativeTargetingClauseExExpressionType = "asinBrandSameAs"
	NegativeTargetingClauseExExpressionTypeAsinSameAs      NegativeTargetingClauseExExpressionType = "asinSameAs"
)

Defines values for NegativeTargetingClauseExExpressionType.

type NegativeTargetingClauseExRenameExpressionType

type NegativeTargetingClauseExRenameExpressionType string

NegativeTargetingClauseExRenameExpressionType defines model for NegativeTargetingClauseEx.RenameExpressionType.

const (
	NegativeTargetingClauseExRenameExpressionTypeAuto   NegativeTargetingClauseExRenameExpressionType = "auto"
	NegativeTargetingClauseExRenameExpressionTypeManual NegativeTargetingClauseExRenameExpressionType = "manual"
)

Defines values for NegativeTargetingClauseExRenameExpressionType.

type NegativeTargetingClauseExServingStatus

type NegativeTargetingClauseExServingStatus string

NegativeTargetingClauseExServingStatus The status of the target.

const (
	NegativeTargetingClauseExServingStatusACCOUNTOUTOFBUDGET          NegativeTargetingClauseExServingStatus = "ACCOUNT_OUT_OF_BUDGET"
	NegativeTargetingClauseExServingStatusADGROUPARCHIVED             NegativeTargetingClauseExServingStatus = "AD_GROUP_ARCHIVED"
	NegativeTargetingClauseExServingStatusADGROUPINCOMPLETE           NegativeTargetingClauseExServingStatus = "AD_GROUP_INCOMPLETE"
	NegativeTargetingClauseExServingStatusADGROUPLOWBID               NegativeTargetingClauseExServingStatus = "AD_GROUP_LOW_BID"
	NegativeTargetingClauseExServingStatusADGROUPPAUSED               NegativeTargetingClauseExServingStatus = "AD_GROUP_PAUSED"
	NegativeTargetingClauseExServingStatusADGROUPSTATUSENABLED        NegativeTargetingClauseExServingStatus = "AD_GROUP_STATUS_ENABLED"
	NegativeTargetingClauseExServingStatusADPOLICINGPENDINGREVIEW     NegativeTargetingClauseExServingStatus = "AD_POLICING_PENDING_REVIEW"
	NegativeTargetingClauseExServingStatusADVERTISEREXCEEDSPENDSLIMIT NegativeTargetingClauseExServingStatus = "ADVERTISER_EXCEED_SPENDS_LIMIT"
	NegativeTargetingClauseExServingStatusADVERTISERPAUSED            NegativeTargetingClauseExServingStatus = "ADVERTISER_PAUSED"
	NegativeTargetingClauseExServingStatusADVERTISERPAYMENTFAILURE    NegativeTargetingClauseExServingStatus = "ADVERTISER_PAYMENT_FAILURE"
	NegativeTargetingClauseExServingStatusADVERTISERSTATUSENABLED     NegativeTargetingClauseExServingStatus = "ADVERTISER_STATUS_ENABLED"
	NegativeTargetingClauseExServingStatusCAMPAIGNARCHIVED            NegativeTargetingClauseExServingStatus = "CAMPAIGN_ARCHIVED"
	NegativeTargetingClauseExServingStatusCAMPAIGNINCOMPLETE          NegativeTargetingClauseExServingStatus = "CAMPAIGN_INCOMPLETE"
	NegativeTargetingClauseExServingStatusCAMPAIGNOUTOFBUDGET         NegativeTargetingClauseExServingStatus = "CAMPAIGN_OUT_OF_BUDGET"
	NegativeTargetingClauseExServingStatusCAMPAIGNPAUSED              NegativeTargetingClauseExServingStatus = "CAMPAIGN_PAUSED"
	NegativeTargetingClauseExServingStatusENDED                       NegativeTargetingClauseExServingStatus = "ENDED"
	NegativeTargetingClauseExServingStatusINELIGIBLE                  NegativeTargetingClauseExServingStatus = "INELIGIBLE"
	NegativeTargetingClauseExServingStatusPENDINGSTARTDATE            NegativeTargetingClauseExServingStatus = "PENDING_START_DATE"
	NegativeTargetingClauseExServingStatusPORTFOLIOENDED              NegativeTargetingClauseExServingStatus = "PORTFOLIO_ENDED"
	NegativeTargetingClauseExServingStatusPORTFOLIOOUTOFBUDGET        NegativeTargetingClauseExServingStatus = "PORTFOLIO_OUT_OF_BUDGET"
	NegativeTargetingClauseExServingStatusSTATUSUNAVAILABLE           NegativeTargetingClauseExServingStatus = "STATUS_UNAVAILABLE"
	NegativeTargetingClauseExServingStatusTARGETSTATUSARCHIVED        NegativeTargetingClauseExServingStatus = "TARGET_STATUS_ARCHIVED"
	NegativeTargetingClauseExServingStatusTARGETSTATUSLIVE            NegativeTargetingClauseExServingStatus = "TARGET_STATUS_LIVE"
	NegativeTargetingClauseExServingStatusTARGETSTATUSPAUSED          NegativeTargetingClauseExServingStatus = "TARGET_STATUS_PAUSED"
)

Defines values for NegativeTargetingClauseExServingStatus.

type NegativeTargetingClauseExState

type NegativeTargetingClauseExState string

NegativeTargetingClauseExState defines model for NegativeTargetingClauseEx.State.

const (
	NegativeTargetingClauseExStateArchived NegativeTargetingClauseExState = "archived"
	NegativeTargetingClauseExStateEnabled  NegativeTargetingClauseExState = "enabled"
	NegativeTargetingClauseExStatePaused   NegativeTargetingClauseExState = "paused"
)

Defines values for NegativeTargetingClauseExState.

type NegativeTargetingClauseExpressionType

type NegativeTargetingClauseExpressionType string

NegativeTargetingClauseExpressionType defines model for NegativeTargetingClause.ExpressionType.

const (
	NegativeTargetingClauseExpressionTypeAuto   NegativeTargetingClauseExpressionType = "auto"
	NegativeTargetingClauseExpressionTypeManual NegativeTargetingClauseExpressionType = "manual"
)

Defines values for NegativeTargetingClauseExpressionType.

type NegativeTargetingClauseState

type NegativeTargetingClauseState string

NegativeTargetingClauseState defines model for NegativeTargetingClause.State.

const (
	NegativeTargetingClauseStateArchived NegativeTargetingClauseState = "archived"
	NegativeTargetingClauseStateEnabled  NegativeTargetingClauseState = "enabled"
	NegativeTargetingClauseStatePaused   NegativeTargetingClauseState = "paused"
)

Defines values for NegativeTargetingClauseState.

type NegativeTargetingExpression

type NegativeTargetingExpression struct {
	// Type The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.
	Type *NegativeTargetingExpressionType `json:"type,omitempty"`

	// Value The value to be negatively targeted. Used only in manual expressions.
	Value *string `json:"value,omitempty"`
}

NegativeTargetingExpression defines model for NegativeTargetingExpression.

type NegativeTargetingExpressionType

type NegativeTargetingExpressionType string

NegativeTargetingExpressionType The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.

const (
	NegativeTargetingExpressionTypeAsinBrandSameAs NegativeTargetingExpressionType = "asinBrandSameAs"
	NegativeTargetingExpressionTypeAsinSameAs      NegativeTargetingExpressionType = "asinSameAs"
)

Defines values for NegativeTargetingExpressionType.

type OptimizationRule

type OptimizationRule struct {
	// RuleConditions A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.
	RuleConditions *[]RuleCondition `json:"ruleConditions,omitempty"`

	// RuleId The identifier of the optimization rule.
	RuleId *RuleId `json:"ruleId,omitempty"`

	// RuleName The name of the optimization rule.
	RuleName *string `json:"ruleName,omitempty"`

	// State The state of the optimization rule.
	State *OptimizationRuleState `json:"state,omitempty"`
}

OptimizationRule defines model for OptimizationRule.

type OptimizationRuleResponse

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

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

	// RuleId The identifier of the optimization rule.
	RuleId *RuleId `json:"ruleId,omitempty"`
}

OptimizationRuleResponse defines model for OptimizationRuleResponse.

type OptimizationRuleState

type OptimizationRuleState string

OptimizationRuleState The state of the optimization rule.

const (
	OptimizationRuleStateEnabled           OptimizationRuleState = "enabled"
	OptimizationRuleStatePausedCOMINGLATER OptimizationRuleState = "paused [COMING LATER]"
)

Defines values for OptimizationRuleState.

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 PostCreativePreviewJSONRequestBody

type PostCreativePreviewJSONRequestBody = CreativePreviewRequest

PostCreativePreviewJSONRequestBody defines body for PostCreativePreview for application/json ContentType.

type PostCreativePreviewParams

type PostCreativePreviewParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

PostCreativePreviewParams defines parameters for PostCreativePreview.

type PostCreativePreviewResp

type PostCreativePreviewResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreativePreviewResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParsePostCreativePreviewResp

func ParsePostCreativePreviewResp(rsp *http.Response) (*PostCreativePreviewResp, error)

ParsePostCreativePreviewResp parses an HTTP response from a PostCreativePreviewWithResponse call

func (PostCreativePreviewResp) Status

func (r PostCreativePreviewResp) Status() string

Status returns HTTPResponse.Status

func (PostCreativePreviewResp) StatusCode

func (r PostCreativePreviewResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PreviewCreativeModel

type PreviewCreativeModel struct {
	// CreativeType The type of the creative.
	// |Name|Description|
	// |----|-----------|
	// |IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|
	// |VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|
	CreativeType *CreativeTypeInCreativeRequest `json:"creativeType"`

	// Properties Select customizations on your creative from any combination of headline, logo, and custom image.
	Properties *CreativeProperties `json:"properties,omitempty"`
}

PreviewCreativeModel Creative model for preview.

type ProductAd

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

	// AdId The identifier of the product ad.
	AdId *AdId `json:"adId,omitempty"`

	// AdName The name of the ad. Note that this field is not supported when using ASIN or SKU fields.
	AdName *AdName `json:"adName,omitempty"`

	// Asin The Amazon ASIN of the product advertised by the product ad.
	Asin *string `json:"asin,omitempty"`

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

	// LandingPageType The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.
	LandingPageType *LandingPageType `json:"landingPageType,omitempty"`

	// LandingPageURL The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.
	// ||Specifications|
	// |------------------|------------------|
	// |LandingPageType| Description|
	// |STORE| Not yet supported. The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|
	// |MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|
	// |OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |
	LandingPageURL *LandingPageURL `json:"landingPageURL,omitempty"`

	// Sku The Amazon SKU of the product advertised by the product ad.
	Sku *string `json:"sku,omitempty"`

	// State The state of the campaign associated with the product ad.
	State *ProductAdState `json:"state,omitempty"`
}

ProductAd defines model for ProductAd.

type ProductAdResponse

type ProductAdResponse struct {
	// AdId The identifier of the ad.
	AdId *float32 `json:"adId,omitempty"`

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

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

ProductAdResponse defines model for ProductAdResponse.

type ProductAdResponseEx

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

	// AdId The identifier of the ad.
	AdId *float32 `json:"adId,omitempty"`

	// AdName The name of the ad. Note that this field is not supported when using ASIN or SKU fields.
	AdName *AdName `json:"adName,omitempty"`

	// Asin The ASIN of the product being advertised.
	Asin *string `json:"asin,omitempty"`

	// CampaignId The identifier of the campaign associated with the ad.
	CampaignId *float32 `json:"campaignId,omitempty"`

	// CreationDate Epoch date the product ad was created.
	CreationDate *int64 `json:"creationDate,omitempty"`

	// LandingPageType The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.
	LandingPageType *LandingPageType `json:"landingPageType,omitempty"`

	// LandingPageURL The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.
	// ||Specifications|
	// |------------------|------------------|
	// |LandingPageType| Description|
	// |STORE| Not yet supported. The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|
	// |MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|
	// |OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |
	LandingPageURL *LandingPageURL `json:"landingPageURL,omitempty"`

	// LastUpdatedDate Epoch date of the last update to any property associated with the product ad.
	LastUpdatedDate *int64 `json:"lastUpdatedDate,omitempty"`

	// ServingStatus The status of the product ad.
	ServingStatus *ProductAdResponseExServingStatus `json:"servingStatus,omitempty"`

	// Sku The SKU of the product being advertised.
	Sku *string `json:"sku,omitempty"`

	// State The state of the product ad.
	State *ProductAdResponseExState `json:"state,omitempty"`
}

ProductAdResponseEx defines model for ProductAdResponseEx.

type ProductAdResponseExServingStatus

type ProductAdResponseExServingStatus string

ProductAdResponseExServingStatus The status of the product ad.

const (
	ProductAdResponseExServingStatusACCOUNTOUTOFBUDGET          ProductAdResponseExServingStatus = "ACCOUNT_OUT_OF_BUDGET"
	ProductAdResponseExServingStatusADGROUPARCHIVED             ProductAdResponseExServingStatus = "AD_GROUP_ARCHIVED"
	ProductAdResponseExServingStatusADGROUPINCOMPLETE           ProductAdResponseExServingStatus = "AD_GROUP_INCOMPLETE"
	ProductAdResponseExServingStatusADGROUPLOWBID               ProductAdResponseExServingStatus = "AD_GROUP_LOW_BID"
	ProductAdResponseExServingStatusADGROUPPAUSED               ProductAdResponseExServingStatus = "AD_GROUP_PAUSED"
	ProductAdResponseExServingStatusADGROUPSTATUSENABLED        ProductAdResponseExServingStatus = "AD_GROUP_STATUS_ENABLED"
	ProductAdResponseExServingStatusADPOLICINGPENDINGREVIEW     ProductAdResponseExServingStatus = "AD_POLICING_PENDING_REVIEW"
	ProductAdResponseExServingStatusADSTATUSARCHIVED            ProductAdResponseExServingStatus = "AD_STATUS_ARCHIVED"
	ProductAdResponseExServingStatusADSTATUSLIVE                ProductAdResponseExServingStatus = "AD_STATUS_LIVE"
	ProductAdResponseExServingStatusADSTATUSPAUSED              ProductAdResponseExServingStatus = "AD_STATUS_PAUSED"
	ProductAdResponseExServingStatusADVERTISEREXCEEDSPENDSLIMIT ProductAdResponseExServingStatus = "ADVERTISER_EXCEED_SPENDS_LIMIT"
	ProductAdResponseExServingStatusADVERTISERPAUSED            ProductAdResponseExServingStatus = "ADVERTISER_PAUSED"
	ProductAdResponseExServingStatusADVERTISERPAYMENTFAILURE    ProductAdResponseExServingStatus = "ADVERTISER_PAYMENT_FAILURE"
	ProductAdResponseExServingStatusADVERTISERSTATUSENABLED     ProductAdResponseExServingStatus = "ADVERTISER_STATUS_ENABLED"
	ProductAdResponseExServingStatusCAMPAIGNARCHIVED            ProductAdResponseExServingStatus = "CAMPAIGN_ARCHIVED"
	ProductAdResponseExServingStatusCAMPAIGNINCOMPLETE          ProductAdResponseExServingStatus = "CAMPAIGN_INCOMPLETE"
	ProductAdResponseExServingStatusCAMPAIGNOUTOFBUDGET         ProductAdResponseExServingStatus = "CAMPAIGN_OUT_OF_BUDGET"
	ProductAdResponseExServingStatusCAMPAIGNPAUSED              ProductAdResponseExServingStatus = "CAMPAIGN_PAUSED"
	ProductAdResponseExServingStatusENDED                       ProductAdResponseExServingStatus = "ENDED"
	ProductAdResponseExServingStatusINELIGIBLE                  ProductAdResponseExServingStatus = "INELIGIBLE"
	ProductAdResponseExServingStatusMISSINGDECORATION           ProductAdResponseExServingStatus = "MISSING_DECORATION"
	ProductAdResponseExServingStatusMISSINGIMAGE                ProductAdResponseExServingStatus = "MISSING_IMAGE"
	ProductAdResponseExServingStatusNOTBUYABLE                  ProductAdResponseExServingStatus = "NOT_BUYABLE"
	ProductAdResponseExServingStatusNOTINBUYBOX                 ProductAdResponseExServingStatus = "NOT_IN_BUYBOX"
	ProductAdResponseExServingStatusNOTINPOLICY                 ProductAdResponseExServingStatus = "NOT_IN_POLICY"
	ProductAdResponseExServingStatusOUTOFSTOCK                  ProductAdResponseExServingStatus = "OUT_OF_STOCK"
	ProductAdResponseExServingStatusPENDINGSTARTDATE            ProductAdResponseExServingStatus = "PENDING_START_DATE"
	ProductAdResponseExServingStatusPORTFOLIOENDED              ProductAdResponseExServingStatus = "PORTFOLIO_ENDED"
	ProductAdResponseExServingStatusPORTFOLIOOUTOFBUDGET        ProductAdResponseExServingStatus = "PORTFOLIO_OUT_OF_BUDGET"
	ProductAdResponseExServingStatusSTATUSUNAVAILABLE           ProductAdResponseExServingStatus = "STATUS_UNAVAILABLE"
)

Defines values for ProductAdResponseExServingStatus.

type ProductAdResponseExState

type ProductAdResponseExState string

ProductAdResponseExState The state of the product ad.

const (
	ProductAdResponseExStateArchived ProductAdResponseExState = "archived"
	ProductAdResponseExStateEnabled  ProductAdResponseExState = "enabled"
	ProductAdResponseExStatePaused   ProductAdResponseExState = "paused"
)

Defines values for ProductAdResponseExState.

type ProductAdState

type ProductAdState string

ProductAdState The state of the campaign associated with the product ad.

const (
	ProductAdStateArchived ProductAdState = "archived"
	ProductAdStateEnabled  ProductAdState = "enabled"
	ProductAdStatePaused   ProductAdState = "paused"
)

Defines values for ProductAdState.

type ProfileHeader

type ProfileHeader = string

ProfileHeader defines model for profileHeader.

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 ReportRequest

type ReportRequest struct {
	// Metrics A comma-separated list of the metrics to be included in the report.
	//
	// Each report type supports different metrics. **To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).**
	//
	// **Note**: Campaigns with vCPM costType should use view+click based metrics (viewAttributedConversions14d, viewAttributedDetailPageView14d, viewAttributedSales14d, viewAttributedUnitsOrdered14d, viewImpressions).
	//
	// **Note**: Detail page view metrics (attributedDetailPageView14d, viewAttributedDetailPageView14d) have an SLA of 3 days.
	//
	// **Tip**: Use new-to-brand (NTB) metrics to calculate how efficient your campaigns are at driving new shoppers:
	//
	//   1. Percentage of NTB orders = attributedOrdersNewToBrand14d / attributedConversions14d
	//   2. Percentage NTB sales = attributedSalesNewToBrand14d / attributedSales14d
	//   3. Percentage NTB units = attributedUnitsOrderedNewToBrand14d / attributedUnitsOrdered14d
	//   4. NTB order rate = attributedOrdersNewToBrand14 / impressions
	Metrics *string `json:"metrics,omitempty"`

	// ReportDate Date in YYYYMMDD format. The report contains only metrics generated on the specified date. Note that the time zone used for date calculation is the one associated with the profile used to make the request.
	ReportDate *string `json:"reportDate,omitempty"`

	// Segment Optional. A dimension used to further segment certain types of reports.
	//
	// Note: matchedTarget reports only return targets that have generated at least one click.
	// | Dimension | Report types | Tactics | Metrics | Description |
	// |---------|------------------|-------------|-------------|------------|
	// | matchedTarget | campaigns, adGroups, targets | T00020, T00030 | Existing metrics for each report type are accepted. |  Segments a report based on the ASIN of the product page where the ad appeared.|
	Segment *Segment `json:"segment,omitempty"`

	// Tactic The advertising tactic associated with the campaign. The following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	Tactic *TacticReport `json:"tactic,omitempty"`
}

ReportRequest defines model for ReportRequest.

type ReportResponse

type ReportResponse struct {
	// Expiration Epoch date of the expiration of the URI in the `location` property.
	Expiration *int64 `json:"expiration,omitempty"`

	// FileSize The size of the report file, in bytes.
	FileSize *int64 `json:"fileSize,omitempty"`

	// Location The URI location of the report.
	Location *string `json:"location,omitempty"`

	// RecordType The type of report requested.
	RecordType *ReportResponseRecordType `json:"recordType,omitempty"`

	// ReportId The identifier of the report.
	ReportId *string `json:"reportId,omitempty"`

	// Status The build status of the report.
	Status *ReportResponseStatus `json:"status,omitempty"`

	// StatusDetails A human-readable description of the current status.
	StatusDetails *string `json:"statusDetails,omitempty"`
}

ReportResponse defines model for ReportResponse.

type ReportResponseRecordType

type ReportResponseRecordType string

ReportResponseRecordType The type of report requested.

const (
	ADGROUP   ReportResponseRecordType = "AD_GROUP"
	CAMPAIGN  ReportResponseRecordType = "CAMPAIGN"
	PRODUCTAD ReportResponseRecordType = "PRODUCT_AD"
)

Defines values for ReportResponseRecordType.

type ReportResponseStatus

type ReportResponseStatus string

ReportResponseStatus The build status of the report.

const (
	ReportResponseStatusFAILURE    ReportResponseStatus = "FAILURE"
	ReportResponseStatusINPROGRESS ReportResponseStatus = "IN_PROGRESS"
	ReportResponseStatusSUCCESS    ReportResponseStatus = "SUCCESS"
)

Defines values for ReportResponseStatus.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestReportJSONRequestBody

type RequestReportJSONRequestBody = ReportRequest

RequestReportJSONRequestBody defines body for RequestReport for application/json ContentType.

type RequestReportParams

type RequestReportParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

RequestReportParams defines parameters for RequestReport.

type RequestReportParamsRecordType

type RequestReportParamsRecordType string

RequestReportParamsRecordType defines parameters for RequestReport.

const (
	RequestReportParamsRecordTypeAdGroups   RequestReportParamsRecordType = "adGroups"
	RequestReportParamsRecordTypeAsins      RequestReportParamsRecordType = "asins"
	RequestReportParamsRecordTypeCampaigns  RequestReportParamsRecordType = "campaigns"
	RequestReportParamsRecordTypeProductAds RequestReportParamsRecordType = "productAds"
	RequestReportParamsRecordTypeTargets    RequestReportParamsRecordType = "targets"
)

Defines values for RequestReportParamsRecordType.

type RequestReportResp

type RequestReportResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *ReportResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON406      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseRequestReportResp

func ParseRequestReportResp(rsp *http.Response) (*RequestReportResp, error)

ParseRequestReportResp parses an HTTP response from a RequestReportWithResponse call

func (RequestReportResp) Status

func (r RequestReportResp) Status() string

Status returns HTTPResponse.Status

func (RequestReportResp) StatusCode

func (r RequestReportResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ResolvedLocationExpression

type ResolvedLocationExpression struct {
	// Type The location category.
	Type *LocationPredicate `json:"type,omitempty"`

	// Value The human-readable location name.
	Value *string `json:"value,omitempty"`
}

ResolvedLocationExpression defines model for ResolvedLocationExpression.

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 RuleBasedBudget

type RuleBasedBudget struct {
	ApplicableRuleId   *string  `json:"applicableRuleId,omitempty"`
	ApplicableRuleName *string  `json:"applicableRuleName,omitempty"`
	IsProcessing       *bool    `json:"isProcessing,omitempty"`
	Value              *float64 `json:"value,omitempty"`
}

RuleBasedBudget defines model for RuleBasedBudget.

type RuleCondition

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

	// MetricName The name of the metric.
	// Supported rule metrics and corresponding supported comparisonOperators:
	// |      MetricName      |ComparisonOperator  |Description|
	// |------------------|--------------------|-------------------|
	// |COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|
	// |COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|
	// |COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|
	MetricName RuleConditionMetricName `json:"metricName"`

	// Threshold The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:
	// |                  MetricName            | Minimum of `threshold` Value  |
	// |----------------------------------------|-----------------------------------|
	// |COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |
	// |COST_PER_ORDER                          | 3                                 |
	// |COST_PER_CLICK                          | 0.5                               |
	Threshold float64 `json:"threshold"`
}

RuleCondition A rule condition that defines the advertiser's intent for the outcome of the rule. Certain actions are performed by the product to achieve and maintain the rule condition.

type RuleConditionComparisonOperator

type RuleConditionComparisonOperator string

RuleConditionComparisonOperator The comparison operator.

const (
	RuleConditionComparisonOperatorLESSTHANOREQUALTO RuleConditionComparisonOperator = "LESS_THAN_OR_EQUAL_TO"
)

Defines values for RuleConditionComparisonOperator.

type RuleConditionMetricName

type RuleConditionMetricName string

RuleConditionMetricName The name of the metric. Supported rule metrics and corresponding supported comparisonOperators: | MetricName |ComparisonOperator |Description| |------------------|--------------------|-------------------| |COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS | LESS_THAN_OR_EQUAL_TO |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`| |COST_PER_ORDER | LESS_THAN_OR_EQUAL_TO |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`| |COST_PER_CLICK | LESS_THAN_OR_EQUAL_TO |Maximize page visits while cost per click less than or equal to `threshold`|

const (
	COSTPERCLICK                       RuleConditionMetricName = "COST_PER_CLICK"
	COSTPERORDER                       RuleConditionMetricName = "COST_PER_ORDER"
	COSTPERTHOUSANDVIEWABLEIMPRESSIONS RuleConditionMetricName = "COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS"
)

Defines values for RuleConditionMetricName.

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 RuleId

type RuleId = string

RuleId The identifier of the optimization rule.

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, Lifestyle and Life Event

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, Lifestyle and Life Event
	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|Description| |----|--------|-----------| |reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks|cpc|Optimize for page visits| |conversions|cpc|Optimize for conversion| |leads |cpc| [PREVIEW ONLY] Optimize for lead generation.|

const (
	SDBidOptimizationV32Clicks      SDBidOptimizationV32 = "clicks"
	SDBidOptimizationV32Conversions SDBidOptimizationV32 = "conversions"
	SDBidOptimizationV32Reach       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 SDBudgetHistory

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

SDBudgetHistory defines model for SDBudgetHistory.

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 = int

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. If no targetable ASIN counts are available then the targetableAsinCountRange value will be null without any properties.
	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 SDCostTypeV31

type SDCostTypeV31 string

SDCostTypeV31 Determines what performance metric the bid recommendations will be optimized for. |Name|Description| |----|----------|-----------| |cpc|The bid recommendations will be optimized for clicks triggered by the ad.| |vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|

const (
	SDCostTypeV31Cpc  SDCostTypeV31 = "cpc"
	SDCostTypeV31Vcpm SDCostTypeV31 = "vcpm"
)

Defines values for SDCostTypeV31.

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 SDForecastErrorResponse

type SDForecastErrorResponse 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"`
}

SDForecastErrorResponse defines model for SDForecastErrorResponse.

type SDForecastRequest

type SDForecastRequest struct {
	AdGroup  AdGroup  `json:"adGroup"`
	Campaign Campaign `json:"campaign"`

	// NegativeTargetingClauses A list of SD negative targeting clauses.
	NegativeTargetingClauses *[]NegativeTargetingClause `json:"negativeTargetingClauses,omitempty"`
	ProductAds               []ProductAd                `json:"productAds"`

	// TargetingClauses A list of SD targeting clauses.
	TargetingClauses []TargetingClause `json:"targetingClauses"`
}

SDForecastRequest Request payload for SD forecasting. Below are required and optional fields. Fields not listed will not impact forecast results. |Field |Object |Required| |-------------------|------------------|--------| |startDate |Campaign |required| |endDate |Campaign |optional| |bidOptimization |AdGroup |required| |defaultBid |AdGroup |optional| |asin |ProductAds |required for vendors| |sku |ProductAds |required for sellers| |bid |TargetingClauses |required when defaultBid is not set| |expression |TargetingClauses |required|

type SDForecastResponse

type SDForecastResponse struct {
	BidOptimization *string `json:"bidOptimization,omitempty"`

	// DailyForecasts Daily average forecasts.
	DailyForecasts *[]Forecast `json:"dailyForecasts,omitempty"`

	// LifetimeForecasts Forecasts for campaign start date and end date. Default end date is start date plus 7 days.
	LifetimeForecasts *[]Forecast `json:"lifetimeForecasts,omitempty"`

	// WeeklyForecasts Weekly average forecasts.
	WeeklyForecasts *[]Forecast `json:"weeklyForecasts,omitempty"`
}

SDForecastResponse Response to a request for SD forecasting.

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 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 recomendations.
	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 contextual targeting.

type SDProductTargetingTheme

type SDProductTargetingTheme struct {
	// Expression A list of expressions defining the contextual 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 supports 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 Contextual targeting theme definitions.

type SDProductTargetingThemeExpression

type SDProductTargetingThemeExpression struct {
	// Type The contextual 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 contextual targeting theme.

type SDProductTargetingThemeExpressionType

type SDProductTargetingThemeExpressionType string

SDProductTargetingThemeExpressionType The contextual 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 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. PRODUCT and CATEGORY are supported by tactic T00020. CATEGORY and AUDIENCE are supported by tactic T00030.

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

Defines values for SDRecommendationTypeV32.

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 SDTactic

type SDTactic string

SDTactic The advertising tactic associated with the campaign. The following table lists available tactic names: |Tactic Name|Type|Description|

|-----------|-----|-----------|
|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 (
	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|

|-----------|-----|-----------|
|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 (
	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|Description|
	// |----|--------|-----------|
	// |reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks|cpc|Optimize for page visits|
	// |conversions|cpc|Optimize for conversion|
	// |leads |cpc| [PREVIEW ONLY] Optimize for lead generation.|
	BidOptimization SDBidOptimizationV32 `json:"bidOptimization"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Description|
	// |----|----------|-----------|
	// |cpc|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|
	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 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|Description|
	// |----|----------|-----------|
	// |cpc|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|
	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|Description|
	// |----|--------|-----------|
	// |reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks|cpc|Optimize for page visits|
	// |conversions|cpc|Optimize for conversion|
	// |leads |cpc| [PREVIEW ONLY] Optimize for lead generation.|
	BidOptimization    SDBidOptimizationV32 `json:"bidOptimization"`
	BidRecommendations interface{}          `json:"bidRecommendations"`

	// CostType Determines what performance metric the bid recommendations will be optimized for.
	// |Name|Description|
	// |----|----------|-----------|
	// |cpc|The bid recommendations will be optimized for clicks triggered by the ad.|
	// |vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|
	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 contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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.
	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.

const (
	SDTargetingClauseV31ExpressionTypeAuto   SDTargetingClauseV31ExpressionType = "auto"
	SDTargetingClauseV31ExpressionTypeManual SDTargetingClauseV31ExpressionType = "manual"
)

Defines values for SDTargetingClauseV31ExpressionType.

type SDTargetingExpressionV31

type SDTargetingExpressionV31 = []SDTargetExpressionV31

SDTargetingExpressionV31 The targeting expression to match against.

------- Applicable to contextual targeting (T00020) ------- * A 'TargetingExpression' in a contextual 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.

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 Ads 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'.

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"
	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 manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'. * 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. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'. * 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'.

type SDTargetingPredicateNestedV31Type

type SDTargetingPredicateNestedV31Type string

SDTargetingPredicateNestedV31Type defines model for SDTargetingPredicateNestedV31.Type.

const (
	SDTargetingPredicateNestedV31TypeAudience  SDTargetingPredicateNestedV31Type = "audience"
	SDTargetingPredicateNestedV31TypePurchases SDTargetingPredicateNestedV31Type = "purchases"
	SDTargetingPredicateNestedV31TypeViews     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 contextual targeting - T00020).

* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads 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 (
	SDTargetingPredicateV31TypeAsinAgeRangeSameAs          SDTargetingPredicateV31Type = "asinAgeRangeSameAs"
	SDTargetingPredicateV31TypeAsinBrandSameAs             SDTargetingPredicateV31Type = "asinBrandSameAs"
	SDTargetingPredicateV31TypeAsinCategorySameAs          SDTargetingPredicateV31Type = "asinCategorySameAs"
	SDTargetingPredicateV31TypeAsinGenreSameAs             SDTargetingPredicateV31Type = "asinGenreSameAs"
	SDTargetingPredicateV31TypeAsinIsPrimeShippingEligible SDTargetingPredicateV31Type = "asinIsPrimeShippingEligible"
	SDTargetingPredicateV31TypeAsinPriceBetween            SDTargetingPredicateV31Type = "asinPriceBetween"
	SDTargetingPredicateV31TypeAsinPriceGreaterThan        SDTargetingPredicateV31Type = "asinPriceGreaterThan"
	SDTargetingPredicateV31TypeAsinPriceLessThan           SDTargetingPredicateV31Type = "asinPriceLessThan"
	SDTargetingPredicateV31TypeAsinReviewRatingBetween     SDTargetingPredicateV31Type = "asinReviewRatingBetween"
	SDTargetingPredicateV31TypeAsinReviewRatingGreaterThan SDTargetingPredicateV31Type = "asinReviewRatingGreaterThan"
	SDTargetingPredicateV31TypeAsinReviewRatingLessThan    SDTargetingPredicateV31Type = "asinReviewRatingLessThan"
	SDTargetingPredicateV31TypeAsinSameAs                  SDTargetingPredicateV31Type = "asinSameAs"
)

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 SDTargetingRecommendationsLocale

type SDTargetingRecommendationsLocale string

SDTargetingRecommendationsLocale List of supported locales.

const (
	SDTargetingRecommendationsLocaleArAE SDTargetingRecommendationsLocale = "ar_AE"
	SDTargetingRecommendationsLocaleDeDE SDTargetingRecommendationsLocale = "de_DE"
	SDTargetingRecommendationsLocaleEnAE SDTargetingRecommendationsLocale = "en_AE"
	SDTargetingRecommendationsLocaleEnAU SDTargetingRecommendationsLocale = "en_AU"
	SDTargetingRecommendationsLocaleEnCA SDTargetingRecommendationsLocale = "en_CA"
	SDTargetingRecommendationsLocaleEnGB SDTargetingRecommendationsLocale = "en_GB"
	SDTargetingRecommendationsLocaleEnIN SDTargetingRecommendationsLocale = "en_IN"
	SDTargetingRecommendationsLocaleEnSG SDTargetingRecommendationsLocale = "en_SG"
	SDTargetingRecommendationsLocaleEnUS SDTargetingRecommendationsLocale = "en_US"
	SDTargetingRecommendationsLocaleEsES SDTargetingRecommendationsLocale = "es_ES"
	SDTargetingRecommendationsLocaleEsMX SDTargetingRecommendationsLocale = "es_MX"
	SDTargetingRecommendationsLocaleFrCA SDTargetingRecommendationsLocale = "fr_CA"
	SDTargetingRecommendationsLocaleFrFR SDTargetingRecommendationsLocale = "fr_FR"
	SDTargetingRecommendationsLocaleHiIN SDTargetingRecommendationsLocale = "hi_IN"
	SDTargetingRecommendationsLocaleItIT SDTargetingRecommendationsLocale = "it_IT"
	SDTargetingRecommendationsLocaleJaJP SDTargetingRecommendationsLocale = "ja_JP"
	SDTargetingRecommendationsLocaleKoKR SDTargetingRecommendationsLocale = "ko_KR"
	SDTargetingRecommendationsLocaleNlNL SDTargetingRecommendationsLocale = "nl_NL"
	SDTargetingRecommendationsLocalePlPL SDTargetingRecommendationsLocale = "pl_PL"
	SDTargetingRecommendationsLocalePtBR SDTargetingRecommendationsLocale = "pt_BR"
	SDTargetingRecommendationsLocaleSvSE SDTargetingRecommendationsLocale = "sv_SE"
	SDTargetingRecommendationsLocaleTaIN SDTargetingRecommendationsLocale = "ta_IN"
	SDTargetingRecommendationsLocaleThTH SDTargetingRecommendationsLocale = "th_TH"
	SDTargetingRecommendationsLocaleTrTR SDTargetingRecommendationsLocale = "tr_TR"
	SDTargetingRecommendationsLocaleViVN SDTargetingRecommendationsLocale = "vi_VN"
	SDTargetingRecommendationsLocaleZhCN SDTargetingRecommendationsLocale = "zh_CN"
)

Defines values for SDTargetingRecommendationsLocale.

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|
	//         |-----------|-----|-----------|
	//         |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|
	//         |-----------|-----|-----------|
	//         |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|
	//         |-----------|-----|-----------|
	//         |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 contextual 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 for API version 3.2.

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|
	//         |-----------|-----|-----------|
	//         |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 contextual 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 for API version 3.3.

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 *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 contextual targeting themes in themes field.
	Recommendations *SDTargetingRecommendationsV32 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV32 Response to a request for targeting recommendations.

type SDTargetingRecommendationsResponseV33

type SDTargetingRecommendationsResponseV33 struct {
	// Recommendations For v3.3 the service will continue to return the recommendations returned for v3.2, and return audience recommendations if requested.
	Recommendations *SDTargetingRecommendationsV33 `json:"recommendations,omitempty"`
}

SDTargetingRecommendationsResponseV33 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 contextual 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   *struct {
		// Products A list of contextual targeting theme recommendations.
		Products *[]SDTargetingRecommendationsV32_Themes_Products_Item `json:"products,omitempty"`
	} `json:"themes,omitempty"`
}

SDTargetingRecommendationsV32 defines model for SDTargetingRecommendationsV32.

type SDTargetingRecommendationsV32_Themes_Products_Item

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

SDTargetingRecommendationsV32_Themes_Products_Item defines model for SDTargetingRecommendationsV32.Themes.Products.Item.

func (SDTargetingRecommendationsV32_Themes_Products_Item) AsSDProductTargetingRecommendationsSuccess

AsSDProductTargetingRecommendationsSuccess returns the union data inside the SDTargetingRecommendationsV32_Themes_Products_Item as a SDProductTargetingRecommendationsSuccess

func (SDTargetingRecommendationsV32_Themes_Products_Item) AsSDTargetingRecommendationsFailure

AsSDTargetingRecommendationsFailure returns the union data inside the SDTargetingRecommendationsV32_Themes_Products_Item as a SDTargetingRecommendationsFailure

func (*SDTargetingRecommendationsV32_Themes_Products_Item) FromSDProductTargetingRecommendationsSuccess

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

func (*SDTargetingRecommendationsV32_Themes_Products_Item) FromSDTargetingRecommendationsFailure

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

func (SDTargetingRecommendationsV32_Themes_Products_Item) MarshalJSON

func (*SDTargetingRecommendationsV32_Themes_Products_Item) MergeSDProductTargetingRecommendationsSuccess

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

func (*SDTargetingRecommendationsV32_Themes_Products_Item) MergeSDTargetingRecommendationsFailure

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

func (*SDTargetingRecommendationsV32_Themes_Products_Item) UnmarshalJSON

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   *struct {
		// Products A list of contextual targeting theme recommendations.
		Products *[]SDTargetingRecommendationsV33_Themes_Products_Item `json:"products,omitempty"`
	} `json:"themes,omitempty"`
}

SDTargetingRecommendationsV33 defines model for SDTargetingRecommendationsV33.

type SDTargetingRecommendationsV33_Themes_Products_Item

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

SDTargetingRecommendationsV33_Themes_Products_Item defines model for SDTargetingRecommendationsV33.Themes.Products.Item.

func (SDTargetingRecommendationsV33_Themes_Products_Item) AsSDProductTargetingRecommendationsSuccess

AsSDProductTargetingRecommendationsSuccess returns the union data inside the SDTargetingRecommendationsV33_Themes_Products_Item as a SDProductTargetingRecommendationsSuccess

func (SDTargetingRecommendationsV33_Themes_Products_Item) AsSDTargetingRecommendationsFailure

AsSDTargetingRecommendationsFailure returns the union data inside the SDTargetingRecommendationsV33_Themes_Products_Item as a SDTargetingRecommendationsFailure

func (*SDTargetingRecommendationsV33_Themes_Products_Item) FromSDProductTargetingRecommendationsSuccess

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

func (*SDTargetingRecommendationsV33_Themes_Products_Item) FromSDTargetingRecommendationsFailure

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

func (SDTargetingRecommendationsV33_Themes_Products_Item) MarshalJSON

func (*SDTargetingRecommendationsV33_Themes_Products_Item) MergeSDProductTargetingRecommendationsSuccess

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

func (*SDTargetingRecommendationsV33_Themes_Products_Item) MergeSDTargetingRecommendationsFailure

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

func (*SDTargetingRecommendationsV33_Themes_Products_Item) UnmarshalJSON

type SDThemeRecommendations

type SDThemeRecommendations struct {
	Themes *struct {
		// Products A list of contextual targeting theme recommendations.
		Products *[]SDThemeRecommendations_Themes_Products_Item `json:"products,omitempty"`
	} `json:"themes,omitempty"`
}

SDThemeRecommendations defines model for SDThemeRecommendations.

type SDThemeRecommendations_Themes_Products_Item

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

SDThemeRecommendations_Themes_Products_Item defines model for SDThemeRecommendations.Themes.Products.Item.

func (SDThemeRecommendations_Themes_Products_Item) AsSDProductTargetingRecommendationsSuccess

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

AsSDProductTargetingRecommendationsSuccess returns the union data inside the SDThemeRecommendations_Themes_Products_Item as a SDProductTargetingRecommendationsSuccess

func (SDThemeRecommendations_Themes_Products_Item) AsSDTargetingRecommendationsFailure

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

AsSDTargetingRecommendationsFailure returns the union data inside the SDThemeRecommendations_Themes_Products_Item as a SDTargetingRecommendationsFailure

func (*SDThemeRecommendations_Themes_Products_Item) FromSDProductTargetingRecommendationsSuccess

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

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

func (*SDThemeRecommendations_Themes_Products_Item) FromSDTargetingRecommendationsFailure

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

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

func (SDThemeRecommendations_Themes_Products_Item) MarshalJSON

func (*SDThemeRecommendations_Themes_Products_Item) MergeSDProductTargetingRecommendationsSuccess

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

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

func (*SDThemeRecommendations_Themes_Products_Item) MergeSDTargetingRecommendationsFailure

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

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

func (*SDThemeRecommendations_Themes_Products_Item) UnmarshalJSON

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 Segment

type Segment string

Segment Optional. A dimension used to further segment certain types of reports.

Note: matchedTarget reports only return targets that have generated at least one click. | Dimension | Report types | Tactics | Metrics | Description | |---------|------------------|-------------|-------------|------------| | matchedTarget | campaigns, adGroups, targets | T00020, T00030 | Existing metrics for each report type are accepted. | Segments a report based on the ASIN of the product page where the ad appeared.|

const (
	MatchedTarget Segment = "matchedTarget"
)

Defines values for Segment.

type SnapshotRequest

type SnapshotRequest struct {
	// StateFilter Optional. Restricts results to entities with state within the specified comma-separated list. Default behavior is to include 'enabled' and 'paused'. You can include 'enabled', 'paused', and 'archived' or any combination.
	StateFilter *SnapshotRequestStateFilter `json:"stateFilter,omitempty"`

	// TacticFilter Optional. Restricts results to entities with the advertising tactic associated with the campaign. Must be one of the following table lists available tactic names:
	// |Tactic Name|Type|Description|
	// |-----------|-----|-----------|
	// |T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|
	// |T00030     |Audiences targeting | Select individual audiences to show your ads.|
	TacticFilter *TacticFilter `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. Default behavior is to include 'enabled' and 'paused'. You can include 'enabled', 'paused', and 'archived' or any combination.

const (
	SnapshotRequestStateFilterArchived SnapshotRequestStateFilter = "archived"
	SnapshotRequestStateFilterEnabled  SnapshotRequestStateFilter = "enabled"
	SnapshotRequestStateFilterPaused   SnapshotRequestStateFilter = "paused"
)

Defines values for SnapshotRequestStateFilter.

type SnapshotResponse

type SnapshotResponse struct {
	// Expiration The epoch time for expiration of the snapshot file and each snapshot file will be expired in 30 mins after generated. 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 Optional description of the status.
	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"
	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 (
	SnapshotResponseStatusFAILURE    SnapshotResponseStatus = "FAILURE"
	SnapshotResponseStatusINPROGRESS SnapshotResponseStatus = "IN_PROGRESS"
	SnapshotResponseStatusSUCCESS    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 Tactic

type Tactic string

Tactic The advertising tactic associated with the campaign. The following table lists available tactic names: |Tactic Name|Type|Description| |-----------|-----|-----------| |T00020 |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.| |T00030 |Audiences targeting | Select individual audiences to show your ads.|

const (
	TacticT00020 Tactic = "T00020"
	TacticT00030 Tactic = "T00030"
)

Defines values for Tactic.

type TacticFilter

type TacticFilter string

TacticFilter Optional. Restricts results to entities with the advertising tactic associated with the campaign. Must be one of the following table lists available tactic names: |Tactic Name|Type|Description| |-----------|-----|-----------| |T00020 |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.| |T00030 |Audiences targeting | Select individual audiences to show your ads.|

const (
	TacticFilterT00020       TacticFilter = "T00020"
	TacticFilterT00020T00030 TacticFilter = "T00020,T00030"
	TacticFilterT00030       TacticFilter = "T00030"
)

Defines values for TacticFilter.

type TacticReport

type TacticReport string

TacticReport The advertising tactic associated with the campaign. The following table lists available tactic names: |Tactic Name|Type|Description| |-----------|-----|-----------| |T00020 |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.| |T00030 |Audiences targeting | Select individual audiences to show your ads.|

const (
	T00020 TacticReport = "T00020"
	T00030 TacticReport = "T00030"
)

Defines values for TacticReport.

type TargetId

type TargetId = int64

TargetId defines model for TargetId.

type TargetResponse

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

	// Description A human-readable description of the response.
	Description *string   `json:"description,omitempty"`
	TargetId    *TargetId `json:"targetId,omitempty"`
}

TargetResponse defines model for TargetResponse.

type TargetingClause

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

	// Bid The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the ["Bid constraints by marketplace" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.
	Bid *float32 `json:"bid"`

	// Expression The targeting expression to match against.
	//
	// ------- Applicable to contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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 ASIN-grain ('exactProduct'), manual ASIN-grain ('relatedProducts' or 'relatedProducts'), or category-grain targeting.
	Expression *TargetingExpression `json:"expression,omitempty"`

	// ExpressionType Tactic T00020 & T00030 ad groups should use 'manual' targeting.
	ExpressionType *TargetingClauseExpressionType `json:"expressionType,omitempty"`

	// ResolvedExpression The targeting expression to match against.
	//
	// ------- Applicable to contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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 ASIN-grain ('exactProduct'), manual ASIN-grain ('relatedProducts' or 'relatedProducts'), or category-grain targeting.
	ResolvedExpression *TargetingExpression  `json:"resolvedExpression,omitempty"`
	State              *TargetingClauseState `json:"state,omitempty"`
	TargetId           *TargetId             `json:"targetId,omitempty"`
}

TargetingClause defines model for TargetingClause.

type TargetingClauseEx

type TargetingClauseEx struct {
	AdGroupId *float32 `json:"adGroupId,omitempty"`

	// Bid If a value for `bid` is specified, it overrides the current adGroup bid. When using vcpm costType. $1 is the minimum bid for vCPM. Note that this field is ignored for negative targeting clauses.
	Bid *float32 `json:"bid,omitempty"`

	// CreationDate Epoch date the target was created.
	CreationDate *int64 `json:"creationDate,omitempty"`

	// Expression The targeting expression to match against.
	//
	// ------- Applicable to contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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 ASIN-grain ('exactProduct'), manual ASIN-grain ('relatedProducts' or 'relatedProducts'), or category-grain targeting.
	Expression     *TargetingExpression             `json:"expression,omitempty"`
	ExpressionType *TargetingClauseExExpressionType `json:"expressionType,omitempty"`

	// LastUpdatedDate Epoch date of the last update to any property associated with the target.
	LastUpdatedDate *int64 `json:"lastUpdatedDate,omitempty"`

	// ResolvedExpression The targeting expression to match against.
	//
	// ------- Applicable to contextual targeting (T00020) -------
	// * A 'TargetingExpression' in a contextual 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 ASIN-grain ('exactProduct'), manual ASIN-grain ('relatedProducts' or 'relatedProducts'), or category-grain targeting.
	ResolvedExpression *TargetingExpression `json:"resolvedExpression,omitempty"`

	// ServingStatus The status of the target.
	ServingStatus *TargetingClauseExServingStatus `json:"servingStatus,omitempty"`
	State         *TargetingClauseExState         `json:"state,omitempty"`
	TargetId      *float32                        `json:"targetId,omitempty"`
}

TargetingClauseEx defines model for TargetingClauseEx.

type TargetingClauseExExpressionType

type TargetingClauseExExpressionType string

TargetingClauseExExpressionType defines model for TargetingClauseEx.ExpressionType.

const (
	Auto   TargetingClauseExExpressionType = "auto"
	Manual TargetingClauseExExpressionType = "manual"
)

Defines values for TargetingClauseExExpressionType.

type TargetingClauseExServingStatus

type TargetingClauseExServingStatus string

TargetingClauseExServingStatus The status of the target.

const (
	ACCOUNTOUTOFBUDGET          TargetingClauseExServingStatus = "ACCOUNT_OUT_OF_BUDGET"
	ADGROUPARCHIVED             TargetingClauseExServingStatus = "AD_GROUP_ARCHIVED"
	ADGROUPINCOMPLETE           TargetingClauseExServingStatus = "AD_GROUP_INCOMPLETE"
	ADGROUPLOWBID               TargetingClauseExServingStatus = "AD_GROUP_LOW_BID"
	ADGROUPPAUSED               TargetingClauseExServingStatus = "AD_GROUP_PAUSED"
	ADGROUPSTATUSENABLED        TargetingClauseExServingStatus = "AD_GROUP_STATUS_ENABLED"
	ADPOLICINGPENDINGREVIEW     TargetingClauseExServingStatus = "AD_POLICING_PENDING_REVIEW"
	ADVERTISEREXCEEDSPENDSLIMIT TargetingClauseExServingStatus = "ADVERTISER_EXCEED_SPENDS_LIMIT"
	ADVERTISERPAUSED            TargetingClauseExServingStatus = "ADVERTISER_PAUSED"
	ADVERTISERPAYMENTFAILURE    TargetingClauseExServingStatus = "ADVERTISER_PAYMENT_FAILURE"
	ADVERTISERSTATUSENABLED     TargetingClauseExServingStatus = "ADVERTISER_STATUS_ENABLED"
	CAMPAIGNARCHIVED            TargetingClauseExServingStatus = "CAMPAIGN_ARCHIVED"
	CAMPAIGNINCOMPLETE          TargetingClauseExServingStatus = "CAMPAIGN_INCOMPLETE"
	CAMPAIGNOUTOFBUDGET         TargetingClauseExServingStatus = "CAMPAIGN_OUT_OF_BUDGET"
	CAMPAIGNPAUSED              TargetingClauseExServingStatus = "CAMPAIGN_PAUSED"
	ENDED                       TargetingClauseExServingStatus = "ENDED"
	INELIGIBLE                  TargetingClauseExServingStatus = "INELIGIBLE"
	PENDINGSTARTDATE            TargetingClauseExServingStatus = "PENDING_START_DATE"
	PORTFOLIOENDED              TargetingClauseExServingStatus = "PORTFOLIO_ENDED"
	PORTFOLIOOUTOFBUDGET        TargetingClauseExServingStatus = "PORTFOLIO_OUT_OF_BUDGET"
	STATUSUNAVAILABLE           TargetingClauseExServingStatus = "STATUS_UNAVAILABLE"
	TARGETSTATUSARCHIVED        TargetingClauseExServingStatus = "TARGET_STATUS_ARCHIVED"
	TARGETSTATUSLIVE            TargetingClauseExServingStatus = "TARGET_STATUS_LIVE"
	TARGETSTATUSPAUSED          TargetingClauseExServingStatus = "TARGET_STATUS_PAUSED"
)

Defines values for TargetingClauseExServingStatus.

type TargetingClauseExState

type TargetingClauseExState string

TargetingClauseExState defines model for TargetingClauseEx.State.

const (
	TargetingClauseExStateArchived TargetingClauseExState = "archived"
	TargetingClauseExStateEnabled  TargetingClauseExState = "enabled"
	TargetingClauseExStatePaused   TargetingClauseExState = "paused"
)

Defines values for TargetingClauseExState.

type TargetingClauseExpressionType

type TargetingClauseExpressionType string

TargetingClauseExpressionType Tactic T00020 & T00030 ad groups should use 'manual' targeting.

const (
	TargetingClauseExpressionTypeAuto   TargetingClauseExpressionType = "auto"
	TargetingClauseExpressionTypeManual TargetingClauseExpressionType = "manual"
)

Defines values for TargetingClauseExpressionType.

type TargetingClauseState

type TargetingClauseState string

TargetingClauseState defines model for TargetingClause.State.

const (
	TargetingClauseStateArchived TargetingClauseState = "archived"
	TargetingClauseStateEnabled  TargetingClauseState = "enabled"
	TargetingClauseStatePaused   TargetingClauseState = "paused"
)

Defines values for TargetingClauseState.

type TargetingExpression

type TargetingExpression = []TargetingExpression_Item

TargetingExpression The targeting expression to match against.

------- Applicable to contextual targeting (T00020) ------- * A 'TargetingExpression' in a contextual 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 ASIN-grain ('exactProduct'), manual ASIN-grain ('relatedProducts' or 'relatedProducts'), or category-grain targeting.

type TargetingExpression_Item

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

TargetingExpression_Item defines model for TargetingExpression.Item.

func (TargetingExpression_Item) AsTargetingPredicate

func (t TargetingExpression_Item) AsTargetingPredicate() (TargetingPredicate, error)

AsTargetingPredicate returns the union data inside the TargetingExpression_Item as a TargetingPredicate

func (TargetingExpression_Item) AsTargetingPredicateLegacy

func (t TargetingExpression_Item) AsTargetingPredicateLegacy() (TargetingPredicateLegacy, error)

AsTargetingPredicateLegacy returns the union data inside the TargetingExpression_Item as a TargetingPredicateLegacy

func (TargetingExpression_Item) AsTargetingPredicateNested

func (t TargetingExpression_Item) AsTargetingPredicateNested() (TargetingPredicateNested, error)

AsTargetingPredicateNested returns the union data inside the TargetingExpression_Item as a TargetingPredicateNested

func (*TargetingExpression_Item) FromTargetingPredicate

func (t *TargetingExpression_Item) FromTargetingPredicate(v TargetingPredicate) error

FromTargetingPredicate overwrites any union data inside the TargetingExpression_Item as the provided TargetingPredicate

func (*TargetingExpression_Item) FromTargetingPredicateLegacy

func (t *TargetingExpression_Item) FromTargetingPredicateLegacy(v TargetingPredicateLegacy) error

FromTargetingPredicateLegacy overwrites any union data inside the TargetingExpression_Item as the provided TargetingPredicateLegacy

func (*TargetingExpression_Item) FromTargetingPredicateNested

func (t *TargetingExpression_Item) FromTargetingPredicateNested(v TargetingPredicateNested) error

FromTargetingPredicateNested overwrites any union data inside the TargetingExpression_Item as the provided TargetingPredicateNested

func (TargetingExpression_Item) MarshalJSON

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

func (*TargetingExpression_Item) MergeTargetingPredicate

func (t *TargetingExpression_Item) MergeTargetingPredicate(v TargetingPredicate) error

MergeTargetingPredicate performs a merge with any union data inside the TargetingExpression_Item, using the provided TargetingPredicate

func (*TargetingExpression_Item) MergeTargetingPredicateLegacy

func (t *TargetingExpression_Item) MergeTargetingPredicateLegacy(v TargetingPredicateLegacy) error

MergeTargetingPredicateLegacy performs a merge with any union data inside the TargetingExpression_Item, using the provided TargetingPredicateLegacy

func (*TargetingExpression_Item) MergeTargetingPredicateNested

func (t *TargetingExpression_Item) MergeTargetingPredicateNested(v TargetingPredicateNested) error

MergeTargetingPredicateNested performs a merge with any union data inside the TargetingExpression_Item, using the provided TargetingPredicateNested

func (*TargetingExpression_Item) UnmarshalJSON

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

type TargetingPredicate

type TargetingPredicate struct {
	Type *TargetingPredicateType `json:"type,omitempty"`

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

TargetingPredicate A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).

* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads 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 TargetingPredicateBase

type TargetingPredicateBase struct {
	Type *TargetingPredicateBaseType `json:"type,omitempty"`

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

TargetingPredicateBase 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 Ads 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'. * A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.

type TargetingPredicateBaseType

type TargetingPredicateBaseType string

TargetingPredicateBaseType defines model for TargetingPredicateBase.Type.

const (
	TargetingPredicateBaseTypeAsinAgeRangeSameAs          TargetingPredicateBaseType = "asinAgeRangeSameAs"
	TargetingPredicateBaseTypeAsinBrandSameAs             TargetingPredicateBaseType = "asinBrandSameAs"
	TargetingPredicateBaseTypeAsinCategorySameAs          TargetingPredicateBaseType = "asinCategorySameAs"
	TargetingPredicateBaseTypeAsinGenreSameAs             TargetingPredicateBaseType = "asinGenreSameAs"
	TargetingPredicateBaseTypeAsinIsPrimeShippingEligible TargetingPredicateBaseType = "asinIsPrimeShippingEligible"
	TargetingPredicateBaseTypeAsinPriceBetween            TargetingPredicateBaseType = "asinPriceBetween"
	TargetingPredicateBaseTypeAsinPriceGreaterThan        TargetingPredicateBaseType = "asinPriceGreaterThan"
	TargetingPredicateBaseTypeAsinPriceLessThan           TargetingPredicateBaseType = "asinPriceLessThan"
	TargetingPredicateBaseTypeAsinReviewRatingBetween     TargetingPredicateBaseType = "asinReviewRatingBetween"
	TargetingPredicateBaseTypeAsinReviewRatingGreaterThan TargetingPredicateBaseType = "asinReviewRatingGreaterThan"
	TargetingPredicateBaseTypeAsinReviewRatingLessThan    TargetingPredicateBaseType = "asinReviewRatingLessThan"
	TargetingPredicateBaseTypeAudienceSameAs              TargetingPredicateBaseType = "audienceSameAs"
	TargetingPredicateBaseTypeExactProduct                TargetingPredicateBaseType = "exactProduct"
	TargetingPredicateBaseTypeLookback                    TargetingPredicateBaseType = "lookback"
	TargetingPredicateBaseTypeNegative                    TargetingPredicateBaseType = "negative"
	TargetingPredicateBaseTypeRelatedProduct              TargetingPredicateBaseType = "relatedProduct"
	TargetingPredicateBaseTypeSimilarProduct              TargetingPredicateBaseType = "similarProduct"
)

Defines values for TargetingPredicateBaseType.

type TargetingPredicateLegacy

type TargetingPredicateLegacy struct {
	// EventType The type of event that the value applies to. Only available for similarProduct and exactProduct currently.
	// * views event type corresponds to a customer who viewed the detail page of the product(s).
	EventType *TargetingPredicateLegacyEventType `json:"eventType,omitempty"`
	Type      *TargetingPredicateLegacyType      `json:"type,omitempty"`

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

TargetingPredicateLegacy defines model for TargetingPredicateLegacy.

type TargetingPredicateLegacyEventType

type TargetingPredicateLegacyEventType string

TargetingPredicateLegacyEventType The type of event that the value applies to. Only available for similarProduct and exactProduct currently. * views event type corresponds to a customer who viewed the detail page of the product(s).

const (
	TargetingPredicateLegacyEventTypeViews TargetingPredicateLegacyEventType = "views"
)

Defines values for TargetingPredicateLegacyEventType.

type TargetingPredicateLegacyType

type TargetingPredicateLegacyType string

TargetingPredicateLegacyType defines model for TargetingPredicateLegacy.Type.

const (
	TargetingPredicateLegacyTypeAsinAgeRangeSameAs          TargetingPredicateLegacyType = "asinAgeRangeSameAs"
	TargetingPredicateLegacyTypeAsinBrandSameAs             TargetingPredicateLegacyType = "asinBrandSameAs"
	TargetingPredicateLegacyTypeAsinCategorySameAs          TargetingPredicateLegacyType = "asinCategorySameAs"
	TargetingPredicateLegacyTypeAsinGenreSameAs             TargetingPredicateLegacyType = "asinGenreSameAs"
	TargetingPredicateLegacyTypeAsinIsPrimeShippingEligible TargetingPredicateLegacyType = "asinIsPrimeShippingEligible"
	TargetingPredicateLegacyTypeAsinPriceBetween            TargetingPredicateLegacyType = "asinPriceBetween"
	TargetingPredicateLegacyTypeAsinPriceGreaterThan        TargetingPredicateLegacyType = "asinPriceGreaterThan"
	TargetingPredicateLegacyTypeAsinPriceLessThan           TargetingPredicateLegacyType = "asinPriceLessThan"
	TargetingPredicateLegacyTypeAsinReviewRatingBetween     TargetingPredicateLegacyType = "asinReviewRatingBetween"
	TargetingPredicateLegacyTypeAsinReviewRatingGreaterThan TargetingPredicateLegacyType = "asinReviewRatingGreaterThan"
	TargetingPredicateLegacyTypeAsinReviewRatingLessThan    TargetingPredicateLegacyType = "asinReviewRatingLessThan"
	TargetingPredicateLegacyTypeAsinSameAs                  TargetingPredicateLegacyType = "asinSameAs"
	TargetingPredicateLegacyTypeExactProduct                TargetingPredicateLegacyType = "exactProduct"
	TargetingPredicateLegacyTypeSimilarProduct              TargetingPredicateLegacyType = "similarProduct"
)

Defines values for TargetingPredicateLegacyType.

type TargetingPredicateNested

type TargetingPredicateNested struct {
	Type  *TargetingPredicateNestedType `json:"type,omitempty"`
	Value *[]TargetingPredicateBase     `json:"value,omitempty"`
}

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

* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'. * 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. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'. * 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'.

type TargetingPredicateNestedType

type TargetingPredicateNestedType string

TargetingPredicateNestedType defines model for TargetingPredicateNested.Type.

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

Defines values for TargetingPredicateNestedType.

type TargetingPredicateType

type TargetingPredicateType string

TargetingPredicateType defines model for TargetingPredicate.Type.

const (
	TargetingPredicateTypeAsinAgeRangeSameAs          TargetingPredicateType = "asinAgeRangeSameAs"
	TargetingPredicateTypeAsinBrandSameAs             TargetingPredicateType = "asinBrandSameAs"
	TargetingPredicateTypeAsinCategorySameAs          TargetingPredicateType = "asinCategorySameAs"
	TargetingPredicateTypeAsinGenreSameAs             TargetingPredicateType = "asinGenreSameAs"
	TargetingPredicateTypeAsinIsPrimeShippingEligible TargetingPredicateType = "asinIsPrimeShippingEligible"
	TargetingPredicateTypeAsinPriceBetween            TargetingPredicateType = "asinPriceBetween"
	TargetingPredicateTypeAsinPriceGreaterThan        TargetingPredicateType = "asinPriceGreaterThan"
	TargetingPredicateTypeAsinPriceLessThan           TargetingPredicateType = "asinPriceLessThan"
	TargetingPredicateTypeAsinReviewRatingBetween     TargetingPredicateType = "asinReviewRatingBetween"
	TargetingPredicateTypeAsinReviewRatingGreaterThan TargetingPredicateType = "asinReviewRatingGreaterThan"
	TargetingPredicateTypeAsinReviewRatingLessThan    TargetingPredicateType = "asinReviewRatingLessThan"
	TargetingPredicateTypeAsinSameAs                  TargetingPredicateType = "asinSameAs"
	TargetingPredicateTypeSimilarProduct              TargetingPredicateType = "similarProduct"
)

Defines values for TargetingPredicateType.

type UpdateAdGroup

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

	// BidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.
	// |Name|CostType|Description|
	// |----|--------|-----------|
	// |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|
	// |clicks |cpc|[Default] Optimize for page visits.|
	// |conversions |cpc|Optimize for conversion.|
	BidOptimization *UpdateAdGroupBidOptimization `json:"bidOptimization,omitempty"`

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

	// DefaultBid The amount of the default bid associated with the ad group. Used if no bid is specified.
	DefaultBid *float64 `json:"defaultBid,omitempty"`

	// Name The name of the ad group.
	Name *string `json:"name,omitempty"`

	// State The state of the ad group.
	State *UpdateAdGroupState `json:"state,omitempty"`
}

UpdateAdGroup defines model for UpdateAdGroup.

type UpdateAdGroupBidOptimization

type UpdateAdGroupBidOptimization string

UpdateAdGroupBidOptimization Bid Optimization for the Adgroup. Default behavior is to optimize for clicks. |Name|CostType|Description| |----|--------|-----------| |reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.| |clicks |cpc|[Default] Optimize for page visits.| |conversions |cpc|Optimize for conversion.|

const (
	UpdateAdGroupBidOptimizationClicks      UpdateAdGroupBidOptimization = "clicks"
	UpdateAdGroupBidOptimizationConversions UpdateAdGroupBidOptimization = "conversions"
	UpdateAdGroupBidOptimizationReach       UpdateAdGroupBidOptimization = "reach"
)

Defines values for UpdateAdGroupBidOptimization.

type UpdateAdGroupState

type UpdateAdGroupState string

UpdateAdGroupState The state of the ad group.

const (
	UpdateAdGroupStateArchived UpdateAdGroupState = "archived"
	UpdateAdGroupStateEnabled  UpdateAdGroupState = "enabled"
	UpdateAdGroupStatePaused   UpdateAdGroupState = "paused"
)

Defines values for UpdateAdGroupState.

type UpdateAdGroupsJSONBody

type UpdateAdGroupsJSONBody = []UpdateAdGroup

UpdateAdGroupsJSONBody defines parameters for UpdateAdGroups.

type UpdateAdGroupsJSONRequestBody

type UpdateAdGroupsJSONRequestBody = UpdateAdGroupsJSONBody

UpdateAdGroupsJSONRequestBody defines body for UpdateAdGroups for application/json ContentType.

type UpdateAdGroupsParams

type UpdateAdGroupsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateAdGroupsParams defines parameters for UpdateAdGroups.

type UpdateAdGroupsResp

type UpdateAdGroupsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]AdGroupResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateAdGroupsResp

func ParseUpdateAdGroupsResp(rsp *http.Response) (*UpdateAdGroupsResp, error)

ParseUpdateAdGroupsResp parses an HTTP response from a UpdateAdGroupsWithResponse call

func (UpdateAdGroupsResp) Status

func (r UpdateAdGroupsResp) Status() string

Status returns HTTPResponse.Status

func (UpdateAdGroupsResp) StatusCode

func (r UpdateAdGroupsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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 UpdateCampaign

type UpdateCampaign struct {
	// Budget The amount of the budget.
	Budget *float64 `json:"budget,omitempty"`

	// BudgetType The time period over which the amount specified in the `budget` property is allocated.
	BudgetType *UpdateCampaignBudgetType `json:"budgetType,omitempty"`

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

	// CostType Determines how the campaign will bid and charge.
	// |Name|Description|
	// |----|----------|
	// |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|
	// |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |
	//
	// To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).
	CostType *UpdateCampaignCostType `json:"costType,omitempty"`

	// EndDate The YYYYMMDD end date of the campaign.
	EndDate *string `json:"endDate"`

	// Name The name of the campaign.
	Name *string `json:"name,omitempty"`

	// PortfolioId Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.
	PortfolioId *int64 `json:"portfolioId"`

	// StartDate The YYYYMMDD start date of the campaign. The date must be today or in the future.
	StartDate *string `json:"startDate,omitempty"`

	// State The state of the campaign.
	State *UpdateCampaignState `json:"state,omitempty"`
}

UpdateCampaign defines model for UpdateCampaign.

type UpdateCampaignBudgetType

type UpdateCampaignBudgetType string

UpdateCampaignBudgetType The time period over which the amount specified in the `budget` property is allocated.

const (
	Daily UpdateCampaignBudgetType = "daily"
)

Defines values for UpdateCampaignBudgetType.

type UpdateCampaignCostType

type UpdateCampaignCostType string

UpdateCampaignCostType Determines how the campaign will bid and charge. |Name|Description| |----|----------| |cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.| |vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |

To view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).

const (
	UpdateCampaignCostTypeCpc  UpdateCampaignCostType = "cpc"
	UpdateCampaignCostTypeVcpm UpdateCampaignCostType = "vcpm"
)

Defines values for UpdateCampaignCostType.

type UpdateCampaignState

type UpdateCampaignState string

UpdateCampaignState The state of the campaign.

const (
	UpdateCampaignStateArchived UpdateCampaignState = "archived"
	UpdateCampaignStateEnabled  UpdateCampaignState = "enabled"
	UpdateCampaignStatePaused   UpdateCampaignState = "paused"
)

Defines values for UpdateCampaignState.

type UpdateCampaignsJSONBody

type UpdateCampaignsJSONBody = []UpdateCampaign

UpdateCampaignsJSONBody defines parameters for UpdateCampaigns.

type UpdateCampaignsJSONRequestBody

type UpdateCampaignsJSONRequestBody = UpdateCampaignsJSONBody

UpdateCampaignsJSONRequestBody defines body for UpdateCampaigns for application/json ContentType.

type UpdateCampaignsParams

type UpdateCampaignsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateCampaignsParams defines parameters for UpdateCampaigns.

type UpdateCampaignsResp

type UpdateCampaignsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]CampaignResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateCampaignsResp

func ParseUpdateCampaignsResp(rsp *http.Response) (*UpdateCampaignsResp, error)

ParseUpdateCampaignsResp parses an HTTP response from a UpdateCampaignsWithResponse call

func (UpdateCampaignsResp) Status

func (r UpdateCampaignsResp) Status() string

Status returns HTTPResponse.Status

func (UpdateCampaignsResp) StatusCode

func (r UpdateCampaignsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateCreativesJSONBody

type UpdateCreativesJSONBody = []CreativeUpdate

UpdateCreativesJSONBody defines parameters for UpdateCreatives.

type UpdateCreativesJSONRequestBody

type UpdateCreativesJSONRequestBody = UpdateCreativesJSONBody

UpdateCreativesJSONRequestBody defines body for UpdateCreatives for application/json ContentType.

type UpdateCreativesParams

type UpdateCreativesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateCreativesParams defines parameters for UpdateCreatives.

type UpdateCreativesResp

type UpdateCreativesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]CreativeResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateCreativesResp

func ParseUpdateCreativesResp(rsp *http.Response) (*UpdateCreativesResp, error)

ParseUpdateCreativesResp parses an HTTP response from a UpdateCreativesWithResponse call

func (UpdateCreativesResp) Status

func (r UpdateCreativesResp) Status() string

Status returns HTTPResponse.Status

func (UpdateCreativesResp) StatusCode

func (r UpdateCreativesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateNegativeTargetingClause

type UpdateNegativeTargetingClause struct {
	State    *UpdateNegativeTargetingClauseState `json:"state,omitempty"`
	TargetId *TargetId                           `json:"targetId,omitempty"`
}

UpdateNegativeTargetingClause defines model for UpdateNegativeTargetingClause.

type UpdateNegativeTargetingClauseState

type UpdateNegativeTargetingClauseState string

UpdateNegativeTargetingClauseState defines model for UpdateNegativeTargetingClause.State.

const (
	UpdateNegativeTargetingClauseStateArchived UpdateNegativeTargetingClauseState = "archived"
	UpdateNegativeTargetingClauseStateEnabled  UpdateNegativeTargetingClauseState = "enabled"
	UpdateNegativeTargetingClauseStatePaused   UpdateNegativeTargetingClauseState = "paused"
)

Defines values for UpdateNegativeTargetingClauseState.

type UpdateNegativeTargetingClausesJSONBody

type UpdateNegativeTargetingClausesJSONBody = []UpdateNegativeTargetingClause

UpdateNegativeTargetingClausesJSONBody defines parameters for UpdateNegativeTargetingClauses.

type UpdateNegativeTargetingClausesJSONRequestBody

type UpdateNegativeTargetingClausesJSONRequestBody = UpdateNegativeTargetingClausesJSONBody

UpdateNegativeTargetingClausesJSONRequestBody defines body for UpdateNegativeTargetingClauses for application/json ContentType.

type UpdateNegativeTargetingClausesParams

type UpdateNegativeTargetingClausesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateNegativeTargetingClausesParams defines parameters for UpdateNegativeTargetingClauses.

type UpdateNegativeTargetingClausesResp

type UpdateNegativeTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateNegativeTargetingClausesResp

func ParseUpdateNegativeTargetingClausesResp(rsp *http.Response) (*UpdateNegativeTargetingClausesResp, error)

ParseUpdateNegativeTargetingClausesResp parses an HTTP response from a UpdateNegativeTargetingClausesWithResponse call

func (UpdateNegativeTargetingClausesResp) Status

Status returns HTTPResponse.Status

func (UpdateNegativeTargetingClausesResp) StatusCode

func (r UpdateNegativeTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateOptimizationRule

type UpdateOptimizationRule struct {
	// RuleConditions A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.
	RuleConditions *[]RuleCondition `json:"ruleConditions,omitempty"`

	// RuleId The identifier of the optimization rule.
	RuleId *RuleId `json:"ruleId,omitempty"`

	// RuleName The name of the optimization rule.
	RuleName *string `json:"ruleName,omitempty"`

	// State The state of the optimization rule.
	State *UpdateOptimizationRuleState `json:"state,omitempty"`
}

UpdateOptimizationRule defines model for UpdateOptimizationRule.

type UpdateOptimizationRuleState

type UpdateOptimizationRuleState string

UpdateOptimizationRuleState The state of the optimization rule.

const (
	UpdateOptimizationRuleStateEnabled           UpdateOptimizationRuleState = "enabled"
	UpdateOptimizationRuleStatePausedCOMINGLATER UpdateOptimizationRuleState = "paused [COMING LATER]"
)

Defines values for UpdateOptimizationRuleState.

type UpdateOptimizationRulesJSONBody

type UpdateOptimizationRulesJSONBody = []UpdateOptimizationRule

UpdateOptimizationRulesJSONBody defines parameters for UpdateOptimizationRules.

type UpdateOptimizationRulesJSONRequestBody

type UpdateOptimizationRulesJSONRequestBody = UpdateOptimizationRulesJSONBody

UpdateOptimizationRulesJSONRequestBody defines body for UpdateOptimizationRules for application/json ContentType.

type UpdateOptimizationRulesParams

type UpdateOptimizationRulesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateOptimizationRulesParams defines parameters for UpdateOptimizationRules.

type UpdateOptimizationRulesResp

type UpdateOptimizationRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]OptimizationRuleResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateOptimizationRulesResp

func ParseUpdateOptimizationRulesResp(rsp *http.Response) (*UpdateOptimizationRulesResp, error)

ParseUpdateOptimizationRulesResp parses an HTTP response from a UpdateOptimizationRulesWithResponse call

func (UpdateOptimizationRulesResp) Status

Status returns HTTPResponse.Status

func (UpdateOptimizationRulesResp) StatusCode

func (r UpdateOptimizationRulesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateProductAd

type UpdateProductAd struct {
	// AdId The identifier of the product ad.
	AdId *AdId `json:"adId,omitempty"`

	// State The state of the campaign associated with the product ad.
	State *UpdateProductAdState `json:"state,omitempty"`
}

UpdateProductAd defines model for UpdateProductAd.

type UpdateProductAdState

type UpdateProductAdState string

UpdateProductAdState The state of the campaign associated with the product ad.

const (
	UpdateProductAdStateArchived UpdateProductAdState = "archived"
	UpdateProductAdStateEnabled  UpdateProductAdState = "enabled"
	UpdateProductAdStatePaused   UpdateProductAdState = "paused"
)

Defines values for UpdateProductAdState.

type UpdateProductAdsJSONBody

type UpdateProductAdsJSONBody = []UpdateProductAd

UpdateProductAdsJSONBody defines parameters for UpdateProductAds.

type UpdateProductAdsJSONRequestBody

type UpdateProductAdsJSONRequestBody = UpdateProductAdsJSONBody

UpdateProductAdsJSONRequestBody defines body for UpdateProductAds for application/json ContentType.

type UpdateProductAdsParams

type UpdateProductAdsParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateProductAdsParams defines parameters for UpdateProductAds.

type UpdateProductAdsResp

type UpdateProductAdsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]ProductAdResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateProductAdsResp

func ParseUpdateProductAdsResp(rsp *http.Response) (*UpdateProductAdsResp, error)

ParseUpdateProductAdsResp parses an HTTP response from a UpdateProductAdsWithResponse call

func (UpdateProductAdsResp) Status

func (r UpdateProductAdsResp) Status() string

Status returns HTTPResponse.Status

func (UpdateProductAdsResp) StatusCode

func (r UpdateProductAdsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

type UpdateTargetingClause

type UpdateTargetingClause struct {
	// Bid The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the ["Bid constraints by marketplace" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.
	Bid      *float32                    `json:"bid"`
	State    *UpdateTargetingClauseState `json:"state,omitempty"`
	TargetId *TargetId                   `json:"targetId,omitempty"`
}

UpdateTargetingClause defines model for UpdateTargetingClause.

type UpdateTargetingClauseState

type UpdateTargetingClauseState string

UpdateTargetingClauseState defines model for UpdateTargetingClause.State.

const (
	UpdateTargetingClauseStateArchived UpdateTargetingClauseState = "archived"
	UpdateTargetingClauseStateEnabled  UpdateTargetingClauseState = "enabled"
	UpdateTargetingClauseStatePaused   UpdateTargetingClauseState = "paused"
)

Defines values for UpdateTargetingClauseState.

type UpdateTargetingClausesJSONBody

type UpdateTargetingClausesJSONBody = []UpdateTargetingClause

UpdateTargetingClausesJSONBody defines parameters for UpdateTargetingClauses.

type UpdateTargetingClausesJSONRequestBody

type UpdateTargetingClausesJSONRequestBody = UpdateTargetingClausesJSONBody

UpdateTargetingClausesJSONRequestBody defines body for UpdateTargetingClauses for application/json ContentType.

type UpdateTargetingClausesParams

type UpdateTargetingClausesParams 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.
	AmazonAdvertisingAPIScope ProfileHeader `json:"Amazon-Advertising-API-Scope"`
}

UpdateTargetingClausesParams defines parameters for UpdateTargetingClauses.

type UpdateTargetingClausesResp

type UpdateTargetingClausesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON207      *[]TargetResponse
	JSON400      *Error
	JSON401      *Error
	JSON403      *Error
	JSON422      *Error
	JSON429      *Error
	JSON500      *Error
}

func ParseUpdateTargetingClausesResp

func ParseUpdateTargetingClausesResp(rsp *http.Response) (*UpdateTargetingClausesResp, error)

ParseUpdateTargetingClausesResp parses an HTTP response from a UpdateTargetingClausesWithResponse call

func (UpdateTargetingClausesResp) Status

Status returns HTTPResponse.Status

func (UpdateTargetingClausesResp) StatusCode

func (r UpdateTargetingClausesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Video

type Video struct {
	// AssetId The unique identifier of the video asset. This assetId comes from the Creative Asset Library.
	AssetId string `json:"assetId"`

	// AssetVersion The identifier of the particular video assetversion.
	AssetVersion string `json:"assetVersion"`
}

Video This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table. ||Specifications| |------------------|------------------| |Maximum file size|500MB| |Aspect ratio|16:9| |Minimum duration|6s| |Maximum duration|45s| |Minimum frame size|1920x1080| |Minimum video bitrate|4mbps| |Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97| |Video frame rate mode|Constant| |Minimum audio bitrate|192kbps| |Audio sample rate|44.1kHz or 48kHz| |Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC| |Audio Channel|Audio format needs to be stereo or mono.| |Recommended video bitrate|8mbps| |Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|

type VideoCreativeProperties

type VideoCreativeProperties struct {
	// LandscapeVideos An optional collection of 16:9 landscape videos which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	LandscapeVideos *[]Video `json:"landscapeVideos,omitempty"`

	// PortraitVideos An optional collection of 9:16 portrait videos which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	PortraitVideos *[]Video `json:"portraitVideos,omitempty"`

	// SquareVideos An optional collection of 1:1 square videos which are displayed on the ad. This operation is a PREVIEW ONLY. This note will be removed once this functionality becomes available.
	SquareVideos *[]Video `json:"squareVideos,omitempty"`

	// Video This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.
	// ||Specifications|
	// |------------------|------------------|
	// |Maximum file size|500MB|
	// |Aspect ratio|16:9|
	// |Minimum duration|6s|
	// |Maximum duration|45s|
	// |Minimum frame size|1920x1080|
	// |Minimum video bitrate|4mbps|
	// |Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|
	// |Video frame rate mode|Constant|
	// |Minimum audio bitrate|192kbps|
	// |Audio sample rate|44.1kHz or 48kHz|
	// |Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|
	// |Audio Channel|Audio format needs to be stereo or mono.|
	// |Recommended video bitrate|8mbps|
	// |Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|
	Video *Video `json:"video,omitempty"`
}

VideoCreativeProperties User-customizable properties of a video creative.

Jump to

Keyboard shortcuts

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