API coverage¶
The client can send all 1105 operations across 205 APIs that Amazon's Ads API documentation publishes, using
ProfileClient.call(). 64 of them also have typed, hand-written methods (marked typed). Operations marked corrected are sent with a different media type than their spec documents, because the live API refuses the documented one; API quirks says why.
Amazon's documentation also publishes the 110 tools of its hosted Ads MCP server (beta) as 18 more specs. They are listed below, marked MCP tool, but they are not Ads API endpoints, so call() refuses them.
Regenerate this page with python scripts/fetch_specs.py && python scripts/generate_catalog.py.
ad-group-targeting-apps¶
Ad Group Targeting - Apps, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-apps:DspGetAdGroupAppTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/app/targets |
|
ad-group-targeting-apps:DspCreateAdGroupAppTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/app/targets |
|
ad-group-targeting-apps:DspDeleteAdGroupAppTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/app/targets/delete |
ad-group-targeting-audiences¶
Ad Group Targeting - Audiences, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-audiences:DspGetAdGroupAudienceTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/audience/targets |
|
ad-group-targeting-audiences:DspCreateAdGroupAudienceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/audience/targets |
|
ad-group-targeting-audiences:DspDeleteAdGroupAudienceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/audience/targets/delete |
ad-group-targeting-auto¶
Ad Group Targeting - Auto, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-auto:DspGetAdGroupAutoTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/auto/targets |
|
ad-group-targeting-auto:DspCreateAdGroupAutoTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/auto/targets |
|
ad-group-targeting-auto:DspDeleteAdGroupAutoTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/auto/targets/delete |
ad-group-targeting-content-genre¶
Ad Group Targeting - Content Genre, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-content-genre:DspGetAdGroupContentGenreTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/contentGenre/targets |
|
ad-group-targeting-content-genre:DspCreateAdGroupContentGenreTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/contentGenre/targets |
|
ad-group-targeting-content-genre:DspDeleteAdGroupContentGenreTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/contentGenre/targets/delete |
ad-group-targeting-content-rating¶
Ad Group Targeting - Content Rating, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-content-rating:DspGetAdGroupContentRatingTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/contentRating/targets |
|
ad-group-targeting-content-rating:DspCreateAdGroupContentRatingTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/contentRating/targets |
|
ad-group-targeting-content-rating:DspDeleteAdGroupContentRatingTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/contentRating/targets/delete |
ad-group-targeting-dayparts¶
Ad Group Targeting - Dayparts, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-dayparts:DspGetAdGroupTargetingDayparts |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/daypart/targets |
|
ad-group-targeting-dayparts:DspCreateAdGroupTargetingDayparts |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/daypart/targets |
|
ad-group-targeting-dayparts:DspDeleteAdGroupTargetingDayparts |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/daypart/targets/delete |
ad-group-targeting-devices¶
Ad Group Targeting - Devices, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-devices:DspGetAdGroupDeviceTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/device/targets |
|
ad-group-targeting-devices:DspCreateAdGroupDeviceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/device/targets |
|
ad-group-targeting-devices:DspDeleteAdGroupDeviceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/device/targets/delete |
ad-group-targeting-geo-locations¶
Ad Group Targeting - Geo Locations, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-geo-locations:DspGetAdGroupGeoLocationTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/geoLocation/targets |
|
ad-group-targeting-geo-locations:DspCreateAdGroupGeoLocationTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/geoLocation/targets |
|
ad-group-targeting-geo-locations:DspDeleteAdGroupGeoLocationTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/geoLocation/targets/delete |
ad-group-targeting-iab-content-category¶
Ad Group Targeting - IAB Content Category, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-iab-content-category:DspGetAdGroupIabContentCategoryTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/iabContentCategory/targets |
|
ad-group-targeting-iab-content-category:DspCreateAdGroupIabContentCategoryTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/iabContentCategory/targets |
|
ad-group-targeting-iab-content-category:DspDeleteAdGroupIabContentCategoryTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/iabContentCategory/targets/delete |
ad-group-targeting-inventory-sources¶
Ad Group Targeting - Inventory Sources, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-inventory-sources:DspGetAdGroupInventorySourceTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/inventorySource/targets |
|
ad-group-targeting-inventory-sources:DspCreateAdGroupInventorySourceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/inventorySource/targets |
|
ad-group-targeting-inventory-sources:DspDeleteAdGroupInventorySourceTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/inventorySource/targets/delete |
ad-group-targeting-product¶
Ad Group Targeting - Product, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-product:DspGetAdGroupProductTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/product/targets |
|
ad-group-targeting-product:DspCreateAdGroupProductTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/product/targets |
|
ad-group-targeting-product:DspDeleteAdGroupProductTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/product/targets/delete |
ad-group-targeting-product-category¶
Ad Group Targeting - Product Category, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-product-category:DspGetAdGroupProductCategoryTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/productCategory/targets |
|
ad-group-targeting-product-category:DspCreateAdGroupProductCategoryTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/productCategory/targets |
|
ad-group-targeting-product-category:DspDeleteAdGroupProductCategoryTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/productCategory/targets/delete |
ad-group-targeting-third-party¶
Ad Group Targeting - Third-party, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-third-party:DspGetAdGroup3PTargeting |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/thirdParty/targets |
|
ad-group-targeting-third-party:DspPostAdGroup3PTargeting |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/thirdParty/targets |
|
ad-group-targeting-third-party:DspPatchAdGroup3PTargeting |
PATCH | /dsp/adGroups/{adGroupId}/targetingTypes/thirdParty/targets |
|
ad-group-targeting-third-party:DspDeleteAdGroup3PTargeting |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/thirdParty/targets/delete |
ad-group-targeting-video-ad-format¶
Ad Group Targeting - Video Ad Format, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-video-ad-format:DspGetAdGroupVideoAdFormatTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/videoAdFormat/targets |
|
ad-group-targeting-video-ad-format:DspCreateAdGroupVideoAdFormatTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/videoAdFormat/targets |
|
ad-group-targeting-video-ad-format:DspDeleteAdGroupVideoAdFormatTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/videoAdFormat/targets/delete |
ad-group-targeting-video-ad-initiation-type¶
Ad Group Targeting - Video Ad Initiation Type, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-video-ad-initiation-type:DspGetAdGroupAdInitiationTypeTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/adInitiationType/targets |
|
ad-group-targeting-video-ad-initiation-type:DspCreateAdGroupAdInitiationTypeTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/adInitiationType/targets |
|
ad-group-targeting-video-ad-initiation-type:DspDeleteAdGroupAdInitiationTypeTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/adInitiationType/targets/delete |
ad-group-targeting-video-ad-player-size¶
Ad Group Targeting - Video Ad Player Size, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-group-targeting-video-ad-player-size:DspGetAdGroupAdPlayerSizeTargets |
GET | /dsp/adGroups/{adGroupId}/targetingTypes/adPlayerSize/targets |
|
ad-group-targeting-video-ad-player-size:DspCreateAdGroupAdPlayerSizeTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/adPlayerSize/targets |
|
ad-group-targeting-video-ad-player-size:DspDeleteAdGroupAdPlayerSizeTargets |
POST | /dsp/adGroups/{adGroupId}/targetingTypes/adPlayerSize/targets/delete |
ad-groupand-campaign-v1¶
Ad Group and Campaign - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-groupand-campaign-v1:DspBatchPostAdGroupV1 |
POST | /dsp/v1/adGroups |
|
ad-groupand-campaign-v1:DspBatchPatchAdGroupV1 |
PATCH | /dsp/v1/adGroups |
|
ad-groupand-campaign-v1:DspListAdGroupV1 |
POST | /dsp/v1/adGroups/list |
|
ad-groupand-campaign-v1:DspBatchPostCampaignV1 |
POST | /dsp/v1/campaigns |
|
ad-groupand-campaign-v1:DspBatchPatchCampaignV1 |
PATCH | /dsp/v1/campaigns |
|
ad-groupand-campaign-v1:DspListCampaignV1 |
POST | /dsp/v1/campaigns/list |
ad-library-api¶
Ad Library API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ad-library-api:ListAds |
POST | /adRepository/ads/list |
|
ad-library-api:GetAdsByID |
GET | /adRepository/ads/{id} |
ads-data-manager¶
Ads Data Manager, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
ads-data-manager:ListAudienceDatasets |
GET | /adm/audiences |
|
ads-data-manager:CreateAudienceDataset |
POST | /adm/audiences |
|
ads-data-manager:GetAudienceDataset |
GET | /adm/audiences/{dataSetId} |
|
ads-data-manager:IngestAudiences |
POST | /adm/audiences/{dataSetId}/members |
|
ads-data-manager:GetDataroom |
GET | /adm/datarooms |
|
ads-data-manager:CreateDataroom |
POST | /adm/datarooms |
|
ads-data-manager:GetDataroomMetadata |
GET | /adm/datarooms/metadata |
|
ads-data-manager:ListDatasetDetails |
POST | /adm/datasets/list |
|
ads-data-manager:DeleteDataset |
DELETE | /adm/datasets/{dataSetId} |
|
ads-data-manager:GetDataSetMetrics |
GET | /adm/datasets/{dataSetId}/metrics |
|
ads-data-manager:GetDatasetAggregates |
POST | /adm/datasets/{dataSetId}/metrics/aggregates |
|
ads-data-manager:DeleteIdentity |
POST | /adm/identities/delete |
|
ads-data-manager:CreateSharingRule |
POST | /adm/sharingRules |
|
ads-data-manager:ListSharingRules |
POST | /adm/sharingRules/list |
|
ads-data-manager:RevokeSharingRule |
PATCH | /adm/sharingRules/{sharingRuleId}/revoke |
|
ads-data-manager:GetTerms |
GET | /adm/terms |
|
ads-data-manager:SetTermsAcceptance |
PATCH | /adm/terms |
adsp-audiences¶
ADSP Audiences, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
adsp-audiences:dspCreateAudiencesPost |
POST | /dsp/audiences |
advertiser-data-upload¶
Advertiser Data Upload, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertiser-data-upload:CreateDataSet |
POST | /amc/advertiserData/{instanceId}/dataSets |
|
advertiser-data-upload:ListDataSets |
POST | /amc/advertiserData/{instanceId}/dataSets/list |
|
advertiser-data-upload:GetDataSet |
GET | /amc/advertiserData/{instanceId}/dataSets/{dataSetId} |
|
advertiser-data-upload:UpdateDataSet |
PUT | /amc/advertiserData/{instanceId}/dataSets/{dataSetId} |
|
advertiser-data-upload:DeleteDataSet |
DELETE | /amc/advertiserData/{instanceId}/dataSets/{dataSetId} |
|
advertiser-data-upload:AddColumnToDataSet |
POST | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns |
|
advertiser-data-upload:UpdateColumnInDataSet |
PUT | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} |
|
advertiser-data-upload:DeleteColumnFromDataSet |
DELETE | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} |
|
advertiser-data-upload:ListUploads |
POST | /amc/advertiserData/{instanceId}/uploads/list |
|
advertiser-data-upload:CreateUpload |
POST | /amc/advertiserData/{instanceId}/uploads/{dataSetId} |
|
advertiser-data-upload:GetUpload |
GET | /amc/advertiserData/{instanceId}/uploads/{dataSetId}/{uploadId} |
|
advertiser-data-upload:CreateUserDeletionRequest |
POST | /amc/advertiserData/{instanceId}/userDeletionRequest |
|
advertiser-data-upload:ListUserDeletionRequests |
POST | /amc/advertiserData/{instanceId}/userDeletionRequest/list |
|
advertiser-data-upload:GetUserDeletionRequest |
GET | /amc/advertiserData/{instanceId}/userDeletionRequest/{userDeletionRequestId} |
advertisers¶
Advertisers, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertisers:getAccountBudgetFeatureFlags |
GET | /accountBudgets/featureFlags |
|
advertisers:updateAccountBudgetFeatureFlags |
POST | /accountBudgets/featureFlags |
advertising-accounts¶
Advertising Accounts, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertising-accounts:RegisterAdsAccount |
POST | /adsAccounts |
|
advertising-accounts:ListAdsAccounts |
POST | /adsAccounts/list |
|
advertising-accounts:GetAccount |
GET | /adsAccounts/{advertisingAccountId} |
|
advertising-accounts:CreateTermsToken |
POST | /termsTokens |
|
advertising-accounts:GetTermsToken |
GET | /termsTokens/{termsToken} |
advertising-billing¶
Advertising Billing, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertising-billing:GetDocument |
GET | /billing/documents/{documentId} |
|
advertising-billing:PayInvoices |
POST | /billing/invoices/pay |
|
advertising-billing:bulkGetBillingNotifications |
POST | /billing/notifications |
|
advertising-billing:CreatePaymentAgreements |
POST | /billing/paymentAgreements |
|
advertising-billing:GetPaymentAgreements |
POST | /billing/paymentAgreements/list |
|
advertising-billing:GetCustomerPaymentMethods |
POST | /billing/paymentMethods/list |
|
advertising-billing:CreatePaymentProfiles |
POST | /billing/paymentProfiles |
|
advertising-billing:bulkGetBillingStatus |
POST | /billing/statuses |
|
advertising-billing:GetBillingProfileAgreementContent |
GET | /billingProfileAgreementContents/{billingProfileAgreementContentId} |
|
advertising-billing:ApplyBillingProfile |
POST | /billingProfileUsages |
|
advertising-billing:GetBillingProfileUsages |
POST | /billingProfileUsages/list |
|
advertising-billing:UpdateBillingProfiles |
PUT | /billingProfiles |
|
advertising-billing:CreateBillingProfiles |
POST | /billingProfiles |
|
advertising-billing:GetBillingProfiles |
POST | /billingProfiles/list |
|
advertising-billing:CreateBillingStatement |
POST | /billingStatements |
|
advertising-billing:GetBillingStatement |
GET | /billingStatements/{billingStatementRequestId} |
|
advertising-billing:GetBillingInvoiceSummaries |
POST | /invoiceSummaries/list |
|
advertising-billing:getAdvertiserInvoices |
GET | /invoices |
corrected |
advertising-billing:getInvoice |
GET | /invoices/{invoiceId} |
corrected |
advertising-invitations¶
Advertising Invitations, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertising-invitations:UpdateUserInvitations |
PUT | /user-invitations |
|
advertising-invitations:CreateUserInvitations |
POST | /user-invitations |
|
advertising-invitations:ListUserInvitations |
POST | /user-invitations/list |
|
advertising-invitations:RedeemUserInvitation |
PUT | /user-invitations/redeem |
|
advertising-invitations:GetUserInvitation |
GET | /user-invitations/{invitationId} |
advertising-test-account¶
AdvertisingTestAccount, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertising-test-account:GetAccountInformation |
GET | /testAccounts |
|
advertising-test-account:createAccount |
POST | /testAccounts |
advertising-user-permissions-management¶
Advertising User Permissions Management, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
advertising-user-permissions-management:UpdateUserPermissions |
PUT | /userPermissions |
|
advertising-user-permissions-management:DeleteUserPermissions |
POST | /userPermissions/delete |
|
advertising-user-permissions-management:QueryUserPermissions |
POST | /userPermissions/list |
|
advertising-user-permissions-management:QueryUserRoles |
POST | /userRoles/list |
|
advertising-user-permissions-management:ListUsers |
POST | /users/list |
amazon-ads-dspapi-targets-v1¶
Amazon Ads DSP API Targets - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amazon-ads-dspapi-targets-v1:CreateDspTargetsV1 |
POST | /dsp/v1/targets |
|
amazon-ads-dspapi-targets-v1:DeleteTargetsByIdV1 |
POST | /dsp/v1/targets/delete |
|
amazon-ads-dspapi-targets-v1:DeleteDspTargetsV1 |
POST | /dsp/v1/targets/deleteByObject |
|
amazon-ads-dspapi-targets-v1:ListDspTargetsV1 |
POST | /dsp/v1/targets/list |
amazon-advertiser-ap-ifor-retail-ad-service¶
Amazon Advertiser API for Retail Ad Service, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1UpdateAdGroups |
PUT | /ras/v1/adGroups |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1CreateAdGroups |
POST | /ras/v1/adGroups |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1DeleteAdGroups |
POST | /ras/v1/adGroups/delete |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1ListAdGroups |
POST | /ras/v1/adGroups/list |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1UpdateCampaigns |
PUT | /ras/v1/campaigns |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1CreateCampaigns |
POST | /ras/v1/campaigns |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1DeleteCampaigns |
POST | /ras/v1/campaigns/delete |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1ListCampaigns |
POST | /ras/v1/campaigns/list |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1UpdateProductAds |
PUT | /ras/v1/productAds |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1CreateProductAds |
POST | /ras/v1/productAds |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1DeleteProductAds |
POST | /ras/v1/productAds/delete |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1ListProductAds |
POST | /ras/v1/productAds/list |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1UpdateTargets |
PUT | /ras/v1/targets |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1CreateTargets |
POST | /ras/v1/targets |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1DeleteTargets |
POST | /ras/v1/targets/delete |
|
amazon-advertiser-ap-ifor-retail-ad-service:RASv1ListTargets |
POST | /ras/v1/targets/list |
amazon-attribution¶
Amazon Attribution, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amazon-attribution:getAdvertisersByProfile |
GET | /attribution/advertisers |
|
amazon-attribution:getPublishers |
GET | /attribution/publishers |
|
amazon-attribution:getAttributionTagsByCampaign |
POST | /attribution/report |
|
amazon-attribution:getPublisherAttributionTagTemplate |
GET | /attribution/tags/macroTag |
|
amazon-attribution:getPublisherMacroAttributionTag |
GET | /attribution/tags/nonMacroTemplateTag |
amazon-marketing-stream¶
Amazon Marketing Stream, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amazon-marketing-stream:ListDspStreamSubscriptions |
GET | /dsp/streams/subscriptions |
|
amazon-marketing-stream:CreateDspStreamSubscription |
POST | /dsp/streams/subscriptions |
|
amazon-marketing-stream:GetDspStreamSubscription |
GET | /dsp/streams/subscriptions/{subscriptionId} |
|
amazon-marketing-stream:UpdateDspStreamSubscription |
PUT | /dsp/streams/subscriptions/{subscriptionId} |
|
amazon-marketing-stream:ListStreamSubscriptions |
GET | /streams/subscriptions |
|
amazon-marketing-stream:CreateStreamSubscription |
POST | /streams/subscriptions |
|
amazon-marketing-stream:GetStreamSubscription |
GET | /streams/subscriptions/{subscriptionId} |
|
amazon-marketing-stream:UpdateStreamSubscription |
PUT | /streams/subscriptions/{subscriptionId} |
amc-administration¶
AMC Administration, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amc-administration:AmcpLinkListAmcAccounts |
GET | /amc/accounts |
|
amc-administration:listInstances |
GET | /amc/instances |
|
amc-administration:createInstance |
POST | /amc/instances |
|
amc-administration:getInstance |
GET | /amc/instances/{instanceId} |
|
amc-administration:updateInstance |
PUT | /amc/instances/{instanceId} |
|
amc-administration:deleteInstance |
DELETE | /amc/instances/{instanceId} |
|
amc-administration:getInstanceAdvertisers |
GET | /amc/instances/{instanceId}/advertisers |
|
amc-administration:listAdvertiserUpdates |
GET | /amc/instances/{instanceId}/advertisers/updates |
|
amc-administration:createAdvertiserUpdate |
POST | /amc/instances/{instanceId}/advertisers/updates |
|
amc-administration:getAdvertiserUpdate |
GET | /amc/instances/{instanceId}/advertisers/updates/{updateId} |
|
amc-administration:getInstanceCollaboration |
GET | /amc/instances/{instanceId}/collaboration |
|
amc-administration:createCollaborationIdMappingTable |
POST | /amc/instances/{instanceId}/collaboration/idmappingtables |
|
amc-administration:listCollaborationIdMappingTables |
POST | /amc/instances/{instanceId}/collaboration/idmappingtables/list |
|
amc-administration:deleteCollaborationIdMappingTable |
DELETE | /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId} |
|
amc-administration:getCollaborationIdMappingJobForTrackingId |
GET | /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobTracker/{trackingId} |
|
amc-administration:listCollaborationIdMappingJobs |
POST | /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobs/list |
|
amc-administration:getCollaborationIdMappingJob |
GET | /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobs/{jobId} |
|
amc-administration:refreshCollaborationIdMappingTable |
POST | /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/refresh |
|
amc-administration:listCollaborationIdNamespaces |
POST | /amc/instances/{instanceId}/collaboration/idnamespaces/list |
|
amc-administration:createCollaboration |
POST | /amc/instances/{instanceId}/collaborations |
|
amc-administration:updateCollaborationCustomer |
PUT | /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomer |
|
amc-administration:updateCollaborationCustomerPartners |
PUT | /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners |
|
amc-administration:addCollaborationCustomerPartners |
POST | /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners |
|
amc-administration:deleteCollaborationCustomerPartner |
DELETE | /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners/{acrCustomerPartnerId} |
|
amc-administration:updateInstanceCustomerAwsAccountMetadata |
POST | /amc/instances/{instanceId}/updateCustomerAwsAccount |
amc-custom-models¶
AMC Custom Models, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
amc-custom-models:createMlDataExportV2 |
POST | /amc/models/v1/mlDataExports |
|
amc-custom-models:listMlDataExportV2 |
POST | /amc/models/v1/mlDataExports/list |
|
amc-custom-models:getMlDataExportV2 |
GET | /amc/models/v1/mlDataExports/{mlDataExportId} |
|
amc-custom-models:createMlInputChannelV2 |
POST | /amc/models/v1/mlInputChannels |
|
amc-custom-models:listMlInputChannelByInstanceIdV2 |
POST | /amc/models/v1/mlInputChannels/list |
|
amc-custom-models:getMlInputChannelV2 |
GET | /amc/models/v1/mlInputChannels/{mlInputChannelId} |
|
amc-custom-models:deleteMlInputChannelV2 |
DELETE | /amc/models/v1/mlInputChannels/{mlInputChannelId} |
|
amc-custom-models:createModeledDatasetUploadJobV2 |
POST | /amc/models/v1/modeledDatasetUploadJobs |
|
amc-custom-models:listModeledDatasetUploadJobV2 |
POST | /amc/models/v1/modeledDatasetUploadJobs/list |
|
amc-custom-models:getModeledDatasetUploadJobV2 |
GET | /amc/models/v1/modeledDatasetUploadJobs/{modeledDatasetUploadJobId} |
|
amc-custom-models:createModeledDatasetV2 |
POST | /amc/models/v1/modeledDatasets |
|
amc-custom-models:listModeledDatasetV2 |
POST | /amc/models/v1/modeledDatasets/list |
|
amc-custom-models:getModeledDatasetV2 |
GET | /amc/models/v1/modeledDatasets/{modeledDatasetId} |
|
amc-custom-models:deleteModeledDatasetV2 |
DELETE | /amc/models/v1/modeledDatasets/{modeledDatasetId} |
|
amc-custom-models:createTrainedModelInferenceJobV2 |
POST | /amc/models/v1/trainedModelInferenceJobs |
|
amc-custom-models:listTrainedModelInferenceJobByInstanceIdV2 |
POST | /amc/models/v1/trainedModelInferenceJobs/list |
|
amc-custom-models:getTrainedModelInferenceJobV2 |
GET | /amc/models/v1/trainedModelInferenceJobs/{trainedModelInferenceJobId} |
|
amc-custom-models:cancelTrainedModelInferenceJobV2 |
POST | /amc/models/v1/trainedModelInferenceJobs/{trainedModelInferenceJobId}/cancel |
|
amc-custom-models:createTrainedModelV2 |
POST | /amc/models/v1/trainedModels |
|
amc-custom-models:listTrainedModelsByInstanceIdV2 |
POST | /amc/models/v1/trainedModels/list |
|
amc-custom-models:getTrainedModelByTrainedModelIdV2 |
GET | /amc/models/v1/trainedModels/{trainedModelId} |
|
amc-custom-models:deleteTrainedModelV2 |
DELETE | /amc/models/v1/trainedModels/{trainedModelId} |
|
amc-custom-models:cancelTrainedModelV2 |
POST | /amc/models/v1/trainedModels/{trainedModelId}/cancel |
audiences¶
Audiences, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
audiences:listAudiences |
POST | /audiences/list |
|
audiences:fetchTaxonomy |
POST | /audiences/taxonomy/list |
|
audiences:DspAudienceDelete |
POST | /dsp/audiences/delete |
|
audiences:DspAudienceEdit |
PUT | /dsp/audiences/edit |
bid-adjustments¶
Bid Adjustments, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
bid-adjustments:CreateBidAdjustmentRule |
POST | /dsp/rules/adjustments |
|
bid-adjustments:ListBidAdjustmentRules |
POST | /dsp/rules/adjustments/list |
|
bid-adjustments:GetBidAdjustmentRule |
GET | /dsp/rules/adjustments/{adjustmentRuleId} |
|
bid-adjustments:DeleteBidAdjustmentRule |
DELETE | /dsp/rules/adjustments/{adjustmentRuleId} |
|
bid-adjustments:UpdateBidAdjustmentRule |
PATCH | /dsp/rules/adjustments/{adjustmentRuleId} |
|
bid-adjustments:CreateBidAdjustmentRuleAssociation |
PUT | /dsp/rules/adjustments/{adjustmentRuleId}/associations |
|
bid-adjustments:DeleteBidAdjustmentRuleAssociation |
DELETE | /dsp/rules/adjustments/{adjustmentRuleId}/associations |
|
bid-adjustments:GetBidAdjustmentRuleAssociations |
POST | /dsp/rules/adjustments/{adjustmentRuleId}/associations/list |
bid-modifiers¶
Bid Modifiers, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
bid-modifiers:CreateBidModifierRule |
POST | /dsp/rules/bidmodifier |
|
bid-modifiers:ListBidModifierRules |
POST | /dsp/rules/bidmodifier/list |
|
bid-modifiers:GetBidModifierRule |
GET | /dsp/rules/bidmodifier/{bidModifierRuleId} |
|
bid-modifiers:DeleteBidModifierRule |
DELETE | /dsp/rules/bidmodifier/{bidModifierRuleId} |
|
bid-modifiers:CreateBidModifierRuleAssociation |
PUT | /dsp/rules/bidmodifier/{bidModifierRuleId}/associations |
|
bid-modifiers:DeleteBidModifierRuleAssociation |
DELETE | /dsp/rules/bidmodifier/{bidModifierRuleId}/associations |
|
bid-modifiers:GetBidModifierRuleAssociations |
POST | /dsp/rules/bidmodifier/{bidModifierRuleId}/associations/list |
brand-aid-v2¶
BrandAidV2, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
brand-aid-v2:QueryBrandAdvertiserAssociation |
POST | /adsApi/v1/query/brandAdvertiserAssociations |
|
brand-aid-v2:RetrieveBrand |
POST | /adsApi/v1/retrieve/brands |
brand-benchmarks¶
Brand Benchmarks, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
brand-benchmarks:ListAdvertiserReportMetadata |
GET | /insights/brandBenchmarks/advertisers/{advertiserId}/allReportMetadata |
|
brand-benchmarks:GetAdvertiserReport |
GET | /insights/brandBenchmarks/advertisers/{advertiserId}/reports/{reportType}/indexDates/{indexDate} |
brand-home¶
Brand Home, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
brand-home:ListPages |
POST | /brand/stores/v1/storePages/list |
|
brand-home:ListStores |
POST | /brand/stores/v1/stores/list |
brand-metrics¶
Brand Metrics, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
brand-metrics:generateBrandMetricsReport |
POST | /insights/brandMetrics/report |
|
brand-metrics:getBrandMetricsReport |
GET | /insights/brandMetrics/report/{reportId} |
campaign-conversion-tracking-products-v1¶
Campaign Conversion Tracking - Products - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
campaign-conversion-tracking-products-v1:DspGetCampaignConversionTrackingProductsV1 |
GET | /dsp/v1/campaigns/{campaignId}/conversionTracking/products |
|
campaign-conversion-tracking-products-v1:DspPostProductConversionTrackingV1 |
POST | /dsp/v1/campaigns/{campaignId}/conversionTracking/products |
|
campaign-conversion-tracking-products-v1:DspDeleteProductConversionTrackingV1 |
POST | /dsp/v1/campaigns/{campaignId}/conversionTracking/products/delete |
campaign-flights-v1¶
Campaign Flights - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
campaign-flights-v1:DspCreateCampaignFlightsV1 |
POST | /dsp/v1/campaigns/{campaignId}/flights |
|
campaign-flights-v1:DspUpdateCampaignFlightsV1 |
PATCH | /dsp/v1/campaigns/{campaignId}/flights |
|
campaign-flights-v1:DspDeleteCampaignFlightsV1 |
POST | /dsp/v1/campaigns/{campaignId}/flights/delete |
|
campaign-flights-v1:DspListCampaignFlightsV1 |
POST | /dsp/v1/campaigns/{campaignId}/flights/list |
combined-audience-api¶
Combined Audience API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
combined-audience-api:CreateCombinedAudience |
POST | /dsp/audiences/combinedAudiences |
|
combined-audience-api:GetCombinedAudienceDetails |
GET | /dsp/audiences/combinedAudiences/{audienceId} |
conversions-api¶
Conversions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
conversions-api:dspAmazonAdTagGetEventsByAdTagId |
GET | /accounts/{accountId}/dsp/adTagEvents/{adTagId}/list |
|
conversions-api:dspAmazonAdTagGetAdTagByAdvertiserId |
GET | /accounts/{accountId}/dsp/amazonAdTag |
|
conversions-api:dspAmazonBatchGetConversionDefinitionsForOrders |
POST | /accounts/{accountId}/dsp/batchOrders/conversionDefinitionAssociations |
|
conversions-api:dspAmazonUpdateConversionDefinitions |
PUT | /accounts/{accountId}/dsp/conversionDefinitions |
|
conversions-api:dspAmazonCreateConversionDefinitions |
POST | /accounts/{accountId}/dsp/conversionDefinitions |
|
conversions-api:dspAmazonDeletionRequest |
POST | /accounts/{accountId}/dsp/conversionDefinitions/delete |
|
conversions-api:dspAmazonIngestConversionData |
POST | /accounts/{accountId}/dsp/conversionDefinitions/eventData |
|
conversions-api:dspAmazonListConversionDefinitions |
POST | /accounts/{accountId}/dsp/conversionDefinitions/list |
|
conversions-api:dspAmazonGetAdTagAssociatedEvent |
GET | /accounts/{accountId}/dsp/conversionDefinitions/{conversionDefinitionId}/adTagEventAssociations |
|
conversions-api:dspAmazonUpdateAdTagAssociatedEvent |
POST | /accounts/{accountId}/dsp/conversionDefinitions/{conversionDefinitionId}/adTagEventAssociations |
|
conversions-api:dspAmazonGetAssociatedMobileAppForConversionDefinition |
GET | /accounts/{accountId}/dsp/conversionDefinitions/{conversionDefinitionId}/mobileMeasurementPartnerAppRegistration |
|
conversions-api:dspAmazonBatchUpdateMobileMeasurementPartnerAppRegistration |
PUT | /accounts/{accountId}/dsp/mobileMeasurementPartners |
|
conversions-api:dspAmazonBatchCreateMobileMeasurementPartnerAppRegistration |
POST | /accounts/{accountId}/dsp/mobileMeasurementPartners |
|
conversions-api:dspAmazonDeleteMeasurementPartnerAppRegistrations |
POST | /accounts/{accountId}/dsp/mobileMeasurementPartners/delete |
|
conversions-api:dspAmazonListMobileMeasurementPartnerAppRegistrations |
POST | /accounts/{accountId}/dsp/mobileMeasurementPartners/list |
|
conversions-api:dspAmazonGetAssociatedConversionDefinitionsForOrder |
GET | /accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations |
|
conversions-api:dspAmazonUpdateAssociatedConversionDefinitionsForOrder |
POST | /accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations |
creative-assets¶
Creative assets, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
creative-assets:getAsset |
GET | /assets |
|
creative-assets:assetsBatchRegister |
POST | /assets/batchRegister |
|
creative-assets:getAssetsBatchRegister |
GET | /assets/batchRegister/{requestId} |
|
creative-assets:registerAsset |
POST | /assets/register |
|
creative-assets:searchAssets |
POST | /assets/search |
|
creative-assets:getUploadLocation |
POST | /assets/upload |
d16-g-dsp-api-actionable-insights¶
D16GDspApiActionableInsights, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-g-dsp-api-actionable-insights:ListFrequencyDistributionInsightsV1 |
POST | /dsp/v1/frequencyDistributionInsights/list |
|
d16-g-dsp-api-actionable-insights:ListFrequencySavingsInsightsV1 |
POST | /dsp/v1/frequencySavingsInsights/list |
d16-g-dsp-api-campaign-insights-v1¶
D16GDspApiCampaignInsightsV1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-g-dsp-api-campaign-insights-v1:GetDspCampaignInsightsV1 |
POST | /dsp/v1/campaign/insights |
d16-g-dsp-api-deals¶
D16GDspApiDeals, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-g-dsp-api-deals:CreateDeal |
POST | /dsp/inventory/deals |
|
d16-g-dsp-api-deals:UpdateDeal |
PUT | /dsp/inventory/deals/{dealId} |
d16-g-seats-api-service¶
D16GSeatsApiService, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-g-seats-api-service:CreateAdvertiserSeats |
POST | /dsp/v1/seats/advertisers/create |
|
d16-g-seats-api-service:ListAdvertiserSeats |
POST | /dsp/v1/seats/advertisers/current/list |
|
d16-g-seats-api-service:ReconcileAdvertiserSeat |
POST | /v1/seats/reconcile |
d16-gfm-api-frequency-group-association-v1¶
D16GFMApiFrequencyGroupAssociationV1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-gfm-api-frequency-group-association-v1:updateFrequencyGroupAdvertiserAssociationsV1 |
PUT | /frequencyGroups/v1/advertiserAssociations |
|
d16-gfm-api-frequency-group-association-v1:listFrequencyGroupAdvertiserAssociationsV1 |
POST | /frequencyGroups/v1/advertiserAssociations/list |
|
d16-gfm-api-frequency-group-association-v1:listAdvertisersFrequencyGroupAssociationsV1 |
POST | /frequencyGroups/v1/advertisers/list |
|
d16-gfm-api-frequency-group-association-v1:updateFrequencyGroupCampaignAssociationsV1 |
PUT | /frequencyGroups/v1/campaignAssociations |
|
d16-gfm-api-frequency-group-association-v1:listFrequencyGroupCampaignAssociationsV1 |
POST | /frequencyGroups/v1/campaignAssociations/list |
|
d16-gfm-api-frequency-group-association-v1:listCampaignsFrequencyGroupAssociationsV1 |
POST | /frequencyGroups/v1/campaigns/list |
d16-gfm-api-frequency-group-v1¶
D16GFMApiFrequencyGroupV1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
d16-gfm-api-frequency-group-v1:createFrequencyGroupV1 |
POST | /frequencyGroups/v1 |
|
d16-gfm-api-frequency-group-v1:listFrequencyGroupsV1 |
POST | /frequencyGroups/v1/list |
|
d16-gfm-api-frequency-group-v1:getFrequencyGroupV1 |
GET | /frequencyGroups/v1/{frequencyGroupId} |
|
d16-gfm-api-frequency-group-v1:patchFrequencyGroupV1 |
PATCH | /frequencyGroups/v1/{frequencyGroupId} |
data-provider¶
Amazon Ads API for Data Providers., version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
data-provider:patch__v2_dp_audience |
PATCH | /v2/dp/audience |
|
data-provider:post__v2_dp_audiencemetadata_ |
POST | /v2/dp/audiencemetadata/ |
|
data-provider:get__v2_dp_audiencemetadata_{audienceId} |
GET | /v2/dp/audiencemetadata/{audienceId} |
|
data-provider:put__v2_dp_audiencemetadata_{audienceId} |
PUT | /v2/dp/audiencemetadata/{audienceId} |
|
data-provider:patch__v2_dp_users |
PATCH | /v2/dp/users |
deal-advertiser-permissions¶
Deal Advertiser Permissions, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
deal-advertiser-permissions:GetDealAdvertiserPermissionsDspDeals |
GET | /dsp/inventory/deals/{dealId}/advertiserPermissions |
|
deal-advertiser-permissions:CreateDealAdvertiserPermissionsDspDeals |
POST | /dsp/inventory/deals/{dealId}/advertiserPermissions |
|
deal-advertiser-permissions:DeleteDealAdvertiserPermissionsDspDeals |
DELETE | /dsp/inventory/deals/{dealId}/advertiserPermissions |
|
deal-advertiser-permissions:GetAdvertiserListDspDeals |
GET | /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList |
|
deal-advertiser-permissions:UpdateAdvertiserListDspDeals |
PUT | /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList |
|
deal-advertiser-permissions:ListRecommendedAdvertiserDspDeals |
POST | /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertiser/list |
|
deal-advertiser-permissions:UpdateRecommendedAdvertiserListDspDeals |
PUT | /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers |
|
deal-advertiser-permissions:DeleteRecommendedAdvertiserListDspDeals |
DELETE | /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers |
deal-proposals¶
Deal Proposals, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
deal-proposals:UpdateProposalStatus |
PUT | /dsp/inventory/proposal/{proposalId}/status |
|
deal-proposals:ListPublisherOfferings |
POST | /dsp/inventory/proposalSource/{sourceId}/publisherOfferings/list |
|
deal-proposals:GetPublisherProductRate |
POST | /dsp/inventory/proposalSource/{sourceId}/publisherProduct/{publisherProductId}/rate |
|
deal-proposals:ListPublisherProducts |
POST | /dsp/inventory/proposalSource/{sourceId}/publisherProducts/list |
|
deal-proposals:ListPublishers |
POST | /dsp/inventory/proposalSource/{sourceId}/publishers/list |
|
deal-proposals:ListAmazonMediaSignalsCollections |
POST | /dsp/inventory/proposalSources/amazonMedia/{amazonMediaPublisherId}/signals/collections/list |
|
deal-proposals:ListProposalSources |
POST | /dsp/inventory/proposalSources/list |
|
deal-proposals:UpdateProposals |
PUT | /dsp/inventory/proposals |
|
deal-proposals:CreateProposals |
POST | /dsp/inventory/proposals |
|
deal-proposals:BuyerBatchTransaction |
POST | /dsp/inventory/proposals/buyer/batchTransaction |
|
deal-proposals:ListProposals |
POST | /dsp/inventory/proposals/list |
|
deal-proposals:UpdateProposedDeals |
PUT | /dsp/inventory/proposedDeals |
|
deal-proposals:CreateProposedDeals |
POST | /dsp/inventory/proposedDeals |
|
deal-proposals:CalculateDealImpressions |
POST | /dsp/inventory/proposedDeals/amazonMedia/calculateImpressions |
|
deal-proposals:ListProposedDeals |
POST | /dsp/inventory/proposedDeals/list |
|
deal-proposals:UpdateProposedDealsRevisions |
PUT | /dsp/inventory/proposedDeals/revisions |
|
deal-proposals:CreateProposedDealsRevisions |
POST | /dsp/inventory/proposedDeals/revisions |
|
deal-proposals:DeleteProposedDealsRevisions |
POST | /dsp/inventory/proposedDeals/revisions/delete |
|
deal-proposals:UpdateProposedDealsStatuses |
PUT | /dsp/inventory/proposedDeals/status |
deals¶
Deals, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
deals:listDealsExchangesDspDeals |
POST | /dsp/inventory/deals/exchanges/list |
|
deals:listDealsInferredAttributes |
POST | /dsp/inventory/deals/inferredAttributes/list |
|
deals:listDealsDspDeals |
POST | /dsp/inventory/deals/list |
|
deals:listDealsPerformanceDspDeals |
POST | /dsp/inventory/deals/performance/list |
|
deals:dealInferredAttributes |
GET | /dsp/inventory/deals/{dealId}/inferredAttributes |
|
deals:dealListInferredSupplySellers |
POST | /dsp/inventory/deals/{dealId}/inferredAttributes/supplySellers/list |
|
deals:getDealLineItemsDspDeals |
GET | /dsp/inventory/deals/{dealId}/lineItems |
|
deals:listCMInventoryDiscoveryDeals |
POST | /dsp/inventorySourceDeals/list |
diagnostics¶
Diagnostics, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
diagnostics:campaignDiagnostics |
POST | /diagnostics/campaigns/issues |
discovery-advertised-product-categories-v1¶
Discovery - Advertised Product Categories - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-advertised-product-categories-v1:DspListAdvertisedProductCategoriesV1 |
POST | /dsp/v1/advertisedProductCategories/list |
discovery-apps-v1¶
Discovery - Apps - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-apps-v1:DspListDiscoveryAppsV1 |
POST | /dsp/v1/apps/list |
discovery-domain-lists-v1¶
Discovery - Domain Lists - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-domain-lists-v1:DspListDomainListsV1 |
POST | /dsp/v1/domainLists/list |
discovery-iab-content-categories-v1¶
Discovery - IAB Content Categories - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-iab-content-categories-v1:DspListDiscoveryIabContentCategoriesV1 |
POST | /dsp/v1/iabContentCategories/list |
discovery-inventory-source-exchanges-v1¶
Discovery - Inventory Source Exchanges - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-inventory-source-exchanges-v1:ListCMInventoryDiscoveryExchangesV1 |
POST | /dsp/v1/inventorySourceExchanges/list |
discovery-productand-product-category¶
Discovery - Product and Product Category, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-productand-product-category:dspContextualTargetingProductCategoryOptionsV1 |
POST | /dsp/v1/productCategories/list |
|
discovery-productand-product-category:dspContextualTargetingProductOptionsV1 |
POST | /dsp/v1/products/list |
|
discovery-productand-product-category:dspContextualTargetingProductCategoryOptionsV2 |
POST | /dsp/v2/productCategories/list |
|
discovery-productand-product-category:dspContextualTargetingProductOptionsV2 |
POST | /dsp/v2/products/list |
discovery-third-party-target-segments-v1¶
Discovery - Third-party Target Segments - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
discovery-third-party-target-segments-v1:DspListDiscoveryThirdPartyTargetSegmentsV1 |
POST | /dsp/v1/thirdPartyTargetSegments/list |
dsp-ad-creative-api-v1¶
DSP Ad Creative API - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-ad-creative-api-v1:createAdCreativeV1 |
POST | /dsp/v1/adCreatives |
|
dsp-ad-creative-api-v1:DspPostAdCreativeComponentModerationV1 |
POST | /dsp/v1/adCreatives/componentModerations/list |
|
dsp-ad-creative-api-v1:listAdCreativesV1 |
POST | /dsp/v1/adCreatives/list |
|
dsp-ad-creative-api-v1:listAdCreativeModerationV1 |
POST | /dsp/v1/adCreatives/moderations/list |
|
dsp-ad-creative-api-v1:previewAdCreativeV1 |
POST | /dsp/v1/adCreatives/preview |
|
dsp-ad-creative-api-v1:updateAdCreativeV1 |
PATCH | /dsp/v1/adCreatives/{adCreativeId} |
|
dsp-ad-creative-api-v1:validateAdCreativeV1 |
GET | /dsp/v1/adCreatives/{adCreativeId}/validation |
|
dsp-ad-creative-api-v1:updateAdExperiencesV1 |
PUT | /dsp/v1/adExperiences |
|
dsp-ad-creative-api-v1:listAdExperiencesV1 |
POST | /dsp/v1/adExperiences/list |
dsp-ad-creative-association-apiv1¶
DSP Ad Creative Association API V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-ad-creative-association-apiv1:createCreativeAssociationsV1 |
POST | /dsp/v1/adCreatives/associations/adGroups |
|
dsp-ad-creative-association-apiv1:patchCreativeAssociationsV1 |
PATCH | /dsp/v1/adCreatives/associations/adGroups |
|
dsp-ad-creative-association-apiv1:deleteCreativeAssociationsV1 |
POST | /dsp/v1/adCreatives/associations/adGroups/delete |
|
dsp-ad-creative-association-apiv1:listEligibleCreativesV1 |
POST | /dsp/v1/adCreatives/associations/adGroups/eligibleCreatives/list |
|
dsp-ad-creative-association-apiv1:listCreativeAssociationsV1 |
POST | /dsp/v1/adCreatives/associations/adGroups/list |
|
dsp-ad-creative-association-apiv1:listCreativeAssociationModerationsV1 |
POST | /dsp/v1/adCreatives/associations/adGroups/moderations/list |
dsp-advertiser¶
Amazon Ads API for DSP, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-advertiser:get__dsp_advertisers |
GET | /dsp/advertisers |
|
dsp-advertiser:get__dsp_advertisers_{advertiserId} |
GET | /dsp/advertisers/{advertiserId} |
dsp-campaigns¶
Amazon Ads API - Amazon DSP, version 3.1.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-campaigns:getCreatives |
GET | /dsp/creatives/ |
|
dsp-campaigns:getImageCreatives (deprecated) |
GET | /dsp/creatives/image |
|
dsp-campaigns:UpdateImageCreative (deprecated) |
PUT | /dsp/creatives/image |
|
dsp-campaigns:CreateImageCreative (deprecated) |
POST | /dsp/creatives/image |
|
dsp-campaigns:previewImageCreative (deprecated) |
POST | /dsp/creatives/image/preview |
|
dsp-campaigns:getRecCreatives (deprecated) |
GET | /dsp/creatives/rec |
|
dsp-campaigns:updateRecCreatives (deprecated) |
PUT | /dsp/creatives/rec |
|
dsp-campaigns:createRecCreatives (deprecated) |
POST | /dsp/creatives/rec |
|
dsp-campaigns:previewRecCreative (deprecated) |
POST | /dsp/creatives/rec/preview |
|
dsp-campaigns:getThirdPartyCreatives (deprecated) |
GET | /dsp/creatives/thirdparty |
|
dsp-campaigns:updateThirdPartyCreative (deprecated) |
PUT | /dsp/creatives/thirdparty |
|
dsp-campaigns:createThirdPartyCreative (deprecated) |
POST | /dsp/creatives/thirdparty |
|
dsp-campaigns:previewThirdPartyCreative (deprecated) |
POST | /dsp/creatives/thirdparty/preview |
|
dsp-campaigns:getVideoCreatives (deprecated) |
GET | /dsp/creatives/video |
|
dsp-campaigns:updateVideoCreatives (deprecated) |
PUT | /dsp/creatives/video |
|
dsp-campaigns:createVideoCreatives (deprecated) |
POST | /dsp/creatives/video |
|
dsp-campaigns:previewVideoCreative (deprecated) |
POST | /dsp/creatives/video/preview |
|
dsp-campaigns:getGeoLocations |
GET | /dsp/geoLocations |
|
dsp-campaigns:AssociateLineItemsToCreatives (deprecated) |
POST | /dsp/lineItemCreativeAssociations |
|
dsp-campaigns:getLineItems |
GET | /dsp/lineItems/ |
|
dsp-campaigns:updateLineItems |
PUT | /dsp/lineItems/ |
|
dsp-campaigns:getCreativeModeration (deprecated) |
GET | /dsp/moderation/creatives |
|
dsp-campaigns:getOrders |
GET | /dsp/orders/ |
|
dsp-campaigns:UpdateOrders |
PUT | /dsp/orders/ |
|
dsp-campaigns:getOrder |
GET | /dsp/orders/{orderId} |
|
dsp-campaigns:GetConversionTrackings |
GET | /dsp/orders/{orderId}/conversionTracking |
|
dsp-campaigns:put__dsp_orders_{orderId}_conversionTracking_products |
PUT | /dsp/orders/{orderId}/conversionTracking/products |
dsp-discovery¶
DSP Discovery, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-discovery:getGeoLocations |
GET | /dsp/geoLocations |
dsp-guidance¶
DSP Guidance, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-guidance:listAdGroupGuidanceV1 |
POST | /dsp/v1/guidance/adGroups/list |
|
dsp-guidance:listAdvertiserGuidanceV1 |
POST | /dsp/v1/guidance/advertisers/list |
|
dsp-guidance:listCampaignGuidanceV1 |
POST | /dsp/v1/guidance/campaigns/list |
dsp-quick-actions¶
DSP Quick Actions, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-quick-actions:batchCreateExecutionsV1 |
POST | /dsp/v1/quickactions/batchCreateExecutions |
|
dsp-quick-actions:batchGetExecutionsV1 |
POST | /dsp/v1/quickactions/batchGetExecutions |
|
dsp-quick-actions:createExecutionV1 |
POST | /dsp/v1/quickactions/{actionId}/executions |
|
dsp-quick-actions:getExecutionV1 |
GET | /dsp/v1/quickactions/{actionId}/executions/{executionId} |
|
dsp-quick-actions:startExecutionV1 |
PUT | /dsp/v1/quickactions/{actionId}/executions/{executionId}/start |
dsp-reports¶
DSP Reports, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-reports:createReportV3 |
POST | /accounts/{accountId}/dsp/reports |
|
dsp-reports:getCampaignReportV3 |
GET | /accounts/{accountId}/dsp/reports/{reportId} |
dsp-reports-v2¶
DSP Reports, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
dsp-reports-v2:createReportV2 |
POST | /dsp/reports |
|
dsp-reports-v2:getCampaignReportV2 |
GET | /dsp/reports/{reportId} |
eligibility¶
Eligibility, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
eligibility:productEligibility |
POST | /eligibility/product/list |
|
eligibility:ProgramEligibility |
POST | /eligibility/programs |
goal-seeking-bidder-target-kpi-recommendation¶
Goal Seeking Bidder Target KPI Recommendation, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
goal-seeking-bidder-target-kpi-recommendation:getGsbTargetKpiRecommendation |
POST | /dsp/campaigns/targetKpi/recommendations |
hashed-records¶
Hashed Records, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
hashed-records:UploadHashedRecords |
POST | /dp/records/hashed |
history¶
Change history, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
history:getHistory |
POST | /history |
typed |
inherited-settings-api-v1¶
Inherited Settings API - V1, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
inherited-settings-api-v1:CreateInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings |
|
inherited-settings-api-v1:DeleteInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings/delete |
|
inherited-settings-api-v1:CreateGeneralInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings/general |
|
inherited-settings-api-v1:DeleteGeneralInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings/general/delete |
|
inherited-settings-api-v1:ListGeneralInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings/general/list |
|
inherited-settings-api-v1:ListInheritedSettingsV1 |
POST | /dsp/v1/inheritedSettings/list |
insights¶
Insights, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
insights:insightsGetAudiencesOverlappingAudiences |
GET | /insights/audiences/{audienceId}/overlappingAudiences |
inventory-groups¶
Inventory Groups, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
inventory-groups:DspApiListEligibleInventoryGroupsV1 |
POST | /dsp/v1/inventory/eligibility/inventoryGroups/list |
|
inventory-groups:DspApiUpdateInventoryGroupV1 |
PUT | /dsp/v1/inventory/inventoryGroups |
|
inventory-groups:DspApiCreateInventoryGroupV1 |
POST | /dsp/v1/inventory/inventoryGroups |
|
inventory-groups:DspApiListInventoryGroupsV1 |
POST | /dsp/v1/inventory/inventoryGroups/list |
localization¶
Localization, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
localization:getLocalizedCurrencies |
POST | /currencies/localize |
|
localization:getLocalizedKeywords |
POST | /keywords/localize |
|
localization:getLocalizedProducts |
POST | /products/localize |
|
localization:getLocalizedTargetingExpression |
POST | /targetingExpression/localize |
locations¶
Locations, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
locations:listLocations |
POST | /locations/list |
manager-account¶
Manager Account, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
manager-account:getManagerAccountsForUser |
GET | /managerAccounts |
|
manager-account:createManagerAccount |
POST | /managerAccounts |
|
manager-account:LinkAdvertisingAccountsToManagerAccountPublicAPI |
POST | /managerAccounts/{managerAccountId}/associate |
|
manager-account:UnlinkAdvertisingAccountsToManagerAccountPublicAPI |
POST | /managerAccounts/{managerAccountId}/disassociate |
marketing-mix-modeling¶
Marketing Mix Modeling, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
marketing-mix-modeling:createMmmBrandGroupOverrides |
POST | /mmm/v1/brandGroupOverrides |
|
marketing-mix-modeling:deleteMmmBrandGroupOverrides |
POST | /mmm/v1/brandGroupOverrides/delete |
|
marketing-mix-modeling:listMmmBrandGroupOverrides |
POST | /mmm/v1/brandGroupOverrides/list |
|
marketing-mix-modeling:listMmmBrandGroups |
POST | /mmm/v1/brandGroups/list |
|
marketing-mix-modeling:getMmmBrandGroupCampaigns |
GET | /mmm/v1/brandGroups/{brandGroupId}/campaigns |
|
marketing-mix-modeling:getMmmBrandGroupProducts |
GET | /mmm/v1/brandGroups/{brandGroupId}/products |
|
marketing-mix-modeling:createMmmReport |
POST | /mmm/v1/reports |
|
marketing-mix-modeling:listMmmReports |
POST | /mmm/v1/reports/list |
|
marketing-mix-modeling:getMmmReport |
GET | /mmm/v1/reports/{reportId} |
|
marketing-mix-modeling:deleteMmmReport |
DELETE | /mmm/v1/reports/{reportId} |
mcp-account-management¶
account_management, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-account-management:create_advertiser_account |
POST | /mcp/create_advertiser_account |
MCP tool |
mcp-account-management:query_account_link |
POST | /mcp/query_account_link |
MCP tool |
mcp-account-management:query_advertiser_account |
POST | /mcp/query_advertiser_account |
MCP tool |
mcp-account-management:update_account_currency |
POST | /mcp/update_account_currency |
MCP tool |
mcp-account-management:update_account_name |
POST | /mcp/update_account_name |
MCP tool |
mcp-account-management:update_account_timezone |
POST | /mcp/update_account_timezone |
MCP tool |
mcp-account-management:update_advertiser_account |
POST | /mcp/update_advertiser_account |
MCP tool |
mcp-ads-accounts¶
ads_accounts, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-ads-accounts:create_ads_account |
POST | /mcp/create_ads_account |
MCP tool |
mcp-ads-accounts:get_ads_account |
POST | /mcp/get_ads_account |
MCP tool |
mcp-ads-accounts:list_ads_accounts |
POST | /mcp/list_ads_accounts |
MCP tool |
mcp-advertiser-product-group-eligibility¶
advertiser_product_group_eligibility, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-advertiser-product-group-eligibility:create |
POST | /mcp/create |
MCP tool |
mcp-advertiser-product-group-eligibility:query |
POST | /mcp/query |
MCP tool |
mcp-amazon-live¶
amazon_live, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-amazon-live:create_broadcast |
POST | /mcp/create_broadcast |
MCP tool |
mcp-amazon-live:create_broadcast_media_asset |
POST | /mcp/create_broadcast_media_asset |
MCP tool |
mcp-amazon-live:create_carousel_item |
POST | /mcp/create_carousel_item |
MCP tool |
mcp-amazon-live:create_channel |
POST | /mcp/create_channel |
MCP tool |
mcp-amazon-live:create_promo_code |
POST | /mcp/create_promo_code |
MCP tool |
mcp-amazon-live:delete_broadcast |
POST | /mcp/delete_broadcast |
MCP tool |
mcp-amazon-live:list_broadcast_media_assets |
POST | /mcp/list_broadcast_media_assets |
MCP tool |
mcp-amazon-live:list_broadcasts |
POST | /mcp/list_broadcasts |
MCP tool |
mcp-amazon-live:list_carousel_items |
POST | /mcp/list_carousel_items |
MCP tool |
mcp-amazon-live:list_channels |
POST | /mcp/list_channels |
MCP tool |
mcp-amazon-live:list_livestream_details |
POST | /mcp/list_livestream_details |
MCP tool |
mcp-amazon-live:list_promo_codes |
POST | /mcp/list_promo_codes |
MCP tool |
mcp-amazon-live:query_broadcasts |
POST | /mcp/query_broadcasts |
MCP tool |
mcp-amazon-live:query_channels |
POST | /mcp/query_channels |
MCP tool |
mcp-amazon-live:query_promo_code |
POST | /mcp/query_promo_code |
MCP tool |
mcp-amazon-live:retrieve_broadcast |
POST | /mcp/retrieve_broadcast |
MCP tool |
mcp-amazon-live:retrieve_channel |
POST | /mcp/retrieve_channel |
MCP tool |
mcp-amazon-live:retrieve_promo_code |
POST | /mcp/retrieve_promo_code |
MCP tool |
mcp-amazon-live:update_broadcast |
POST | /mcp/update_broadcast |
MCP tool |
mcp-amazon-live:update_broadcast_media_asset |
POST | /mcp/update_broadcast_media_asset |
MCP tool |
mcp-amazon-live:update_carousel_item |
POST | /mcp/update_carousel_item |
MCP tool |
mcp-amazon-live:update_channel |
POST | /mcp/update_channel |
MCP tool |
mcp-amazon-live:update_promo_code |
POST | /mcp/update_promo_code |
MCP tool |
mcp-amc¶
amc, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-amc:create_workflow |
POST | /mcp/create_workflow |
MCP tool |
mcp-amc:delete_workflow |
POST | /mcp/delete_workflow |
MCP tool |
mcp-amc:execute_query |
POST | /mcp/execute_query |
MCP tool |
mcp-amc:execute_workflow |
POST | /mcp/execute_workflow |
MCP tool |
mcp-amc:get_data_source |
POST | /mcp/get_data_source |
MCP tool |
mcp-amc:get_data_sources |
POST | /mcp/get_data_sources |
MCP tool |
mcp-amc:get_workflow |
POST | /mcp/get_workflow |
MCP tool |
mcp-amc:get_workflow_execution_download_url |
POST | /mcp/get_workflow_execution_download_url |
MCP tool |
mcp-amc:get_workflow_execution_status |
POST | /mcp/get_workflow_execution_status |
MCP tool |
mcp-amc:get_workflows |
POST | /mcp/get_workflows |
MCP tool |
mcp-billing¶
billing, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-billing:list_billing_profile_usages |
POST | /mcp/list_billing_profile_usages |
MCP tool |
mcp-billing:list_invoice_summaries |
POST | /mcp/list_invoice_summaries |
MCP tool |
mcp-billing:list_invoices |
POST | /mcp/list_invoices |
MCP tool |
mcp-billing:query_billing_notifications |
POST | /mcp/query_billing_notifications |
MCP tool |
mcp-campaign-management¶
campaign_management, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-campaign-management:add_country_campaign |
POST | /mcp/add_country_campaign |
MCP tool |
mcp-campaign-management:check_product_eligibility |
POST | /mcp/check_product_eligibility |
MCP tool |
mcp-campaign-management:create_ad |
POST | /mcp/create_ad |
MCP tool |
mcp-campaign-management:create_ad_association |
POST | /mcp/create_ad_association |
MCP tool |
mcp-campaign-management:create_ad_group |
POST | /mcp/create_ad_group |
MCP tool |
mcp-campaign-management:create_bid_adjustment_rule |
POST | /mcp/create_bid_adjustment_rule |
MCP tool |
mcp-campaign-management:create_campaign |
POST | /mcp/create_campaign |
MCP tool |
mcp-campaign-management:create_portfolio |
POST | /mcp/create_portfolio |
MCP tool |
mcp-campaign-management:create_singleshot_portfolio |
POST | /mcp/create_singleshot_portfolio |
MCP tool |
mcp-campaign-management:create_singleshot_sp_campaign |
POST | /mcp/create_singleshot_sp_campaign |
MCP tool |
mcp-campaign-management:create_target |
POST | /mcp/create_target |
MCP tool |
mcp-campaign-management:delete_ad |
POST | /mcp/delete_ad |
MCP tool |
mcp-campaign-management:delete_ad_association |
POST | /mcp/delete_ad_association |
MCP tool |
mcp-campaign-management:delete_ad_group |
POST | /mcp/delete_ad_group |
MCP tool |
mcp-campaign-management:delete_campaign |
POST | /mcp/delete_campaign |
MCP tool |
mcp-campaign-management:delete_target |
POST | /mcp/delete_target |
MCP tool |
mcp-campaign-management:dsp_create_conversion_tracking_products |
POST | /mcp/dsp_create_conversion_tracking_products |
MCP tool |
mcp-campaign-management:query_ad |
POST | /mcp/query_ad |
MCP tool |
mcp-campaign-management:query_ad_association |
POST | /mcp/query_ad_association |
MCP tool |
mcp-campaign-management:query_ad_group |
POST | /mcp/query_ad_group |
MCP tool |
mcp-campaign-management:query_campaign |
POST | /mcp/query_campaign |
MCP tool |
mcp-campaign-management:query_portfolio |
POST | /mcp/query_portfolio |
MCP tool |
mcp-campaign-management:query_target |
POST | /mcp/query_target |
MCP tool |
mcp-campaign-management:update_ad |
POST | /mcp/update_ad |
MCP tool |
mcp-campaign-management:update_ad_association |
POST | /mcp/update_ad_association |
MCP tool |
mcp-campaign-management:update_ad_group |
POST | /mcp/update_ad_group |
MCP tool |
mcp-campaign-management:update_campaign |
POST | /mcp/update_campaign |
MCP tool |
mcp-campaign-management:update_campaign_budget |
POST | /mcp/update_campaign_budget |
MCP tool |
mcp-campaign-management:update_campaign_state |
POST | /mcp/update_campaign_state |
MCP tool |
mcp-campaign-management:update_portfolio |
POST | /mcp/update_portfolio |
MCP tool |
mcp-campaign-management:update_target |
POST | /mcp/update_target |
MCP tool |
mcp-campaign-management:update_target_bid |
POST | /mcp/update_target_bid |
MCP tool |
mcp-eligibility¶
eligibility, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-eligibility:product_list |
POST | /mcp/product_list |
MCP tool |
mcp-eligibility:programs |
POST | /mcp/programs |
MCP tool |
mcp-manager-accounts¶
manager_accounts, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-manager-accounts:associate_accounts |
POST | /mcp/associate_accounts |
MCP tool |
mcp-manager-accounts:create_manager_account |
POST | /mcp/create_manager_account |
MCP tool |
mcp-manager-accounts:disassociate_accounts |
POST | /mcp/disassociate_accounts |
MCP tool |
mcp-manager-accounts:get_manager_accounts |
POST | /mcp/get_manager_accounts |
MCP tool |
mcp-promotions¶
promotions, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-promotions:query_promotion_offers |
POST | /mcp/query_promotion_offers |
MCP tool |
mcp-promotions:query_promotion_rewards |
POST | /mcp/query_promotion_rewards |
MCP tool |
mcp-promotions:redeem_promotion_code |
POST | /mcp/redeem_promotion_code |
MCP tool |
mcp-reporting¶
reporting, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-reporting:create_campaign_report |
POST | /mcp/create_campaign_report |
MCP tool |
mcp-reporting:create_inventory_report |
POST | /mcp/create_inventory_report |
MCP tool |
mcp-reporting:create_product_report |
POST | /mcp/create_product_report |
MCP tool |
mcp-reporting:create_report |
POST | /mcp/create_report |
MCP tool |
mcp-reporting:delete_report |
POST | /mcp/delete_report |
MCP tool |
mcp-reporting:retrieve_report |
POST | /mcp/retrieve_report |
MCP tool |
mcp-terms-token¶
terms_token, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-terms-token:create_terms_token |
POST | /mcp/create_terms_token |
MCP tool |
mcp-terms-token:get_terms_token |
POST | /mcp/get_terms_token |
MCP tool |
mcp-test-accounts¶
test_accounts, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-test-accounts:create_test_account |
POST | /mcp/create_test_account |
MCP tool |
mcp-test-accounts:get_test_accounts |
POST | /mcp/get_test_accounts |
MCP tool |
mcp-user-invitation¶
user_invitation, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-user-invitation:get |
POST | /mcp/get |
MCP tool |
mcp-user-invitation:redeem |
POST | /mcp/redeem |
MCP tool |
mcp-user-invitations¶
user_invitations, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-user-invitations:create |
POST | /mcp/create |
MCP tool |
mcp-user-invitations:list |
POST | /mcp/list |
MCP tool |
mcp-user-invitations:update |
POST | /mcp/update |
MCP tool |
mcp-user-permissions¶
user_permissions, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-user-permissions:delete_user_permissions |
POST | /mcp/delete_user_permissions |
MCP tool |
mcp-user-permissions:list_user_permissions |
POST | /mcp/list_user_permissions |
MCP tool |
mcp-user-permissions:update_user_permissions |
POST | /mcp/update_user_permissions |
MCP tool |
mcp-user-roles¶
user_roles, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-user-roles:list_user_roles |
POST | /mcp/list_user_roles |
MCP tool |
mcp-users¶
users, version v1.
Tools of Amazon's hosted Ads MCP server, not Ads API endpoints. call() refuses them.
| Operation id | Method | Path | Flags |
|---|---|---|---|
mcp-users:list_users |
POST | /mcp/list_users |
MCP tool |
measurement¶
Measurement, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
measurement:CheckDSPAudienceResearchEligibility |
POST | /dsp/measurement/eligibility/audienceResearch |
|
measurement:CheckDSPBrandLiftEligibility |
POST | /dsp/measurement/eligibility/brandLift |
|
measurement:CheckDSPCreativeTestingEligibility |
POST | /dsp/measurement/eligibility/creativeTesting |
|
measurement:CheckDSPOmnichannelMetricsEligibility |
POST | /dsp/measurement/eligibility/omnichannelMetrics |
|
measurement:GetDSPAudienceResearchStudies |
GET | /dsp/measurement/studies/audienceResearch |
|
measurement:CreateDSPAudienceResearchStudy |
POST | /dsp/measurement/studies/audienceResearch |
|
measurement:UpdateDSPAudienceResearchStudy |
PUT | /dsp/measurement/studies/audienceResearch/{studyId} |
|
measurement:GetDSPAudienceResearchStudyResult |
GET | /dsp/measurement/studies/audienceResearch/{studyId}/result |
|
measurement:GetDSPBrandLiftStudies |
GET | /dsp/measurement/studies/brandLift |
|
measurement:UpdateDSPBrandLiftStudies |
PUT | /dsp/measurement/studies/brandLift |
|
measurement:CreateDSPBrandLiftStudies |
POST | /dsp/measurement/studies/brandLift |
|
measurement:GetDSPCreativeTestingStudies |
GET | /dsp/measurement/studies/creativeTesting |
|
measurement:CreateDSPCreativeTestingStudy |
POST | /dsp/measurement/studies/creativeTesting |
|
measurement:UpdateDSPCreativeTestingStudy |
PUT | /dsp/measurement/studies/creativeTesting/{studyId} |
|
measurement:GetDSPCreativeTestingStudyResult |
GET | /dsp/measurement/studies/creativeTesting/{studyId}/result |
|
measurement:GetDSPOmnichannelMetricsStudies |
GET | /dsp/measurement/studies/omnichannelMetrics |
|
measurement:UpdateDSPOmnichannelMetricsStudies |
PUT | /dsp/measurement/studies/omnichannelMetrics |
|
measurement:CreateDSPOmnichannelMetricsStudies |
POST | /dsp/measurement/studies/omnichannelMetrics |
|
measurement:GetDSPOmnichannelMetricsStudyResult |
GET | /dsp/measurement/studies/omnichannelMetrics/{studyId}/result |
|
measurement:CheckPlanningEligibility |
POST | /measurement/planning/eligibility |
|
measurement:GetStudies |
GET | /measurement/studies |
|
measurement:CancelMeasurementStudies |
DELETE | /measurement/studies |
|
measurement:GetDSPBrandLiftStudyResult |
GET | /measurement/studies/brandLift/{studyId}/result |
|
measurement:GetSurveys |
GET | /measurement/studies/surveys |
|
measurement:UpdateSurveys |
PUT | /measurement/studies/surveys |
|
measurement:CreateSurveys |
POST | /measurement/studies/surveys |
|
measurement:vendorProduct |
POST | /measurement/vendorProducts/list |
|
measurement:omnichannelMetricsBrandSearch |
POST | /measurement/vendorProducts/omnichannelMetrics/brands/list |
|
measurement:vendorProductPolicy |
GET | /measurement/vendorProducts/policies |
|
measurement:vendorProductSurveyQuestionTemplates |
GET | /measurement/vendorProducts/surveyQuestionTemplates |
media-insights-hub¶
Media Insights Hub, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
media-insights-hub:ListHistoricalReachCurves |
POST | /mediaPlan/historicalReachCurves/list |
|
media-insights-hub:ListHistoricalReachCurvesMetadata |
POST | /mediaPlan/historicalReachCurvesMetadata/list |
|
media-insights-hub:CreateHistoricalReachCurve |
POST | /mediaPlan/v2/historicalReachCurves |
|
media-insights-hub:GetHistoricalReachCurve |
GET | /mediaPlan/v2/historicalReachCurves/{reportId} |
|
media-insights-hub:GetHistoricalReachCurveStatus |
GET | /mediaPlan/v2/historicalReachCurves/{reportId}/status |
media-planning-api¶
Media Planning API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
media-planning-api:UpdateAudienceOpportunitiesV1 |
PUT | /mediaPlan/v1/audienceOpportunities |
|
media-planning-api:CreateAudienceOpportunitiesV1 |
POST | /mediaPlan/v1/audienceOpportunities |
|
media-planning-api:DeleteAudienceOpportunitiesV1 |
POST | /mediaPlan/v1/audienceOpportunities/delete |
|
media-planning-api:ListAudienceOpportunitiesV1 |
POST | /mediaPlan/v1/audienceOpportunities/list |
|
media-planning-api:ReadAudienceOpportunityV1 |
GET | /mediaPlan/v1/audienceOpportunities/{audienceOpportunityId} |
|
media-planning-api:ListAudienceSizesV1 |
POST | /mediaPlan/v1/audienceSizes/list |
|
media-planning-api:ReadAudienceSizeV1 |
GET | /mediaPlan/v1/audienceSizes/{audienceSizeId} |
|
media-planning-api:ListBehavioralInsightsV1 |
POST | /mediaPlan/v1/behavioralInsights/list |
|
media-planning-api:ReadBehavioralInsightV1 |
GET | /mediaPlan/v1/behavioralInsights/{behavioralInsightId} |
|
media-planning-api:UpdateBudgetAllocationsV1 |
PUT | /mediaPlan/v1/budgetAllocations |
|
media-planning-api:CreateBudgetAllocationsV1 |
POST | /mediaPlan/v1/budgetAllocations |
|
media-planning-api:DeleteBudgetAllocationsV1 |
POST | /mediaPlan/v1/budgetAllocations/delete |
|
media-planning-api:ListBudgetAllocationsV1 |
POST | /mediaPlan/v1/budgetAllocations/list |
|
media-planning-api:ReadBudgetAllocationV1 |
GET | /mediaPlan/v1/budgetAllocations/{budgetAllocationId} |
|
media-planning-api:ListDemographicInsightsV1 |
POST | /mediaPlan/v1/demographicInsights/list |
|
media-planning-api:ReadDemographicInsightV1 |
GET | /mediaPlan/v1/demographicInsights/{demographicInsightId} |
|
media-planning-api:CreateMediaPlanExportsV1 |
POST | /mediaPlan/v1/exports/mediaPlans |
|
media-planning-api:UpdateMarketingGoalsV1 |
PUT | /mediaPlan/v1/marketingGoals |
|
media-planning-api:CreateMarketingGoalsV1 |
POST | /mediaPlan/v1/marketingGoals |
|
media-planning-api:DeleteMarketingGoalsV1 |
POST | /mediaPlan/v1/marketingGoals/delete |
|
media-planning-api:ListMarketingGoalsV1 |
POST | /mediaPlan/v1/marketingGoals/list |
|
media-planning-api:ReadMarketingGoalV1 |
GET | /mediaPlan/v1/marketingGoals/{marketingGoalId} |
|
media-planning-api:UpdateMediaPlansV1 |
PUT | /mediaPlan/v1/mediaPlans |
|
media-planning-api:CreateMediaPlansV1 |
POST | /mediaPlan/v1/mediaPlans |
|
media-planning-api:DeleteMediaPlansV1 |
POST | /mediaPlan/v1/mediaPlans/delete |
|
media-planning-api:ListMediaPlansV1 |
POST | /mediaPlan/v1/mediaPlans/list |
|
media-planning-api:ReadMediaPlanV1 |
GET | /mediaPlan/v1/mediaPlans/{mediaPlanId} |
|
media-planning-api:ListPerformanceForecastsV1 |
POST | /mediaPlan/v1/performanceForecasts/list |
|
media-planning-api:ReadPerformanceForecastV1 |
GET | /mediaPlan/v1/performanceForecasts/{performanceForecastId} |
|
media-planning-api:UpdatePlanningItemsV1 |
PUT | /mediaPlan/v1/planningItems |
|
media-planning-api:CreatePlanningItemsV1 |
POST | /mediaPlan/v1/planningItems |
|
media-planning-api:DeletePlanningItemsV1 |
POST | /mediaPlan/v1/planningItems/delete |
|
media-planning-api:ListPlanningItemsV1 |
POST | /mediaPlan/v1/planningItems/list |
|
media-planning-api:ReadPlanningItemV1 |
GET | /mediaPlan/v1/planningItems/{planningItemId} |
|
media-planning-api:UpdateTargetsV1 |
PUT | /mediaPlan/v1/targets |
|
media-planning-api:CreateTargetsV1 |
POST | /mediaPlan/v1/targets |
|
media-planning-api:DeleteTargetsV1 |
POST | /mediaPlan/v1/targets/delete |
|
media-planning-api:ListTargetsV1 |
POST | /mediaPlan/v1/targets/list |
|
media-planning-api:ReadTargetV1 |
GET | /mediaPlan/v1/targets/{targetId} |
|
media-planning-api:ListTrafficInsightsV1 |
POST | /mediaPlan/v1/trafficInsights/list |
|
media-planning-api:ReadTrafficInsightV1 |
GET | /mediaPlan/v1/trafficInsights/{trafficInsightId} |
moderation¶
Moderation, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
moderation:moderationResults |
POST | /moderation/results |
partner-opportunities¶
Partner Opportunities, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
partner-opportunities:partnerOpportunitiesListOpportunities |
GET | /partnerOpportunities |
|
partner-opportunities:partnerOpportunitiesSummarizeOpportunities |
GET | /partnerOpportunities/summary |
|
partner-opportunities:partnerOpportunitiesApplicationStatus |
POST | /partnerOpportunities/{partnerOpportunityId}/applicationStatus |
|
partner-opportunities:partnerOpportunitiesApply |
POST | /partnerOpportunities/{partnerOpportunityId}/apply |
|
partner-opportunities:partnerOpportunitiesGetOpportunityFile |
GET | /partnerOpportunities/{partnerOpportunityId}/file |
persona-builder-api¶
Persona Builder API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
persona-builder-api:BandedSize |
POST | /insights/bandedSize |
|
persona-builder-api:Demographics |
POST | /insights/demographics |
|
persona-builder-api:PrimeVideo |
POST | /insights/primeVideo |
|
persona-builder-api:TopCategoriesPurchased |
POST | /insights/topCategoriesPurchased |
|
persona-builder-api:TopOverlappingAudiences |
POST | /insights/topOverlappingAudiences |
portfolios¶
Portfolios, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
portfolios:UpdatePortfolios |
PUT | /portfolios |
typed |
portfolios:CreatePortfolios |
POST | /portfolios |
typed |
portfolios:portfolioBudgetUsage |
POST | /portfolios/budget/usage |
typed |
portfolios:ListPortfolios |
POST | /portfolios/list |
typed |
posts¶
Posts, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
posts:CreatePost |
POST | /bp/v2/posts |
|
posts:ListPosts |
POST | /bp/v2/posts/list |
|
posts:GetPost |
GET | /bp/v2/posts/{postId} |
|
posts:UpdatePost |
PUT | /bp/v2/posts/{postId} |
|
posts:SubmitPostForReview |
PUT | /bp/v2/posts/{postId}/submitForReview |
|
posts:WithdrawPost |
PUT | /bp/v2/posts/{postId}/unpublish |
|
posts:GetPostProducts |
GET | /bp/v2/products/list |
|
posts:ListProfiles |
GET | /bp/v2/profiles |
|
posts:GetProfile |
GET | /bp/v2/profiles/{profileId} |
|
posts:GetProfileMetrics |
POST | /bp/v2/profiles/{profileId}/metrics |
|
posts:GetReportDownloadLink |
GET | /bp/v2/profiles/{profileId}/metrics/download |
pre-moderation¶
PreModeration, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
pre-moderation:preModeration |
POST | /preModeration |
product-selector¶
Product Selector, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
product-selector:ProductMetadata |
POST | /product/metadata |
profiles¶
Amazon Ads API - Profiles, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
profiles:listProfiles |
GET | /v2/profiles |
typed |
profiles:updateProfiles |
PUT | /v2/profiles |
typed |
profiles:getProfileById |
GET | /v2/profiles/{profileId} |
typed |
reach-planning-service¶
Reach Planning Service, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
reach-planning-service:CreateDeduplicatedReachForecastsV1 |
POST | /mediaPlan/v1/deduplicatedReachForecasts |
|
reach-planning-service:GeneratePerformanceForecastsV1 |
POST | /mediaPlan/v1/performanceForecasts |
|
reach-planning-service:CreateReachForecastsV1 |
POST | /mediaPlan/v1/reachForecasts |
|
reach-planning-service:ListReachForecastsV1 |
POST | /mediaPlan/v1/reachForecasts/list |
|
reach-planning-service:ListReachForecastTargetsV1 |
POST | /mediaPlan/v1/reachForecasts/targets/list |
reporting¶
Offline Report, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
reporting:createAsyncReport |
POST | /reporting/reports |
typed |
reporting:getAsyncReport |
GET | /reporting/reports/{reportId} |
typed |
reporting:deleteAsyncReport |
DELETE | /reporting/reports/{reportId} |
typed |
retailer-identity-ap-ifor-retail-ad-service¶
Retailer Identity API for Retail Ad Service, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
retailer-identity-ap-ifor-retail-ad-service:RASv1ListRetailers |
POST | /ras/v1/retailers/list |
rule-based-audiences¶
Rule-Based Audiences, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
rule-based-audiences:createLookalikeAudience |
POST | /amc/audiences/lookalike |
|
rule-based-audiences:getAllQueryBasedAudiencesByInstanceId |
GET | /amc/audiences/query |
|
rule-based-audiences:createQueryBasedAudience |
POST | /amc/audiences/query |
|
rule-based-audiences:getQueryBasedAudienceByAudienceExecutionId |
GET | /amc/audiences/query/{audienceExecutionId} |
|
rule-based-audiences:updateQueryBasedAudienceByAudienceExecutionId |
PUT | /amc/audiences/query/{audienceExecutionId} |
|
rule-based-audiences:deleteQueryBasedAudienceByAudienceExecutionId |
DELETE | /amc/audiences/query/{audienceExecutionId} |
seat-i-ds¶
Seat IDs, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
seat-i-ds:listCurrentSeatIds |
POST | /dsp/seats/current/list |
sponsored-brands-category-benchmark¶
Sponsored Brands Category Benchmark, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-brands-category-benchmark:getBrands |
GET | /benchmarks/brands |
|
sponsored-brands-category-benchmark:getTimeSeries |
POST | /benchmarks/brands/{brandName}/categories/{categoryId} |
|
sponsored-brands-category-benchmark:getReportData |
POST | /benchmarks/brandsAndCategories |
sponsored-brands-v3¶
Amazon Ads API - Sponsored Brands, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-brands-v3:getBrands |
GET | /brands |
|
sponsored-brands-v3:describeMedia |
GET | /media/describe |
|
sponsored-brands-v3:listAsins |
GET | /pageAsins |
|
sponsored-brands-v3:SBGetBudgetRulesRecommendation |
POST | /sb/campaigns/budgetRules/recommendations |
|
sponsored-brands-v3:listKeywords |
GET | /sb/keywords |
|
sponsored-brands-v3:updateKeywords |
PUT | /sb/keywords |
|
sponsored-brands-v3:createKeywords |
POST | /sb/keywords |
|
sponsored-brands-v3:getKeyword |
GET | /sb/keywords/{keywordId} |
|
sponsored-brands-v3:archiveKeyword |
DELETE | /sb/keywords/{keywordId} |
|
sponsored-brands-v3:get__sb_moderation_campaigns_{campaignId} (deprecated) |
GET | /sb/moderation/campaigns/{campaignId} |
|
sponsored-brands-v3:listNegativeKeywords |
GET | /sb/negativeKeywords |
|
sponsored-brands-v3:updateNegativeKeywords |
PUT | /sb/negativeKeywords |
|
sponsored-brands-v3:createNegativeKeywords |
POST | /sb/negativeKeywords |
|
sponsored-brands-v3:getNegativeKeyword |
GET | /sb/negativeKeywords/{keywordId} |
|
sponsored-brands-v3:archiveNegativeKeyword |
DELETE | /sb/negativeKeywords/{keywordId} |
|
sponsored-brands-v3:updateNegativeTargets |
PUT | /sb/negativeTargets |
|
sponsored-brands-v3:createNegativeTargets |
POST | /sb/negativeTargets |
|
sponsored-brands-v3:listNegativeTargets |
POST | /sb/negativeTargets/list |
|
sponsored-brands-v3:getNegativeTarget |
GET | /sb/negativeTargets/{negativeTargetId} |
|
sponsored-brands-v3:archiveNegativeTarget |
DELETE | /sb/negativeTargets/{negativeTargetId} |
|
sponsored-brands-v3:getBidsRecommendations |
POST | /sb/recommendations/bids |
|
sponsored-brands-v3:getKeywordRecommendations |
POST | /sb/recommendations/keyword |
|
sponsored-brands-v3:getBrandRecommendations |
POST | /sb/recommendations/targets/brand |
|
sponsored-brands-v3:getTargetingCategories |
POST | /sb/recommendations/targets/category |
|
sponsored-brands-v3:getProductRecommendations |
POST | /sb/recommendations/targets/product/list |
|
sponsored-brands-v3:updateTargets |
PUT | /sb/targets |
|
sponsored-brands-v3:createTargets |
POST | /sb/targets |
|
sponsored-brands-v3:listTargets |
POST | /sb/targets/list |
|
sponsored-brands-v3:getTarget |
GET | /sb/targets/{targetId} |
|
sponsored-brands-v3:archiveTarget |
DELETE | /sb/targets/{targetId} |
|
sponsored-brands-v3:sbUpdateThemes |
PUT | /sb/themes |
|
sponsored-brands-v3:sbCreateThemes |
POST | /sb/themes |
|
sponsored-brands-v3:sbListThemes |
POST | /sb/themes/list |
|
sponsored-brands-v3:listAssets |
GET | /stores/assets |
|
sponsored-brands-v3:createAsset |
POST | /stores/assets |
|
sponsored-brands-v3:post__v2_hsa_{recordType}_report |
POST | /v2/hsa/{recordType}/report |
|
sponsored-brands-v3:get__v2_reports_{reportId} |
GET | /v2/reports/{reportId} |
|
sponsored-brands-v3:downloadReport |
GET | /v2/reports/{reportId}/download |
sponsored-brands-v4¶
Sponsored Brands campaign management, version 4.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-brands-v4:UpdateSponsoredBrandsAutoCollectionAds |
POST | /sb/ads/creatives/autoCollection |
|
sponsored-brands-v4:CreateBrandVideoCreative |
POST | /sb/ads/creatives/brandVideo |
|
sponsored-brands-v4:ListCreatives |
POST | /sb/ads/creatives/list |
|
sponsored-brands-v4:UpdateSponsoredBrandsManualCollectionAds |
POST | /sb/ads/creatives/manualCollection |
|
sponsored-brands-v4:CreateProductCollectionCreative (deprecated) |
POST | /sb/ads/creatives/productCollection |
|
sponsored-brands-v4:CreateExtendedProductCollectionCreative (deprecated) |
POST | /sb/ads/creatives/productCollectionExtended |
|
sponsored-brands-v4:CreateStoreSpotlightCreative |
POST | /sb/ads/creatives/storeSpotlight |
|
sponsored-brands-v4:CreateVideoCreative |
POST | /sb/ads/creatives/video |
|
sponsored-brands-v4:GetSBBudgetRulesForAdvertiser |
GET | /sb/budgetRules |
|
sponsored-brands-v4:UpdateBudgetRulesForSBCampaigns |
PUT | /sb/budgetRules |
|
sponsored-brands-v4:CreateBudgetRulesForSBCampaigns |
POST | /sb/budgetRules |
|
sponsored-brands-v4:GetBudgetRuleByRuleIdForSBCampaigns |
GET | /sb/budgetRules/{budgetRuleId} |
|
sponsored-brands-v4:GetCampaignsAssociatedWithSBBudgetRule |
GET | /sb/budgetRules/{budgetRuleId}/campaigns |
|
sponsored-brands-v4:sbCampaignsBudgetUsage |
POST | /sb/campaigns/budget/usage |
|
sponsored-brands-v4:GetBudgetRecommendations |
POST | /sb/campaigns/budgetRecommendations |
|
sponsored-brands-v4:SBInsightsCampaignInsights |
POST | /sb/campaigns/insights |
|
sponsored-brands-v4:ListAssociatedBudgetRulesForSBCampaigns |
GET | /sb/campaigns/{campaignId}/budgetRules |
|
sponsored-brands-v4:CreateAssociatedBudgetRulesForSBCampaigns |
POST | /sb/campaigns/{campaignId}/budgetRules |
|
sponsored-brands-v4:DisassociateAssociatedBudgetRuleForSBCampaigns |
DELETE | /sb/campaigns/{campaignId}/budgetRules/{budgetRuleId} |
|
sponsored-brands-v4:SBCampaignPerformanceForecasts |
POST | /sb/forecasts |
|
sponsored-brands-v4:SBTargetingGetNegativeBrands |
GET | /sb/negativeTargets/brands/recommendations |
|
sponsored-brands-v4:getHeadlineRecommendations |
POST | /sb/recommendations/creative/headline |
|
sponsored-brands-v4:SBOptimizationRecommendation |
POST | /sb/recommendations/optimization |
|
sponsored-brands-v4:UpdateSponsoredBrandsOptimizationRules |
PUT | /sb/rules/optimization |
|
sponsored-brands-v4:CreateSponsoredBrandsOptimizationRules |
POST | /sb/rules/optimization |
|
sponsored-brands-v4:AssociateSponsoredBrandsOptimizationRules |
POST | /sb/rules/optimization/associate |
|
sponsored-brands-v4:DisassociateSponsoredBrandsOptimizationRules |
POST | /sb/rules/optimization/disassociate |
|
sponsored-brands-v4:ListSponsoredBrandsOptimizationRules |
POST | /sb/rules/optimization/list |
|
sponsored-brands-v4:SBTargetingGetTargetableCategories |
GET | /sb/targets/categories |
|
sponsored-brands-v4:SBTargetingGetRefinementsForCategory |
GET | /sb/targets/categories/{categoryRefinementId}/refinements |
|
sponsored-brands-v4:SBTargetingGetTargetableASINCounts |
POST | /sb/targets/products/count |
|
sponsored-brands-v4:UpdateSponsoredBrandsAdGroups |
PUT | /sb/v4/adGroups |
|
sponsored-brands-v4:CreateSponsoredBrandsAdGroups |
POST | /sb/v4/adGroups |
|
sponsored-brands-v4:DeleteSponsoredBrandsAdGroups |
POST | /sb/v4/adGroups/delete |
|
sponsored-brands-v4:ListSponsoredBrandsAdGroups |
POST | /sb/v4/adGroups/list |
|
sponsored-brands-v4:UpdateSponsoredBrandsAds |
PUT | /sb/v4/ads |
|
sponsored-brands-v4:CreateSponsoredBrandsAutoCollectionAds |
POST | /sb/v4/ads/autoCollection |
|
sponsored-brands-v4:CreateSponsoredBrandsBrandVideoAds |
POST | /sb/v4/ads/brandVideo |
|
sponsored-brands-v4:DeleteSponsoredBrandsAds |
POST | /sb/v4/ads/delete |
|
sponsored-brands-v4:ListSponsoredBrandsAds |
POST | /sb/v4/ads/list |
|
sponsored-brands-v4:CreateSponsoredBrandsManualCollectionAds |
POST | /sb/v4/ads/manualCollection |
|
sponsored-brands-v4:CreateSponsoredBrandsProductCollectionAds (deprecated) |
POST | /sb/v4/ads/productCollection |
|
sponsored-brands-v4:CreateSponsoredBrandsExtendedProductCollectionAds (deprecated) |
POST | /sb/v4/ads/productCollectionExtended |
|
sponsored-brands-v4:CreateSponsoredBrandStoreSpotlightAds |
POST | /sb/v4/ads/storeSpotlight |
|
sponsored-brands-v4:CreateSponsoredBrandsVideoAds |
POST | /sb/v4/ads/video |
|
sponsored-brands-v4:UpdateSponsoredBrandsCampaigns |
PUT | /sb/v4/campaigns |
|
sponsored-brands-v4:CreateSponsoredBrandsCampaigns |
POST | /sb/v4/campaigns |
|
sponsored-brands-v4:DeleteSponsoredBrandsCampaigns |
POST | /sb/v4/campaigns/delete |
|
sponsored-brands-v4:ListSponsoredBrandsCampaigns |
POST | /sb/v4/campaigns/list |
|
sponsored-brands-v4:StartMigrationJob |
POST | /sb/v4/legacyCampaigns/migrationJob |
|
sponsored-brands-v4:MigrationJobResults |
POST | /sb/v4/legacyCampaigns/migrationJob/results |
|
sponsored-brands-v4:MigrationJobStatus |
POST | /sb/v4/legacyCampaigns/migrationJob/status |
|
sponsored-brands-v4:MigrationResults |
POST | /sb/v4/legacyCampaigns/overallMigrationResults |
|
sponsored-brands-v4:ListMigrations |
POST | /sb/v4/migrations/list |
sponsored-display¶
Amazon Ads API for Sponsored Display, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-display:listAdGroups |
GET | /sd/adGroups |
|
sponsored-display:updateAdGroups |
PUT | /sd/adGroups |
|
sponsored-display:createAdGroups |
POST | /sd/adGroups |
|
sponsored-display:listAdGroupsEx |
GET | /sd/adGroups/extended |
|
sponsored-display:getAdGroupResponseEx |
GET | /sd/adGroups/extended/{adGroupId} |
|
sponsored-display:getAdGroup |
GET | /sd/adGroups/{adGroupId} |
|
sponsored-display:archiveAdGroup |
DELETE | /sd/adGroups/{adGroupId} |
|
sponsored-display:get__sd_adGroups_{adGroupId}_optimizationRules |
GET | /sd/adGroups/{adGroupId}/optimizationRules |
|
sponsored-display:associateOptimizationRulesWithAdGroup |
POST | /sd/adGroups/{adGroupId}/optimizationRules |
|
sponsored-display:disassociateOptimizationRulesFromAdGroup |
POST | /sd/adGroups/{adGroupId}/optimizationRules/disassociate |
|
sponsored-display:listDomains |
GET | /sd/brandSafety/deny |
|
sponsored-display:createBrandSafetyDenyListDomains |
POST | /sd/brandSafety/deny |
|
sponsored-display:deleteBrandSafetyDenyList |
DELETE | /sd/brandSafety/deny |
|
sponsored-display:listRequestStatus |
GET | /sd/brandSafety/status |
|
sponsored-display:getRequestResults |
GET | /sd/brandSafety/{requestId}/results |
|
sponsored-display:getRequestStatus |
GET | /sd/brandSafety/{requestId}/status |
|
sponsored-display:GetSDBudgetRulesForAdvertiser |
GET | /sd/budgetRules |
|
sponsored-display:UpdateBudgetRulesForSDCampaigns |
PUT | /sd/budgetRules |
|
sponsored-display:CreateBudgetRulesForSDCampaigns |
POST | /sd/budgetRules |
|
sponsored-display:GetBudgetRuleByRuleIdForSDCampaigns |
GET | /sd/budgetRules/{budgetRuleId} |
|
sponsored-display:GetCampaignsAssociatedWithSDBudgetRule |
GET | /sd/budgetRules/{budgetRuleId}/campaigns |
|
sponsored-display:listCampaigns |
GET | /sd/campaigns |
|
sponsored-display:updateCampaigns |
PUT | /sd/campaigns |
|
sponsored-display:createCampaigns |
POST | /sd/campaigns |
|
sponsored-display:sdCampaignsBudgetUsage |
POST | /sd/campaigns/budget/usage |
|
sponsored-display:getSDBudgetRecommendations |
POST | /sd/campaigns/budgetRecommendations |
|
sponsored-display:listCampaignsEx |
GET | /sd/campaigns/extended |
|
sponsored-display:getCampaignResponseEx |
GET | /sd/campaigns/extended/{campaignId} |
|
sponsored-display:getCampaign |
GET | /sd/campaigns/{campaignId} |
|
sponsored-display:archiveCampaign |
DELETE | /sd/campaigns/{campaignId} |
|
sponsored-display:ListAssociatedBudgetRulesForSDCampaigns |
GET | /sd/campaigns/{campaignId}/budgetRules |
|
sponsored-display:CreateAssociatedBudgetRulesForSDCampaigns |
POST | /sd/campaigns/{campaignId}/budgetRules |
|
sponsored-display:DisassociateAssociatedBudgetRuleForSDCampaigns |
DELETE | /sd/campaigns/{campaignId}/budgetRules/{budgetRuleId} |
|
sponsored-display:listCreatives |
GET | /sd/creatives |
|
sponsored-display:updateCreatives |
PUT | /sd/creatives |
|
sponsored-display:createCreatives |
POST | /sd/creatives |
|
sponsored-display:postCreativePreview |
POST | /sd/creatives/preview |
|
sponsored-display:createSDForecast |
POST | /sd/forecasts |
|
sponsored-display:listLocations |
GET | /sd/locations |
|
sponsored-display:createLocations |
POST | /sd/locations |
|
sponsored-display:archiveLocations |
POST | /sd/locations/delete |
|
sponsored-display:listCreativeModerations |
GET | /sd/moderation/creatives |
|
sponsored-display:listNegativeTargetingClauses |
GET | /sd/negativeTargets |
|
sponsored-display:updateNegativeTargetingClauses |
PUT | /sd/negativeTargets |
|
sponsored-display:createNegativeTargetingClauses |
POST | /sd/negativeTargets |
|
sponsored-display:listNegativeTargetingClausesEx |
GET | /sd/negativeTargets/extended |
|
sponsored-display:getNegativeTargetsEx |
GET | /sd/negativeTargets/extended/{negativeTargetId} |
|
sponsored-display:getNegativeTargets |
GET | /sd/negativeTargets/{negativeTargetId} |
|
sponsored-display:archiveNegativeTargetingClause |
DELETE | /sd/negativeTargets/{negativeTargetId} |
|
sponsored-display:listOptimizationRules |
GET | /sd/optimizationRules |
|
sponsored-display:updateOptimizationRules |
PUT | /sd/optimizationRules |
|
sponsored-display:createOptimizationRules |
POST | /sd/optimizationRules |
|
sponsored-display:get__sd_optimizationRules_{optimizationRuleId} |
GET | /sd/optimizationRules/{optimizationRuleId} |
|
sponsored-display:listProductAds |
GET | /sd/productAds |
|
sponsored-display:updateProductAds |
PUT | /sd/productAds |
|
sponsored-display:createProductAds |
POST | /sd/productAds |
|
sponsored-display:listProductAdsEx |
GET | /sd/productAds/extended |
|
sponsored-display:getProductAdResponseEx |
GET | /sd/productAds/extended/{adId} |
|
sponsored-display:getProductAd |
GET | /sd/productAds/{adId} |
|
sponsored-display:archiveProductAd |
DELETE | /sd/productAds/{adId} |
|
sponsored-display:getHeadlineRecommendationsForSD |
POST | /sd/recommendations/creative/headline |
|
sponsored-display:getSnapshot (deprecated) |
GET | /sd/snapshots/{snapshotId} |
|
sponsored-display:downloadSnapshot (deprecated) |
GET | /sd/snapshots/{snapshotId}/download |
|
sponsored-display:listTargetingClauses |
GET | /sd/targets |
|
sponsored-display:updateTargetingClauses |
PUT | /sd/targets |
|
sponsored-display:createTargetingClauses |
POST | /sd/targets |
|
sponsored-display:getTargetBidRecommendations |
POST | /sd/targets/bid/recommendations |
|
sponsored-display:listTargetingClausesEx |
GET | /sd/targets/extended |
|
sponsored-display:getTargetsEx |
GET | /sd/targets/extended/{targetId} |
|
sponsored-display:getTargetRecommendations |
POST | /sd/targets/recommendations |
|
sponsored-display:getTargets |
GET | /sd/targets/{targetId} |
|
sponsored-display:archiveTargetingClause |
DELETE | /sd/targets/{targetId} |
|
sponsored-display:requestReport (deprecated) |
POST | /sd/{recordType}/report |
|
sponsored-display:createSnapshot (deprecated) |
POST | /sd/{recordType}/snapshot |
|
sponsored-display:getReportStatus |
GET | /v2/reports/{reportId} |
|
sponsored-display:downloadReport |
GET | /v2/reports/{reportId}/download |
sponsored-products¶
Sponsored Products, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-products:UpdateSponsoredProductsAdGroups |
PUT | /sp/adGroups |
typed |
sponsored-products:CreateSponsoredProductsAdGroups |
POST | /sp/adGroups |
typed |
sponsored-products:DeleteSponsoredProductsAdGroups |
POST | /sp/adGroups/delete |
typed |
sponsored-products:ListSponsoredProductsAdGroups |
POST | /sp/adGroups/list |
typed |
sponsored-products:GetSPBudgetRulesForAdvertiser |
GET | /sp/budgetRules |
|
sponsored-products:UpdateBudgetRulesForSPCampaigns |
PUT | /sp/budgetRules |
|
sponsored-products:CreateBudgetRulesForSPCampaigns |
POST | /sp/budgetRules |
|
sponsored-products:GetBudgetRuleByRuleIdForSPCampaigns |
GET | /sp/budgetRules/{budgetRuleId} |
|
sponsored-products:GetCampaignsAssociatedWithSPBudgetRule |
GET | /sp/budgetRules/{budgetRuleId}/campaigns |
|
sponsored-products:BulkBudgetRulesAssociationForSP |
POST | /sp/budgetRulesAssociation |
|
sponsored-products:BulkBudgetRulesDisAssociationForSP |
POST | /sp/budgetRulesAssociation/delete |
|
sponsored-products:getCampaignRecommendations |
GET | /sp/campaign/recommendations |
|
sponsored-products:fetchCampaignRecommendations |
POST | /sp/campaign/recommendations |
|
sponsored-products:UpdateSponsoredProductsCampaignNegativeKeywords |
PUT | /sp/campaignNegativeKeywords |
typed |
sponsored-products:CreateSponsoredProductsCampaignNegativeKeywords |
POST | /sp/campaignNegativeKeywords |
typed |
sponsored-products:DeleteSponsoredProductsCampaignNegativeKeywords |
POST | /sp/campaignNegativeKeywords/delete |
typed |
sponsored-products:ListSponsoredProductsCampaignNegativeKeywords |
POST | /sp/campaignNegativeKeywords/list |
typed |
sponsored-products:UpdateSponsoredProductsCampaignNegativeTargetingClauses |
PUT | /sp/campaignNegativeTargets |
typed |
sponsored-products:CreateSponsoredProductsCampaignNegativeTargetingClauses |
POST | /sp/campaignNegativeTargets |
typed |
sponsored-products:DeleteSponsoredProductsCampaignNegativeTargetingClauses |
POST | /sp/campaignNegativeTargets/delete |
typed |
sponsored-products:ListSponsoredProductsCampaignNegativeTargetingClauses |
POST | /sp/campaignNegativeTargets/list |
typed |
sponsored-products:UpdateSponsoredProductsCampaigns |
PUT | /sp/campaigns |
typed |
sponsored-products:CreateSponsoredProductsCampaigns |
POST | /sp/campaigns |
typed |
sponsored-products:spCampaignsBudgetUsage |
POST | /sp/campaigns/budget/usage |
typed |
sponsored-products:getBudgetRecommendations |
POST | /sp/campaigns/budgetRecommendations |
typed |
sponsored-products:SPGetBudgetRulesRecommendation |
POST | /sp/campaigns/budgetRules/recommendations |
typed |
sponsored-products:DeleteSponsoredProductsCampaigns |
POST | /sp/campaigns/delete |
typed |
sponsored-products:getBudgetRecommendation |
POST | /sp/campaigns/initialBudgetRecommendation |
typed |
sponsored-products:ListSponsoredProductsCampaigns |
POST | /sp/campaigns/list |
typed |
sponsored-products:ListAssociatedBudgetRulesForSPCampaigns |
GET | /sp/campaigns/{campaignId}/budgetRules |
typed |
sponsored-products:CreateAssociatedBudgetRulesForSPCampaigns |
POST | /sp/campaigns/{campaignId}/budgetRules |
typed |
sponsored-products:DisassociateAssociatedBudgetRuleForSPCampaigns |
DELETE | /sp/campaigns/{campaignId}/budgetRules/{budgetRuleId} |
typed |
sponsored-products:AssociateOptimizationRulesToCampaign |
POST | /sp/campaigns/{campaignId}/optimizationRules |
typed |
sponsored-products:GetMultiCountryThemeBasedBidRecommendationForAdGroup_v1 |
POST | /sp/global/targets/bid/recommendations |
|
sponsored-products:getGlobalRankedKeywordRecommendation |
POST | /sp/global/targets/keywords/recommendations/list |
|
sponsored-products:UpdateSponsoredProductsKeywords |
PUT | /sp/keywords |
typed |
sponsored-products:CreateSponsoredProductsKeywords |
POST | /sp/keywords |
typed |
sponsored-products:DeleteSponsoredProductsKeywords |
POST | /sp/keywords/delete |
typed |
sponsored-products:ListSponsoredProductsKeywords |
POST | /sp/keywords/list |
typed |
sponsored-products:UpdateSponsoredProductsNegativeKeywords |
PUT | /sp/negativeKeywords |
typed |
sponsored-products:CreateSponsoredProductsNegativeKeywords |
POST | /sp/negativeKeywords |
typed |
sponsored-products:DeleteSponsoredProductsNegativeKeywords |
POST | /sp/negativeKeywords/delete |
typed |
sponsored-products:ListSponsoredProductsNegativeKeywords |
POST | /sp/negativeKeywords/list |
typed |
sponsored-products:UpdateSponsoredProductsNegativeTargetingClauses |
PUT | /sp/negativeTargets |
typed |
sponsored-products:CreateSponsoredProductsNegativeTargetingClauses |
POST | /sp/negativeTargets |
typed |
sponsored-products:getNegativeBrands |
GET | /sp/negativeTargets/brands/recommendations |
typed |
sponsored-products:searchBrands |
POST | /sp/negativeTargets/brands/search |
typed |
sponsored-products:DeleteSponsoredProductsNegativeTargetingClauses |
POST | /sp/negativeTargets/delete |
typed |
sponsored-products:ListSponsoredProductsNegativeTargetingClauses |
POST | /sp/negativeTargets/list |
typed |
sponsored-products:UpdateSponsoredProductsProductAds |
PUT | /sp/productAds |
typed |
sponsored-products:CreateSponsoredProductsProductAds |
POST | /sp/productAds |
typed |
sponsored-products:DeleteSponsoredProductsProductAds |
POST | /sp/productAds/delete |
typed |
sponsored-products:ListSponsoredProductsProductAds |
POST | /sp/productAds/list |
typed |
sponsored-products:UpdateOptimizationRule |
PUT | /sp/rules/campaignOptimization |
|
sponsored-products:CreateOptimizationRule |
POST | /sp/rules/campaignOptimization |
|
sponsored-products:GetOptimizationRuleEligibility |
POST | /sp/rules/campaignOptimization/eligibility |
|
sponsored-products:GetRuleNotification |
POST | /sp/rules/campaignOptimization/state |
|
sponsored-products:GetCampaignOptimizationRule |
GET | /sp/rules/campaignOptimization/{campaignOptimizationId} |
|
sponsored-products:DeleteCampaignOptimizationRule |
DELETE | /sp/rules/campaignOptimization/{campaignOptimizationId} |
|
sponsored-products:UpdateOptimizationRules |
PUT | /sp/rules/optimization |
|
sponsored-products:CreateOptimizationRules |
POST | /sp/rules/optimization |
|
sponsored-products:SearchOptimizationRules |
POST | /sp/rules/optimization/search |
|
sponsored-products:CreateTargetPromotionGroups |
POST | /sp/targetPromotionGroups |
|
sponsored-products:ListTargetPromotionGroups |
POST | /sp/targetPromotionGroups/list |
|
sponsored-products:GetTargetPromotionGroupsRecommendations |
POST | /sp/targetPromotionGroups/recommendations |
|
sponsored-products:CreateTargetPromotionGroupTargets |
POST | /sp/targetPromotionGroups/targets |
|
sponsored-products:ListTargetPromotionGroupTargets |
POST | /sp/targetPromotionGroups/targets/list |
|
sponsored-products:getKeywordGroupRecommendations |
POST | /sp/targeting/recommendations/keywordGroups |
|
sponsored-products:UpdateSponsoredProductsTargetingClauses |
PUT | /sp/targets |
typed |
sponsored-products:CreateSponsoredProductsTargetingClauses |
POST | /sp/targets |
typed |
sponsored-products:GetThemeBasedBidRecommendationForAdGroup_v1 |
POST | /sp/targets/bid/recommendations |
typed |
sponsored-products:getTargetableCategories |
GET | /sp/targets/categories |
typed |
sponsored-products:getCategoryRecommendationsForASINs |
POST | /sp/targets/categories/recommendations |
typed |
sponsored-products:getRefinementsForCategory |
GET | /sp/targets/category/{categoryId}/refinements |
typed |
sponsored-products:DeleteSponsoredProductsTargetingClauses |
POST | /sp/targets/delete |
typed |
sponsored-products:getRankedKeywordRecommendation |
POST | /sp/targets/keywords/recommendations |
typed |
sponsored-products:ListSponsoredProductsTargetingClauses |
POST | /sp/targets/list |
typed |
sponsored-products:getTargetableASINCounts |
POST | /sp/targets/products/count |
typed |
sponsored-products:getProductRecommendations |
POST | /sp/targets/products/recommendations |
typed |
sponsored-products:SPGetAllRuleEvents |
POST | /sp/v1/events |
sponsored-products-v2¶
DEPRECATED - Amazon Ads API - Sponsored Products, version 2.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-products-v2:getAdGroupBidRecommendations (deprecated) |
GET | /v2/sp/adGroups/{adGroupId}/bidRecommendations |
|
sponsored-products-v2:getAdGroupSuggestedKeywords (deprecated) |
GET | /v2/sp/adGroups/{adGroupId}/suggested/keywords |
|
sponsored-products-v2:getAdGroupSuggestedKeywordsEx (deprecated) |
GET | /v2/sp/adGroups/{adGroupId}/suggested/keywords/extended |
|
sponsored-products-v2:bulkGetAsinSuggestedKeywords (deprecated) |
POST | /v2/sp/asins/suggested/keywords |
|
sponsored-products-v2:getAsinSuggestedKeywords (deprecated) |
GET | /v2/sp/asins/{asinValue}/suggested/keywords |
|
sponsored-products-v2:createKeywordBidRecommendations (deprecated) |
POST | /v2/sp/keywords/bidRecommendations |
|
sponsored-products-v2:getKeywordBidRecommendations (deprecated) |
GET | /v2/sp/keywords/{keywordId}/bidRecommendations |
|
sponsored-products-v2:getSnapshotStatus (deprecated) |
GET | /v2/sp/snapshots/{snapshotId} |
|
sponsored-products-v2:downloadSnapshot (deprecated) |
GET | /v2/sp/snapshots/{snapshotId}/download |
|
sponsored-products-v2:getBidRecommendations (deprecated) |
POST | /v2/sp/targets/bidRecommendations |
|
sponsored-products-v2:requestSnapshot (deprecated) |
POST | /v2/sp/{recordType}/snapshot |
sponsored-tv¶
Sponsored TV, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
sponsored-tv:UpdateSponsoredTvAdGroups |
PUT | /st/adGroups |
|
sponsored-tv:CreateSponsoredTvAdGroups |
POST | /st/adGroups |
|
sponsored-tv:DeleteSponsoredTvAdGroups |
POST | /st/adGroups/delete |
|
sponsored-tv:ListSponsoredTvAdGroups |
POST | /st/adGroups/list |
|
sponsored-tv:UpdateSponsoredTvAds |
PUT | /st/ads |
|
sponsored-tv:CreateSponsoredTvAds |
POST | /st/ads |
|
sponsored-tv:DeleteSponsoredTvAds |
POST | /st/ads/delete |
|
sponsored-tv:ListSponsoredTvAds |
POST | /st/ads/list |
|
sponsored-tv:UpdateSponsoredTvCampaigns |
PUT | /st/campaigns |
|
sponsored-tv:CreateSponsoredTvCampaigns |
POST | /st/campaigns |
|
sponsored-tv:DeleteSponsoredTvCampaigns |
POST | /st/campaigns/delete |
|
sponsored-tv:ListSponsoredTvCampaigns |
POST | /st/campaigns/list |
|
sponsored-tv:UpdateSponsoredTvCreatives |
PUT | /st/creatives |
|
sponsored-tv:CreateSponsoredTvCreatives |
POST | /st/creatives |
|
sponsored-tv:ListSponsoredTvCreatives |
POST | /st/creatives/list |
|
sponsored-tv:ListSponsoredTvCreativesModerations |
POST | /st/creatives/moderations/list |
|
sponsored-tv:ListSponsoredTvCreativesModerationsPolicyViolations |
POST | /st/creatives/moderations/policyViolations/list |
|
sponsored-tv:PreviewSponsoredTvCreative |
POST | /st/creatives/preview |
|
sponsored-tv:SponsoredTvForecasts |
POST | /st/forecasts |
|
sponsored-tv:CreateSponsoredTvLocations |
POST | /st/locations |
|
sponsored-tv:DeleteSponsoredTvLocations |
POST | /st/locations/delete |
|
sponsored-tv:ListSponsoredTvLocations |
POST | /st/locations/list |
|
sponsored-tv:UpdateSponsoredTvTargetingClauses |
PUT | /st/targets |
|
sponsored-tv:CreateSponsoredTvTargetingClauses |
POST | /st/targets |
|
sponsored-tv:DeleteSponsoredTvTargetingClauses |
POST | /st/targets/delete |
|
sponsored-tv:ListSponsoredTvTargetingClauses |
POST | /st/targets/list |
stores¶
Stores, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
stores:getAsinEngagementForStore |
POST | /stores/{brandEntityId}/asinMetrics |
|
stores:getInsightsForStoreAPI |
POST | /stores/{brandEntityId}/insights |
targetable-entities¶
Targetable Entities, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
targetable-entities:ListTargetableEntities |
POST | /targetableEntities/list |
|
targetable-entities:ListTargetableEntityPaths |
POST | /targetableEntities/paths/list |
v1-all-account-combination-invitations¶
AccountCombinationInvitations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-account-combination-invitations:CreateAccountCombinationInvitation |
POST | /adsApi/v1/create/accountCombinationInvitations |
|
v1-all-account-combination-invitations:QueryAccountCombinationInvitation |
POST | /adsApi/v1/query/accountCombinationInvitations |
|
v1-all-account-combination-invitations:UpdateAccountCombinationInvitation |
POST | /adsApi/v1/update/accountCombinationInvitations |
v1-all-account-link-invites¶
AccountLinkInvites API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-account-link-invites:CreateAccountLinkInvite |
POST | /adsApi/v1/create/accountLinkInvites |
|
v1-all-account-link-invites:DeleteAccountLinkInvite |
POST | /adsApi/v1/delete/accountLinkInvites |
|
v1-all-account-link-invites:QueryAccountLinkInvite |
POST | /adsApi/v1/query/accountLinkInvites |
|
v1-all-account-link-invites:UpdateAccountLinkInvite |
POST | /adsApi/v1/update/accountLinkInvites |
v1-all-account-links¶
AccountLinks API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-account-links:DeleteAccountLink |
POST | /adsApi/v1/delete/accountLinks |
|
v1-all-account-links:QueryAccountLink |
POST | /adsApi/v1/query/accountLinks |
|
v1-all-account-links:UpdateAccountLink |
POST | /adsApi/v1/update/accountLinks |
v1-all-ad-associations¶
AdAssociations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-ad-associations:CreateAdAssociation |
POST | /adsApi/v1/create/adAssociations |
|
v1-all-ad-associations:DeleteAdAssociation |
POST | /adsApi/v1/delete/adAssociations |
|
v1-all-ad-associations:QueryAdAssociation |
POST | /adsApi/v1/query/adAssociations |
|
v1-all-ad-associations:UpdateAdAssociation |
POST | /adsApi/v1/update/adAssociations |
v1-all-ad-extensions¶
AdExtensions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-ad-extensions:CreateAdExtension |
POST | /adsApi/v1/create/adExtensions |
|
v1-all-ad-extensions:QueryAdExtension |
POST | /adsApi/v1/query/adExtensions |
|
v1-all-ad-extensions:UpdateAdExtension |
POST | /adsApi/v1/update/adExtensions |
v1-all-ad-groups¶
AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-ad-groups:CreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-all-ad-groups:DeleteAdGroup |
POST | /adsApi/v1/delete/adGroups |
|
v1-all-ad-groups:QueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-all-ad-groups:UpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-all-ads¶
Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-ads:CreateAd |
POST | /adsApi/v1/create/ads |
|
v1-all-ads:DeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-all-ads:QueryAd |
POST | /adsApi/v1/query/ads |
|
v1-all-ads:UpdateAd |
POST | /adsApi/v1/update/ads |
v1-all-advertiser-accounts¶
AdvertiserAccounts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-advertiser-accounts:CreateAdvertiserAccount |
POST | /adsApi/v1/create/advertiserAccounts |
|
v1-all-advertiser-accounts:QueryAdvertiserAccount |
POST | /adsApi/v1/query/advertiserAccounts |
|
v1-all-advertiser-accounts:UpdateAdvertiserAccount |
POST | /adsApi/v1/update/advertiserAccounts |
v1-all-advertiser-product-group-eligibilities¶
AdvertiserProductGroupEligibilities API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-advertiser-product-group-eligibilities:CreateAdvertiserProductGroupEligibility |
POST | /adsApi/v1/create/advertiserProductGroupEligibilities |
|
v1-all-advertiser-product-group-eligibilities:QueryAdvertiserProductGroupEligibility |
POST | /adsApi/v1/query/advertiserProductGroupEligibilities |
v1-all-advertising-deal-targets¶
AdvertisingDealTargets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-advertising-deal-targets:SBCreateAdvertisingDealTarget |
POST | /adsApi/v1/create/advertisingDealTargets/sb |
|
v1-all-advertising-deal-targets:SBDeleteAdvertisingDealTarget |
POST | /adsApi/v1/delete/advertisingDealTargets/sb |
|
v1-all-advertising-deal-targets:SBQueryAdvertisingDealTarget |
POST | /adsApi/v1/query/advertisingDealTargets/sb |
v1-all-advertising-deals¶
AdvertisingDeals API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-advertising-deals:CreateAdvertisingDeal |
POST | /adsApi/v1/create/advertisingDeals |
|
v1-all-advertising-deals:SBCreateAdvertisingDeal |
POST | /adsApi/v1/create/advertisingDeals/sb |
|
v1-all-advertising-deals:SBDeleteAdvertisingDeal |
POST | /adsApi/v1/delete/advertisingDeals/sb |
|
v1-all-advertising-deals:QueryAdvertisingDeal |
POST | /adsApi/v1/query/advertisingDeals |
|
v1-all-advertising-deals:SBQueryAdvertisingDeal |
POST | /adsApi/v1/query/advertisingDeals/sb |
|
v1-all-advertising-deals:UpdateAdvertisingDeal |
POST | /adsApi/v1/update/advertisingDeals |
|
v1-all-advertising-deals:SBUpdateAdvertisingDeal |
POST | /adsApi/v1/update/advertisingDeals/sb |
v1-all-brand-store-edition-publish-versions¶
BrandStoreEditionPublishVersions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-brand-store-edition-publish-versions:QueryBrandStoreEditionPublishVersion |
POST | /adsApi/v1/query/brandStoreEditionPublishVersions |
|
v1-all-brand-store-edition-publish-versions:UpdateBrandStoreEditionPublishVersion |
POST | /adsApi/v1/update/brandStoreEditionPublishVersions |
v1-all-brand-store-editions¶
BrandStoreEditions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-brand-store-editions:ListBrandStoreEdition |
GET | /adsApi/v1/brandStoreEditions |
v1-all-brand-store-pages¶
BrandStorePages API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-brand-store-pages:QueryBrandStorePage |
POST | /adsApi/v1/query/brandStorePages |
v1-all-brand-store-pages-2¶
BrandStorePages API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-brand-store-pages-2:UpdateBrandStorePage |
POST | /adsApi/v1/update/brandStorePages |
v1-all-brand-stores¶
BrandStores API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-brand-stores:QueryBrandStore |
POST | /adsApi/v1/query/brandStores |
v1-all-branded-keywords-pricings¶
BrandedKeywordsPricings API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-branded-keywords-pricings:SBCreateBrandedKeywordsPricing |
POST | /adsApi/v1/create/brandedKeywordsPricings/sb |
v1-all-buyer-seats¶
BuyerSeats API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-buyer-seats:ListBuyerSeat |
GET | /adsApi/v1/buyerSeats |
|
v1-all-buyer-seats:CreateBuyerSeat |
POST | /adsApi/v1/create/buyerSeats |
v1-all-campaign-forecasts¶
CampaignForecasts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-campaign-forecasts:DSPRetrieveCampaignForecast |
POST | /adsApi/v1/retrieve/campaignForecasts/dsp |
v1-all-campaigns¶
Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-campaigns:CreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-all-campaigns:DeleteCampaign |
POST | /adsApi/v1/delete/campaigns |
|
v1-all-campaigns:QueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-all-campaigns:UpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-all-commitment-spends¶
CommitmentSpends API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-commitment-spends:RetrieveCommitmentSpend |
POST | /adsApi/v1/retrieve/commitmentSpends |
v1-all-commitments¶
Commitments API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-commitments:ListCommitment |
GET | /adsApi/v1/commitments |
|
v1-all-commitments:CreateCommitment |
POST | /adsApi/v1/create/commitments |
|
v1-all-commitments:QueryCommitment |
POST | /adsApi/v1/query/commitments |
|
v1-all-commitments:RetrieveCommitment |
POST | /adsApi/v1/retrieve/commitments |
|
v1-all-commitments:UpdateCommitment |
POST | /adsApi/v1/update/commitments |
v1-all-communication-contacts¶
CommunicationContacts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-communication-contacts:CreateCommunicationContact |
POST | /adsApi/v1/create/communicationContacts |
|
v1-all-communication-contacts:QueryCommunicationContact |
POST | /adsApi/v1/query/communicationContacts |
v1-all-communication-preferences¶
CommunicationPreferences API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-communication-preferences:QueryCommunicationPreference |
POST | /adsApi/v1/query/communicationPreferences |
|
v1-all-communication-preferences:UpdateCommunicationPreference |
POST | /adsApi/v1/update/communicationPreferences |
v1-all-deal-advertiser-access-entries¶
DealAdvertiserAccessEntries API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-advertiser-access-entries:CreateDealAdvertiserAccessEntry |
POST | /adsApi/v1/create/dealAdvertiserAccessEntries |
|
v1-all-deal-advertiser-access-entries:DeleteDealAdvertiserAccessEntry |
POST | /adsApi/v1/delete/dealAdvertiserAccessEntries |
|
v1-all-deal-advertiser-access-entries:QueryDealAdvertiserAccessEntry |
POST | /adsApi/v1/query/dealAdvertiserAccessEntries |
v1-all-deal-advertiser-accesses¶
DealAdvertiserAccesses API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-advertiser-accesses:CreateDealAdvertiserAccess |
POST | /adsApi/v1/create/dealAdvertiserAccesses |
|
v1-all-deal-advertiser-accesses:DeleteDealAdvertiserAccess |
POST | /adsApi/v1/delete/dealAdvertiserAccesses |
|
v1-all-deal-advertiser-accesses:RetrieveDealAdvertiserAccess |
POST | /adsApi/v1/retrieve/dealAdvertiserAccesses |
v1-all-deal-availses¶
DealAvailses API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-availses:QueryDealAvails |
POST | /adsApi/v1/query/dealAvailses |
v1-all-deal-performances¶
DealPerformances API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-performances:ListDealPerformance |
GET | /adsApi/v1/dealPerformances |
v1-all-deal-planning-metricses¶
DealPlanningMetricses API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-planning-metricses:QueryDealPlanningMetrics |
POST | /adsApi/v1/query/dealPlanningMetricses |
v1-all-deal-preferences¶
DealPreferences API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-deal-preferences:CreateDealPreference |
POST | /adsApi/v1/create/dealPreferences |
|
v1-all-deal-preferences:ListDealPreference |
GET | /adsApi/v1/dealPreferences |
v1-all-events¶
Events API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-events:CreateEvent |
POST | /adsApi/v1/create/events |
v1-all-geo-locations¶
GeoLocations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-geo-locations:CreateGeoLocation |
POST | /adsApi/v1/create/geoLocations |
v1-all-inventory-groups¶
InventoryGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-inventory-groups:AdsApiv1CreateInventoryGroup |
POST | /adsApi/v1/create/inventoryGroups |
|
v1-all-inventory-groups:AdsApiv1QueryInventoryGroup |
POST | /adsApi/v1/query/inventoryGroups |
|
v1-all-inventory-groups:AdsApiv1UpdateInventoryGroup |
POST | /adsApi/v1/update/inventoryGroups |
v1-all-keyword-reservation-validations¶
KeywordReservationValidations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-keyword-reservation-validations:SBCreateKeywordReservationValidation |
POST | /adsApi/v1/create/keywordReservationValidations/sb |
v1-all-label-object-associations¶
LabelObjectAssociations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-label-object-associations:QueryLabelObjectAssociation |
POST | /adsApi/v1/query/labelObjectAssociations |
v1-all-labels¶
Labels API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-labels:QueryLabel |
POST | /adsApi/v1/query/labels |
v1-all-linear-tv-dayparts¶
LinearTvDayparts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-linear-tv-dayparts:QueryLinearTvDaypart |
POST | /adsApi/v1/query/linearTvDayparts |
v1-all-linear-tv-incremental-reach-forecasts¶
LinearTvIncrementalReachForecasts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-linear-tv-incremental-reach-forecasts:CreateLinearTvIncrementalReachForecast |
POST | /adsApi/v1/create/linearTvIncrementalReachForecasts |
v1-all-linear-tv-reach-forecasts¶
LinearTvReachForecasts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-linear-tv-reach-forecasts:CreateLinearTvReachForecast |
POST | /adsApi/v1/create/linearTvReachForecasts |
v1-all-location-indexes¶
LocationIndexes API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-location-indexes:CreateLocationIndex |
POST | /adsApi/v1/create/locationIndexes |
|
v1-all-location-indexes:ListLocationIndex |
GET | /adsApi/v1/locationIndexes |
|
v1-all-location-indexes:RetrieveLocationIndex |
POST | /adsApi/v1/retrieve/locationIndexes |
|
v1-all-location-indexes:UpdateLocationIndex |
POST | /adsApi/v1/update/locationIndexes |
v1-all-manager-accounts¶
ManagerAccounts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-manager-accounts:CreateManagerAccount |
POST | /adsApi/v1/create/managerAccounts |
|
v1-all-manager-accounts:QueryManagerAccount |
POST | /adsApi/v1/query/managerAccounts |
|
v1-all-manager-accounts:UpdateManagerAccount |
POST | /adsApi/v1/update/managerAccounts |
v1-all-promotion-code-redemptions¶
PromotionCodeRedemptions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-promotion-code-redemptions:CreatePromotionCodeRedemption |
POST | /adsApi/v1/create/promotionCodeRedemptions |
v1-all-promotion-offers¶
PromotionOffers API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-promotion-offers:QueryPromotionOffer |
POST | /adsApi/v1/query/promotionOffers |
v1-all-promotion-rewards¶
PromotionRewards API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-promotion-rewards:QueryPromotionReward |
POST | /adsApi/v1/query/promotionRewards |
v1-all-publishers¶
Publishers API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-publishers:QueryPublisher |
POST | /adsApi/v1/query/publishers |
v1-all-recommendation-types¶
RecommendationTypes API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-recommendation-types:SBQueryRecommendationType |
POST | /adsApi/v1/query/recommendationTypes/sb |
v1-all-recommendations¶
Recommendations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-recommendations:SBCreateRecommendation |
POST | /adsApi/v1/create/recommendations/sb |
|
v1-all-recommendations:QueryRecommendation |
POST | /adsApi/v1/query/recommendations |
|
v1-all-recommendations:ListRecommendation |
GET | /adsApi/v1/recommendations |
v1-all-reports¶
Reports API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-reports:AdsApiv1CreateReport |
POST | /adsApi/v1/create/reports |
|
v1-all-reports:AdsApiv1DeleteReport |
POST | /adsApi/v1/delete/reports |
|
v1-all-reports:AdsApiv1RetrieveReport |
POST | /adsApi/v1/retrieve/reports |
v1-all-reserved-target-pricings¶
ReservedTargetPricings API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-reserved-target-pricings:SBAdsApiv1CreateReservedTargetPricing |
POST | /adsApi/v1/create/reservedTargetPricings/sb |
v1-all-sellers¶
Sellers API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-sellers:QuerySeller |
POST | /adsApi/v1/query/sellers |
v1-all-selling-accounts¶
SellingAccounts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-selling-accounts:QuerySellingAccount |
POST | /adsApi/v1/query/sellingAccounts |
v1-all-stream-subscriptions¶
StreamSubscriptions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-stream-subscriptions:AdsApiv1CreateStreamSubscription |
POST | /adsApi/v1/create/streamSubscriptions |
|
v1-all-stream-subscriptions:AdsApiv1DeleteStreamSubscription |
POST | /adsApi/v1/delete/streamSubscriptions |
|
v1-all-stream-subscriptions:AdsApiv1QueryStreamSubscription |
POST | /adsApi/v1/query/streamSubscriptions |
|
v1-all-stream-subscriptions:AdsApiv1RetrieveStreamSubscription |
POST | /adsApi/v1/retrieve/streamSubscriptions |
v1-all-supplier-ad-product-prices¶
SupplierAdProductPrices API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-ad-product-prices:CreateSupplierAdProductPrice |
POST | /adsApi/v1/create/supplierAdProductPrices |
v1-all-supplier-ad-products¶
SupplierAdProducts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-ad-products:QuerySupplierAdProduct |
POST | /adsApi/v1/query/supplierAdProducts |
v1-all-supplier-proposal-destinations¶
SupplierProposalDestinations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposal-destinations:QuerySupplierProposalDestination |
POST | /adsApi/v1/query/supplierProposalDestinations |
v1-all-supplier-proposals¶
SupplierProposals API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposals:CreateSupplierProposal |
POST | /adsApi/v1/create/supplierProposals |
|
v1-all-supplier-proposals:QuerySupplierProposal |
POST | /adsApi/v1/query/supplierProposals |
|
v1-all-supplier-proposals:UpdateSupplierProposal |
POST | /adsApi/v1/update/supplierProposals |
v1-all-supplier-proposed-deal-forecasts¶
SupplierProposedDealForecasts API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposed-deal-forecasts:CreateSupplierProposedDealForecast |
POST | /adsApi/v1/create/supplierProposedDealForecasts |
v1-all-supplier-proposed-deal-historical-versions¶
SupplierProposedDealHistoricalVersions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposed-deal-historical-versions:QuerySupplierProposedDealHistoricalVersion |
POST | /adsApi/v1/query/supplierProposedDealHistoricalVersions |
v1-all-supplier-proposed-deal-revisions¶
SupplierProposedDealRevisions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposed-deal-revisions:CreateSupplierProposedDealRevision |
POST | /adsApi/v1/create/supplierProposedDealRevisions |
|
v1-all-supplier-proposed-deal-revisions:UpdateSupplierProposedDealRevision |
POST | /adsApi/v1/update/supplierProposedDealRevisions |
v1-all-supplier-proposed-deals¶
SupplierProposedDeals API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-proposed-deals:CreateSupplierProposedDeal |
POST | /adsApi/v1/create/supplierProposedDeals |
|
v1-all-supplier-proposed-deals:QuerySupplierProposedDeal |
POST | /adsApi/v1/query/supplierProposedDeals |
|
v1-all-supplier-proposed-deals:UpdateSupplierProposedDeal |
POST | /adsApi/v1/update/supplierProposedDeals |
v1-all-supplier-publishers¶
SupplierPublishers API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-publishers:QuerySupplierPublisher |
POST | /adsApi/v1/query/supplierPublishers |
v1-all-supplier-target-items¶
SupplierTargetItems API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-supplier-target-items:QuerySupplierTargetItem |
POST | /adsApi/v1/query/supplierTargetItems |
v1-all-suppliers¶
Suppliers API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-suppliers:QuerySupplier |
POST | /adsApi/v1/query/suppliers |
v1-all-targets¶
Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-all-targets:CreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-all-targets:DeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-all-targets:QueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-all-targets:UpdateTarget |
POST | /adsApi/v1/update/targets |
v1-dsp-ad-groups¶
DSP AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-dsp-ad-groups:DSPCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-dsp-ad-groups:DSPQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-dsp-ad-groups:DSPUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-dsp-ads¶
DSP Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-dsp-ads:DSPCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-dsp-ads:DSPQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-dsp-ads:DSPUpdateAd |
POST | /adsApi/v1/update/ads |
v1-dsp-advertising-deals¶
DSP AdvertisingDeals API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-dsp-advertising-deals:DSPCreateAdvertisingDeal |
POST | /adsApi/v1/create/advertisingDeals |
|
v1-dsp-advertising-deals:DSPQueryAdvertisingDeal |
POST | /adsApi/v1/query/advertisingDeals |
|
v1-dsp-advertising-deals:DSPUpdateAdvertisingDeal |
POST | /adsApi/v1/update/advertisingDeals |
v1-dsp-campaigns¶
DSP Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-dsp-campaigns:DSPCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-dsp-campaigns:DSPQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-dsp-campaigns:DSPUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-dsp-targets¶
DSP Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-dsp-targets:DSPCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-dsp-targets:DSPDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-dsp-targets:DSPQueryTarget |
POST | /adsApi/v1/query/targets |
v1-exports¶
Amazon Ads API Exports, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-exports:AdGroupExport |
POST | /adGroups/export |
|
v1-exports:AdExport |
POST | /ads/export |
|
v1-exports:CampaignExport |
POST | /campaigns/export |
|
v1-exports:GetExport |
GET | /exports/{exportId} |
|
v1-exports:TargetExport |
POST | /targets/export |
v1-sb-ad-extensions¶
SB AdExtensions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-ad-extensions:SBCreateAdExtension |
POST | /adsApi/v1/create/adExtensions |
|
v1-sb-ad-extensions:SBQueryAdExtension |
POST | /adsApi/v1/query/adExtensions |
|
v1-sb-ad-extensions:SBUpdateAdExtension |
POST | /adsApi/v1/update/adExtensions |
v1-sb-ad-groups¶
SB AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-ad-groups:SBCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-sb-ad-groups:SBDeleteAdGroup |
POST | /adsApi/v1/delete/adGroups |
|
v1-sb-ad-groups:SBQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-sb-ad-groups:SBUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-sb-ads¶
SB Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-ads:SBCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-sb-ads:SBDeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-sb-ads:SBQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-sb-ads:SBUpdateAd |
POST | /adsApi/v1/update/ads |
v1-sb-advertising-deals¶
SB AdvertisingDeals API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-advertising-deals:SBCreateAdvertisingDeal |
POST | /adsApi/v1/create/advertisingDeals/sb |
|
v1-sb-advertising-deals:SBDeleteAdvertisingDeal |
POST | /adsApi/v1/delete/advertisingDeals/sb |
|
v1-sb-advertising-deals:SBQueryAdvertisingDeal |
POST | /adsApi/v1/query/advertisingDeals/sb |
|
v1-sb-advertising-deals:SBUpdateAdvertisingDeal |
POST | /adsApi/v1/update/advertisingDeals/sb |
v1-sb-campaigns¶
SB Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-campaigns:SBCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-sb-campaigns:SBDeleteCampaign |
POST | /adsApi/v1/delete/campaigns |
|
v1-sb-campaigns:SBQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-sb-campaigns:SBUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-sb-recommendations¶
SB Recommendations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-recommendations:SBCreateRecommendation |
POST | /adsApi/v1/create/recommendations/sb |
v1-sb-targets¶
SB Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sb-targets:SBCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-sb-targets:SBDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-sb-targets:SBQueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-sb-targets:SBUpdateTarget |
POST | /adsApi/v1/update/targets |
v1-sd-ad-groups¶
SD AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sd-ad-groups:SDCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-sd-ad-groups:SDDeleteAdGroup |
POST | /adsApi/v1/delete/adGroups |
|
v1-sd-ad-groups:SDQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-sd-ad-groups:SDUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-sd-ads¶
SD Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sd-ads:SDCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-sd-ads:SDDeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-sd-ads:SDQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-sd-ads:SDUpdateAd |
POST | /adsApi/v1/update/ads |
v1-sd-campaigns¶
SD Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sd-campaigns:SDCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-sd-campaigns:SDDeleteCampaign |
POST | /adsApi/v1/delete/campaigns |
|
v1-sd-campaigns:SDQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-sd-campaigns:SDUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-sd-targets¶
SD Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sd-targets:SDCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-sd-targets:SDDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-sd-targets:SDQueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-sd-targets:SDUpdateTarget |
POST | /adsApi/v1/update/targets |
v1-sp-ad-extensions¶
SP AdExtensions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sp-ad-extensions:SPCreateAdExtension |
POST | /adsApi/v1/create/adExtensions |
|
v1-sp-ad-extensions:SPQueryAdExtension |
POST | /adsApi/v1/query/adExtensions |
|
v1-sp-ad-extensions:SPUpdateAdExtension |
POST | /adsApi/v1/update/adExtensions |
v1-sp-ad-groups¶
SP AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sp-ad-groups:SPCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-sp-ad-groups:SPDeleteAdGroup |
POST | /adsApi/v1/delete/adGroups |
|
v1-sp-ad-groups:SPQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-sp-ad-groups:SPUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-sp-ads¶
SP Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sp-ads:SPCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-sp-ads:SPDeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-sp-ads:SPQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-sp-ads:SPUpdateAd |
POST | /adsApi/v1/update/ads |
v1-sp-campaigns¶
SP Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sp-campaigns:SPCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-sp-campaigns:SPDeleteCampaign |
POST | /adsApi/v1/delete/campaigns |
|
v1-sp-campaigns:SPQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-sp-campaigns:SPUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-sp-targets¶
SP Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-sp-targets:SPCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-sp-targets:SPDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-sp-targets:SPQueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-sp-targets:SPUpdateTarget |
POST | /adsApi/v1/update/targets |
v1-spglobal-ad-extensions¶
SP GLOBAL AdExtensions API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-spglobal-ad-extensions:SPGlobalCreateAdExtension |
POST | /adsApi/v1/create/adExtensions |
|
v1-spglobal-ad-extensions:SPGlobalQueryAdExtension |
POST | /adsApi/v1/query/adExtensions |
|
v1-spglobal-ad-extensions:SPGlobalUpdateAdExtension |
POST | /adsApi/v1/update/adExtensions |
v1-spglobal-ad-groups¶
SP GLOBAL AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-spglobal-ad-groups:SPGlobalCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-spglobal-ad-groups:SPGlobalDeleteAdGroup |
POST | /adsApi/v1/delete/adGroups |
|
v1-spglobal-ad-groups:SPGlobalQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-spglobal-ad-groups:SPGlobalUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-spglobal-ads¶
SP GLOBAL Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-spglobal-ads:SPGlobalCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-spglobal-ads:SPGlobalDeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-spglobal-ads:SPGlobalQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-spglobal-ads:SPGlobalUpdateAd |
POST | /adsApi/v1/update/ads |
v1-spglobal-campaigns¶
SP GLOBAL Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-spglobal-campaigns:SPGlobalCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-spglobal-campaigns:SPGlobalDeleteCampaign |
POST | /adsApi/v1/delete/campaigns |
|
v1-spglobal-campaigns:SPGlobalQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-spglobal-campaigns:SPGlobalUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-spglobal-targets¶
SP GLOBAL Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-spglobal-targets:SPGlobalCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-spglobal-targets:SPGlobalDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-spglobal-targets:SPGlobalQueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-spglobal-targets:SPGlobalUpdateTarget |
POST | /adsApi/v1/update/targets |
v1-st-ad-groups¶
ST AdGroups API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-st-ad-groups:STCreateAdGroup |
POST | /adsApi/v1/create/adGroups |
|
v1-st-ad-groups:STQueryAdGroup |
POST | /adsApi/v1/query/adGroups |
|
v1-st-ad-groups:STUpdateAdGroup |
POST | /adsApi/v1/update/adGroups |
v1-st-ads¶
ST Ads API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-st-ads:STCreateAd |
POST | /adsApi/v1/create/ads |
|
v1-st-ads:STDeleteAd |
POST | /adsApi/v1/delete/ads |
|
v1-st-ads:STQueryAd |
POST | /adsApi/v1/query/ads |
|
v1-st-ads:STUpdateAd |
POST | /adsApi/v1/update/ads |
v1-st-campaigns¶
ST Campaigns API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-st-campaigns:STCreateCampaign |
POST | /adsApi/v1/create/campaigns |
|
v1-st-campaigns:STQueryCampaign |
POST | /adsApi/v1/query/campaigns |
|
v1-st-campaigns:STUpdateCampaign |
POST | /adsApi/v1/update/campaigns |
v1-st-targets¶
ST Targets API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
v1-st-targets:STCreateTarget |
POST | /adsApi/v1/create/targets |
|
v1-st-targets:STDeleteTarget |
POST | /adsApi/v1/delete/targets |
|
v1-st-targets:STQueryTarget |
POST | /adsApi/v1/query/targets |
|
v1-st-targets:STUpdateTarget |
POST | /adsApi/v1/update/targets |
validation-configurations-api¶
Validation Configurations API, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
validation-configurations-api:getCampaignsValidationConfigs |
POST | /validationConfigurations/campaigns |
|
validation-configurations-api:getTargetingClausesValidationConfigs |
POST | /validationConfigurations/targetingClauses |
workflow-management-service¶
Workflow Management Service, version 3.0.
| Operation id | Method | Path | Flags |
|---|---|---|---|
workflow-management-service:listDataSources |
GET | /amc/reporting/{instanceId}/dataSources |
|
workflow-management-service:getDataSource |
GET | /amc/reporting/{instanceId}/dataSources/{dataSourceId} |
|
workflow-management-service:listSchedules |
GET | /amc/reporting/{instanceId}/schedules |
|
workflow-management-service:createSchedule |
POST | /amc/reporting/{instanceId}/schedules |
|
workflow-management-service:getSchedule |
GET | /amc/reporting/{instanceId}/schedules/{scheduleId} |
|
workflow-management-service:updateSchedule |
PUT | /amc/reporting/{instanceId}/schedules/{scheduleId} |
|
workflow-management-service:deleteSchedule |
DELETE | /amc/reporting/{instanceId}/schedules/{scheduleId} |
|
workflow-management-service:listWorkflowExecutions |
GET | /amc/reporting/{instanceId}/workflowExecutions |
|
workflow-management-service:createWorkflowExecution |
POST | /amc/reporting/{instanceId}/workflowExecutions |
|
workflow-management-service:getWorkflowExecution |
GET | /amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId} |
|
workflow-management-service:UpdateWorkflowExecution |
PUT | /amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId} |
|
workflow-management-service:getWorkflowExecutionDownloadUrls |
GET | /amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}/downloadUrls |
|
workflow-management-service:listWorkflows |
GET | /amc/reporting/{instanceId}/workflows |
|
workflow-management-service:createWorkflow |
POST | /amc/reporting/{instanceId}/workflows |
|
workflow-management-service:getWorkflow |
GET | /amc/reporting/{instanceId}/workflows/{workflowId} |
|
workflow-management-service:updateWorkflow |
PUT | /amc/reporting/{instanceId}/workflows/{workflowId} |
|
workflow-management-service:deleteWorkflow |
DELETE | /amc/reporting/{instanceId}/workflows/{workflowId} |