This page lists every tool the Amazon Ads MCP exposes, grouped by the underlying Amazon Ads API resource. Each entry shows whether it's a read tool (safe to call freely) or a write tool (guarded, may require approval), the tool name, and a short description. See Kuudo MCP Servers for the full index of Kuudo MCP servers.
Expand any resource below to see its tools. Your browser's find-in-page (Ctrl+F / Cmd+F) searches across every tool on this page, even inside collapsed sections.
AccountsAccountBudgets 2 tools
AccountsAccountBudgets_getAccountBudgetFeatureFlagsGets account budget feature flags information.
AccountsAccountBudgets_updateAccountBudgetFeatureFlagsCreates or Updates account budget feature flags information.
AccountsAdsAccounts 5 tools
AccountsAdsAccounts_RegisterAdsAccountCreate a new advertising account tied to a specific Amazon vendor, seller or author, or to a business who does not sell on Amazon.
AccountsAdsAccounts_ListAdsAccountsList all advertising accounts for the user associated with the access token.
AccountsAdsAccounts_GetAccountRequest attributes of a given advertising account.
AccountsAdsAccounts_CreateTermsTokenCreate a new UUID terms token for the customer to accept advertising terms Requires one of these permissions: []
AccountsAdsAccounts_GetTermsTokenGet the terms token status for the customer Requires one of these permissions: []
AccountsBilling 19 tools
AccountsBilling_GetDocumentGets billing document(s) with id.
AccountsBilling_PayInvoicesExecutes payment on a set of or all of an advertisers open invoices.
AccountsBilling_bulkGetBillingNotificationsGets an array of all currently valid billing notifications associated for each advertising account.
AccountsBilling_CreatePaymentAgreementsCreates or updates payment agreements.
AccountsBilling_GetPaymentAgreementsGets current payment agreement for a customer.
AccountsBilling_GetCustomerPaymentMethodsRetrieves eligible payment methods for a customer.
AccountsBilling_CreatePaymentProfilesCreates or updates payment profiles.
AccountsBilling_bulkGetBillingStatusGets the current billing status associated for each advertising account.
AccountsBilling_GetBillingProfileAgreementContentUser needs to provide consent to certain agreements before creating a billing profile.
AccountsBilling_ApplyBillingProfileAPI to link one or more countries with a billing profile.
AccountsBilling_GetBillingProfileUsagesLists the billing profiles linked to each country of global ads account.
AccountsBilling_CreateBillingProfilesCreates one or more billing profiles.
AccountsBilling_UpdateBillingProfilesUpdates one or more billing profiles under a global account Please note that isBillTo and type are immutable attributes and cannot be updated -- in this case, user can always create a new billing...
AccountsBilling_GetBillingProfilesFetches billing profiles present under the global account.
AccountsBilling_CreateBillingStatementRequest to create billing statement for advertiser advertising in Sponsored Products/Brands/Display segment.
AccountsBilling_GetBillingStatementAPI to fetch the latest status of Billing Statements creation request and billing statement download link if available.
AccountsBilling_GetBillingInvoiceSummariesLists the billing invoice summary(s) in a global ads account.
AccountsBilling_getAdvertiserInvoicesRequires one of these permissions: ["nemo_transactions_view","nemo_transactions_edit"]
AccountsBilling_getInvoiceRequires one of these permissions: ["nemo_transactions_view","nemo_transactions_edit"]
AccountsManagerAccounts 4 tools
AccountsManagerAccounts_getManagerAccountsForUserReturns all manager accounts that a user has access to, along with metadata for the Amazon Ads accounts t...
AccountsManagerAccounts_createManagerAccountCreates a new Amazon Advertising Manager account.
AccountsManagerAccounts_LinkAdvertisingAccountsToManagerAccountPublicAPILink Amazon Advertising accounts or advertisers with a Manager Account.
AccountsManagerAccounts_UnlinkAdvertisingAccountsToManagerAccountPublicAPIUnlink Amazon Advertising accounts or advertisers with a Manager Account.
AccountsPortfolios 4 tools
AccountsPortfolios_CreatePortfoliosRequires one of these permissions: ["advertiser_campaign_edit"]
AccountsPortfolios_UpdatePortfoliosRequires one of these permissions: ["advertiser_campaign_edit"]
AccountsPortfolios_portfolioBudgetUsageRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
AccountsPortfolios_ListPortfoliosRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
AccountsProfiles 3 tools
AccountsProfiles_listProfilesNote that this operation does not return a response unless the current account has created at least one campaign using the advertising console.
AccountsProfiles_updateProfilesNote that this operation is only used for Sellers using Sponsored Products.
AccountsProfiles_getProfileByIdThis operation does not return a response unless the current account has created at least one campaign using the advertising console.
AdsAPIv1All 87 tools
AdsAPIv1All_ListBrandStoreEditionRetrieve brand store page content Requires one of these permissions: ["amazon_stores_edit","amazon_stores_view"]
AdsAPIv1All_DSPListCommitmentList commitments Requires one of these permissions: []
AdsAPIv1All_CreateAccountCombinationInvitationCreate an invitation to combine Advertising Accounts under a Single Global Accou...
AdsAPIv1All_CreateAdAssociationCreate Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1All_CreateAdExtensionCreate ad extensions - API is in open beta Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1All_CreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_e...
AdsAPIv1All_CreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1All_CreateAdvertiserAccountCreate advertiser accounts Requires one of these permissions: []
AdsAPIv1All_CreateAdvertiserProductGroupEligibilityCreate request for specific advertiser product group eligibility Requires one...
AdsAPIv1All_SBCreateAdvertisingDealTargetCreate advertisingDealTarget Requires one of these permissions: ["advertise...
AdsAPIv1All_SBCreateAdvertisingDealCreate advertisingDeal Requires one of these permissions: ["advertiser_campaign_edit", "advertiser_campaign_view"]
AdsAPIv1All_SBCreateBrandedKeywordsPricingCreate brandedKeywords pricing Requires one of these permissions: ["adverti...
AdsAPIv1All_CreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_e...
AdsAPIv1All_DSPCreateCommitmentCreate commitments Requires one of these permissions: []
AdsAPIv1All_CreateEventCreate Event Data Requires one of these permissions: ["event_manager_view", "event_manager_edit"]
AdsAPIv1All_CreateGeoLocationCreate geo location targeting definitions.
AdsAPIv1All_DSPAdsApiv1CreateInventoryGroupCreate inventory groups Requires one of these permissions: ["inventory_edit"]
AdsAPIv1All_SBCreateKeywordReservationValidationValidate keyword reservation Requires one of these permissions: ["advertise...
AdsAPIv1All_CreateLinearTvIncrementalReachForecastGenerate Linear TV incremental reach forecast comparing with supported Streaming...
AdsAPIv1All_CreateLinearTvReachForecastGenerate Linear TV reach forecast Requires one of these permissions: ["campaign_edit"]
AdsAPIv1All_CreateLocationIndexCreate a Smart Location Index.
AdsAPIv1All_CreateManagerAccountCreate manager accounts Requires one of these permissions: []
AdsAPIv1All_SBCreateRecommendationCreate recommendations Requires one of these permissions: ["advertiser_campaign_view"]
AdsAPIv1All_AdsApiv1CreateReportCreate a report Requires one of these permissions: ["ManagerAccount_Dev", "...
AdsAPIv1All_DSPAdsApiv1CreateSupplierAdProductPriceCreate supplier ad product price Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1CreateSupplierProposalCreate supplier proposal Requires one of these permissions: ["inventory_edit"]
AdsAPIv1All_DSPAdsApiv1CreateSupplierProposedDealForecastCreate supplier proposed deal forecast Requires one of these permissions: ["inventory_edit"]
AdsAPIv1All_DSPAdsApiv1CreateSupplierProposedDealCreate supplier proposed deal Requires one of these permissions: ["inventory_edit"]
AdsAPIv1All_CreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1All_DSPListDealPlanningMetricsList deal planning metrics for specified deals.
AdsAPIv1All_DeleteAdAssociationDelete Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1All_DeleteAdGroupDelete ad groups Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1All_DeleteAdDelete ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1All_SBDeleteAdvertisingDealTargetDelete advertisingDealTarget Requires one of these permissions: ["advertise...
AdsAPIv1All_SBDeleteAdvertisingDealDelete advertisingDeal Requires one of these permissions: ["advertiser_campaign_edit", "advertiser_campaign_view"]
AdsAPIv1All_DeleteCampaignDelete campaigns Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1All_AdsApiv1DeleteReportDelete a report by ID Requires one of these permissions: []
AdsAPIv1All_DeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1All_ListLocationIndexList all Smart Location Indexes for the authenticated advertiser.
AdsAPIv1All_QueryAccountCombinationInvitationQuery invitations to combine advertising accounts under a Single Global Account.
AdsAPIv1All_QueryAdAssociationQuery Ad Association Requires one of these permissions: ["creatives_view", "campaign_view"]
AdsAPIv1All_QueryAdExtensionQuery ad_extension - API is in open beta Requires one of these permissions:...
AdsAPIv1All_QueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edi...
AdsAPIv1All_QueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit", "c...
AdsAPIv1All_QueryAdvertiserAccountList advertiser accounts Requires one of these permissions: []
AdsAPIv1All_QueryAdvertiserProductGroupEligibilityQuery requests for specific advertiser product group eligibility based on advert...
AdsAPIv1All_SBQueryAdvertisingDealTargetQuery advertisingDealTarget Requires one of these permissions: ["advertiser...
AdsAPIv1All_SBQueryAdvertisingDealQuery advertisingDeal Requires one of these permissions: ["advertiser_campaign_edit", "advertiser_campaign_view"]
AdsAPIv1All_QueryBrandStoreEditionPublishVersionQuery store edition publish versions Requires one of these permissions: ["amazon_stores_edit","amazon_stores_view"]
AdsAPIv1All_QueryBrandStorePageRetrieve brand store page content Requires one of these permissions: ["amazon_stores_edit","amazon_stores_view"]
AdsAPIv1All_QueryBrandStoreQuery brand store content Requires one of these permissions: ["advertiser_c...
AdsAPIv1All_QueryCampaignQuery campaign Requires one of these permissions: ["advertiser_campaign_edi...
AdsAPIv1All_DSPQueryDealAvailsQuery deal avails by advertising deal ID.
AdsAPIv1All_DSPAdsApiv1QueryInventoryGroupQuery inventory groups with filters Requires one of these permissions: ["inventory_edit", "inventory_view"]
AdsAPIv1All_QueryLinearTvDaypartList all supported Linear TV Daypart Requires one of these permissions: []
AdsAPIv1All_QueryManagerAccountList manager accounts Requires one of these permissions: []
AdsAPIv1All_AdsApiv1QueryPublisherList all Publishers Requires one of these permissions: []
AdsAPIv1All_SBQueryRecommendationTypeQuery RecommendationTypes Requires one of these permissions: ["advertiser_campaign_view"]
AdsAPIv1All_QuerySellingAccountList selling accounts Requires one of these permissions: []
AdsAPIv1All_DSPAdsApiv1QuerySupplierAdProductQuery supplier ad products Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1QuerySupplierProposalQuery supplier proposal Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1QuerySupplierProposedDealQuery supplier proposed deals Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1QuerySupplierPublisherQuery supplier publishers Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1QuerySupplierTargetItemFetch supplier target items Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_DSPAdsApiv1QuerySupplierQuery suppliers Requires one of these permissions: ["inventory_view"]
AdsAPIv1All_QueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit",...
AdsAPIv1All_DSPRetrieveCampaignForecastRetrieve campaign forecast Requires one of these permissions: ["campaign_view", "advertiser_campaign_view"]
AdsAPIv1All_DSPRetrieveCommitmentSpendRetrieve commitment spend Requires one of these permissions: []
AdsAPIv1All_DSPRetrieveCommitmentGet Commitments Requires one of these permissions: []
AdsAPIv1All_DSPAdsApiv1RetrieveInventoryGroupRetrieve inventory groups by ID Requires one of these permissions: ["inventory_edit", "inventory_view"]
AdsAPIv1All_RetrieveLocationIndexRetrieve one or more Smart Location Indexes by ID.
AdsAPIv1All_AdsApiv1RetrieveReportRetrieve a report by ID Requires one of these permissions: []
AdsAPIv1All_UpdateAccountCombinationInvitationUpdate an invitation to combine Advertising Accounts under a Single Global Accou...
AdsAPIv1All_UpdateAdAssociationUpdate Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1All_UpdateAdExtensionUpdate ad_extension - API is in open beta Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1All_UpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_e...
AdsAPIv1All_UpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1All_UpdateAdvertiserAccountUpdate advertiser accounts Requires one of these permissions: []
AdsAPIv1All_SBUpdateAdvertisingDealUpdate advertisingDeal Requires one of these permissions: ["advertiser_campaign_edit", "advertiser_campaign_view"]
AdsAPIv1All_UpdateBrandStoreEditionPublishVersionUpdate store edition publish versions Requires one of these permissions: ["amazon_stores_edit"]
AdsAPIv1All_UpdateBrandStorePageUpdate brand store page content Requires one of these permissions: ["amazon_stores_edit"]
AdsAPIv1All_UpdateCampaignUpdate campaign Requires one of these permissions: ["advertiser_campaign_ed...
AdsAPIv1All_DSPUpdateCommitmentUpdate commitments Requires one of these permissions: []
AdsAPIv1All_DSPAdsApiv1UpdateInventoryGroupUpdate inventory groups Requires one of these permissions: ["inventory_edit"]
AdsAPIv1All_UpdateLocationIndexUpdate the data for an existing Smart Location Index.
AdsAPIv1All_UpdateManagerAccountUpdate manager accounts Requires one of these permissions: []
AdsAPIv1All_UpdateTargetUpdate target Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1Beta 42 tools
AdsAPIv1Beta_CreateAccountCombinationInvitationCreate an invitation to combine Advertising Accounts under a Single Global Accou...
AdsAPIv1Beta_CreateAdvertiserAccountCreate advertiser accounts Requires one of these permissions: []
AdsAPIv1Beta_CreateAdvertiserProductGroupEligibilityCreate request for specific advertiser product group eligibility Requires one...
AdsAPIv1Beta_CreateEventCreate Event Data Requires one of these permissions: ["event_manager_view", "event_manager_edit"]
AdsAPIv1Beta_CreateGeoLocationCreate geo location targeting definitions.
AdsAPIv1Beta_DSPAdsApiv1CreateInventoryGroupCreate inventory groups Requires one of these permissions: ["inventory_edit"]
AdsAPIv1Beta_CreateLinearTvIncrementalReachForecastGenerate Linear TV incremental reach forecast comparing with supported Streaming...
AdsAPIv1Beta_CreateLinearTvReachForecastGenerate Linear TV reach forecast Requires one of these permissions: ["campaign_edit"]
AdsAPIv1Beta_CreateLocationIndexCreate a Smart Location Index.
AdsAPIv1Beta_CreateManagerAccountCreate manager accounts Requires one of these permissions: []
AdsAPIv1Beta_AdsApiv1CreateReportCreate a report Requires one of these permissions: ["ManagerAccount_Dev", "...
AdsAPIv1Beta_DSPAdsApiv1CreateSupplierAdProductPriceCreate supplier ad product price Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1CreateSupplierProposalCreate supplier proposal Requires one of these permissions: ["inventory_edit"]
AdsAPIv1Beta_DSPAdsApiv1CreateSupplierProposedDealForecastCreate supplier proposed deal forecast Requires one of these permissions: ["inventory_edit"]
AdsAPIv1Beta_DSPAdsApiv1CreateSupplierProposedDealCreate supplier proposed deal Requires one of these permissions: ["inventory_edit"]
AdsAPIv1Beta_DSPListDealPlanningMetricsList deal planning metrics for specified deals.
AdsAPIv1Beta_AdsApiv1DeleteReportDelete a report by ID Requires one of these permissions: []
AdsAPIv1Beta_ListLocationIndexList all Smart Location Indexes for the authenticated advertiser.
AdsAPIv1Beta_QueryAccountCombinationInvitationQuery invitations to combine advertising accounts under a Single Global Account.
AdsAPIv1Beta_QueryAdvertiserAccountList advertiser accounts Requires one of these permissions: []
AdsAPIv1Beta_QueryAdvertiserProductGroupEligibilityQuery requests for specific advertiser product group eligibility based on advert...
AdsAPIv1Beta_DSPQueryDealAvailsQuery deal avails by advertising deal ID.
AdsAPIv1Beta_DSPAdsApiv1QueryInventoryGroupQuery inventory groups with filters Requires one of these permissions: ["inventory_edit", "inventory_view"]
AdsAPIv1Beta_QueryLinearTvDaypartList all supported Linear TV Daypart Requires one of these permissions: []
AdsAPIv1Beta_QueryManagerAccountList manager accounts Requires one of these permissions: []
AdsAPIv1Beta_AdsApiv1QueryPublisherList all Publishers Requires one of these permissions: []
AdsAPIv1Beta_QuerySellingAccountList selling accounts Requires one of these permissions: []
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierAdProductQuery supplier ad products Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierProposalQuery supplier proposal Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierProposedDealQuery supplier proposed deals Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierPublisherQuery supplier publishers Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierTargetItemFetch supplier target items Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1QuerySupplierQuery suppliers Requires one of these permissions: ["inventory_view"]
AdsAPIv1Beta_DSPAdsApiv1RetrieveInventoryGroupRetrieve inventory groups by ID Requires one of these permissions: ["inventory_edit", "inventory_view"]
AdsAPIv1Beta_RetrieveLocationIndexRetrieve one or more Smart Location Indexes by ID.
AdsAPIv1Beta_AdsApiv1RetrieveReportRetrieve a report by ID Requires one of these permissions: []
AdsAPIv1Beta_UpdateAccountCombinationInvitationUpdate an invitation to combine Advertising Accounts under a Single Global Accou...
AdsAPIv1Beta_UpdateAdvertiserAccountUpdate advertiser accounts Requires one of these permissions: []
AdsAPIv1Beta_UpdateBrandStorePageUpdate brand store page content Requires one of these permissions: ["amazon_stores_edit"]
AdsAPIv1Beta_DSPAdsApiv1UpdateInventoryGroupUpdate inventory groups Requires one of these permissions: ["inventory_edit"]
AdsAPIv1Beta_UpdateLocationIndexUpdate the data for an existing Smart Location Index.
AdsAPIv1Beta_UpdateManagerAccountUpdate manager accounts Requires one of these permissions: []
AdsAPIv1DSP 16 tools
AdsAPIv1DSP_DSPCreateAdAssociationCreate Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1DSP_DSPCreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPCreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1DSP_DSPCreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPCreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPDeleteAdAssociationDelete Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1DSP_DSPDeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPQueryAdAssociationQuery Ad Association Requires one of these permissions: ["creatives_view", "campaign_view"]
AdsAPIv1DSP_DSPQueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1DSP_DSPQueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_view", "advertiser_campaign_view"]
AdsAPIv1DSP_DSPQueryCampaignQuery campaign Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1DSP_DSPQueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPUpdateAdAssociationUpdate Ad Association Requires one of these permissions: ["campaign_edit"]
AdsAPIv1DSP_DSPUpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1DSP_DSPUpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1DSP_DSPUpdateCampaignUpdate campaign Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands 16 tools
AdsAPIv1SponsoredBrands_SBCreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBCreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredBrands_SBCreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBCreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBDeleteAdGroupDelete ad groups Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredBrands_SBDeleteAdDelete ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredBrands_SBDeleteCampaignDelete campaigns Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredBrands_SBDeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBQueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredBrands_SBQueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredBrands_SBQueryCampaignQuery campaign Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredBrands_SBQueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBUpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBUpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredBrands_SBUpdateCampaignUpdate campaign Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredBrands_SBUpdateTargetUpdate target Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredDisplay 16 tools
AdsAPIv1SponsoredDisplay_SDCreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDCreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredDisplay_SDCreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDCreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDDeleteAdGroupDelete ad groups Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDDeleteAdDelete ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDDeleteCampaignDelete campaigns Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDDeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDQueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredDisplay_SDQueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredDisplay_SDQueryCampaignQuery campaign Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredDisplay_SDQueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDUpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDUpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredDisplay_SDUpdateCampaignUpdate campaign Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredDisplay_SDUpdateTargetUpdate target Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredProducts 18 tools
AdsAPIv1SponsoredProducts_SPCreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPCreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredProducts_SPCreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPCreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPDeleteAdGroupDelete ad groups Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredProducts_SPDeleteAdDelete ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredProducts_SPDeleteCampaignDelete campaigns Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredProducts_SPDeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPQueryAdExtensionQuery ad_extension - API is in open beta Requires one of these permissions: ["advertiser_campaign_edit", "advertiser_campaign_view"]
AdsAPIv1SponsoredProducts_SPQueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredProducts_SPQueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredProducts_SPQueryCampaignQuery campaign Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredProducts_SPQueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPUpdateAdExtensionUpdate ad_extension - API is in open beta Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredProducts_SPUpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPUpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit", "creatives_edit"]
AdsAPIv1SponsoredProducts_SPUpdateCampaignUpdate campaign Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredProducts_SPUpdateTargetUpdate target Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredTelevision 14 tools
AdsAPIv1SponsoredTelevision_STCreateAdGroupCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STCreateAdCreate ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredTelevision_STCreateCampaignCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STCreateTargetCreate target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STDeleteAdDelete ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredTelevision_STDeleteTargetDelete target Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STQueryAdGroupList ad groups Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]
AdsAPIv1SponsoredTelevision_STQueryAdList ads Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
AdsAPIv1SponsoredTelevision_STQueryCampaignQuery campaign Requires one of these permissions: []
AdsAPIv1SponsoredTelevision_STQueryTargetList target Requires one of these permissions: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STUpdateAdGroupUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]
AdsAPIv1SponsoredTelevision_STUpdateAdUpdate ads Requires one of these permissions: ["advertiser_campaign_edit"]
AdsAPIv1SponsoredTelevision_STUpdateCampaignUpdate campaign Requires one of these permissions: []
AdsAPIv1SponsoredTelevision_STUpdateTargetUpdate target Requires one of these permissions: ["advertiser_campaign_edit"]
AmazonAttribution 5 tools
AmazonAttribution_getAdvertisersByProfileFor sellers, an attribution profile has one associated advertiser.
AmazonAttribution_getPublishersUse the response to determine whether to use either the macroTags or nonMacroTemplateTags resource to get tags for a certain publisher.
AmazonAttribution_getAttributionTagsByCampaignGets an attribution report for a specified list of advertisers.
AmazonAttribution_getPublisherAttributionTagTemplateThird-party publishers, such as Google Ads, Facebook, Microsoft Ads, and Pinterest support tags that include macro parameters.
AmazonAttribution_getPublisherMacroAttributionTagSome third-party publishers do not support tags that include macro parameters.
AmazonDSPAudiences 1 tools
AmazonDSPAudiences_dspCreateAudiencesPostCreates a targeting audience based on an audience definition.
AmazonDSPConversions 17 tools
AmazonDSPConversions_dspAmazonAdTagGetEventsByAdTagIdAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
AmazonDSPConversions_dspAmazonAdTagGetAdTagByAdvertiserIdAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
AmazonDSPConversions_dspAmazonBatchGetConversionDefinitionsForOrdersAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_view"]
AmazonDSPConversions_dspAmazonCreateConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonUpdateConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonDeletionRequestAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonIngestConversionDataAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonListConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
AmazonDSPConversions_dspAmazonGetAdTagAssociatedEventAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
AmazonDSPConversions_dspAmazonUpdateAdTagAssociatedEventAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonGetAssociatedMobileAppForConversionDefinitionAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
AmazonDSPConversions_dspAmazonBatchCreateMobileMeasurementPartnerAppRegistrationAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonBatchUpdateMobileMeasurementPartnerAppRegistrationAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonDeleteMeasurementPartnerAppRegistrationsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
AmazonDSPConversions_dspAmazonListMobileMeasurementPartnerAppRegistrationsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
AmazonDSPConversions_dspAmazonGetAssociatedConversionDefinitionsForOrderAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_view"]
AmazonDSPConversions_dspAmazonUpdateAssociatedConversionDefinitionsForOrderAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_edit"]
AmazonDSPMeasurement 30 tools
AmazonDSPMeasurement_CheckDSPAudienceResearchEligibilityChecks the DSP AUDIENCE_RESEARCH study type eligibility status against vendor products.
AmazonDSPMeasurement_CheckDSPBrandLiftEligibilityChecks the DSP BRAND_LIFT study type eligibility status against vendor products.
AmazonDSPMeasurement_CheckDSPCreativeTestingEligibilityChecks the DSP CREATIVE_TESTING study type eligibility status against vendor products.
AmazonDSPMeasurement_CheckDSPOmnichannelMetricsEligibilityChecks the DSP OMNICHANNEL_METRICS study type eligibility status against vendor products.
AmazonDSPMeasurement_GetDSPAudienceResearchStudiesGets one or more DSP AUDIENCE_RESEARCH studies with requested study identifiers or an advertiser identifier.
AmazonDSPMeasurement_CreateDSPAudienceResearchStudyCreate new DSP AUDIENCE_RESEARCH study.
AmazonDSPMeasurement_UpdateDSPAudienceResearchStudyUpdate DSP AUDIENCE_RESEARCH study.
AmazonDSPMeasurement_GetDSPAudienceResearchStudyResultGet result of a DSP AUDIENCE_RESEARCH study.
AmazonDSPMeasurement_GetDSPBrandLiftStudiesGets one or more DSP BRAND_LIFT studies with requested study identifiers or an advertiser identifier.
AmazonDSPMeasurement_CreateDSPBrandLiftStudiesCreate new DSP BRAND_LIFT studies.
AmazonDSPMeasurement_UpdateDSPBrandLiftStudiesUpdate DSP BRAND_LIFT studies.
AmazonDSPMeasurement_GetDSPCreativeTestingStudiesGets one or more DSP CREATIVE_TESTING studies with requested study identifiers or an advertiser identifier.
AmazonDSPMeasurement_CreateDSPCreativeTestingStudyCreate new DSP CREATIVE_TESTING study.
AmazonDSPMeasurement_UpdateDSPCreativeTestingStudyUpdate DSP CREATIVE_TESTING study.
AmazonDSPMeasurement_GetDSPCreativeTestingStudyResultGet result of a DSP CREATIVE_TESTING study.
AmazonDSPMeasurement_GetDSPOmnichannelMetricsStudiesGets one or more DSP OMNICHANNEL_METRICS studies with requested study identifiers or an advertiser identifier.
AmazonDSPMeasurement_CreateDSPOmnichannelMetricsStudiesCreate new DSP OMNICHANNEL_METRICS studies.
AmazonDSPMeasurement_UpdateDSPOmnichannelMetricsStudiesUpdate DSP OMNICHANNEL_METRICS studies.
AmazonDSPMeasurement_GetDSPOmnichannelMetricsStudyResultGet result of a DSP OMNICHANNEL_METRICS study.
AmazonDSPMeasurement_CheckPlanningEligibilityChecks eligibility against all vendor products.
AmazonDSPMeasurement_CancelMeasurementStudiesCancel existing studies.
AmazonDSPMeasurement_GetStudiesGets base study objects given a list of studyIds or a list of advertiserIds.
AmazonDSPMeasurement_GetDSPBrandLiftStudyResultGet result of a DSP BRAND_LIFT study.
AmazonDSPMeasurement_GetSurveysGets one or more study surveys with requested survey identifiers or a study identifier.
AmazonDSPMeasurement_CreateSurveysCreate new study surveys.
AmazonDSPMeasurement_UpdateSurveysUpdate measurement surveys.
AmazonDSPMeasurement_vendorProductLists the supported measurement vendors products.
AmazonDSPMeasurement_omnichannelMetricsBrandSearchSearch for brands to be used in the OMNICHANNEL_METRICS vendor product.
AmazonDSPMeasurement_vendorProductPolicyGets the policies for the specific vendor product(s).
AmazonDSPMeasurement_vendorProductSurveyQuestionTemplatesGets the survey question templates for the specific vendor product(s).
AmazonDSPTargetKPIRecommendations 1 tools
AmazonDSPTargetKPIRecommendations_getGsbTargetKpiRecommendationCreates a Target KPI recommendation for advertisers when they are in the process of creating a new campaign (ADSP).
AmazonMarketingStreamSubscriptions 8 tools
AmazonMarketingStreamSubscriptions_ListDspStreamSubscriptionsList subscriptions Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-Account-ID Parameter in:…
AmazonMarketingStreamSubscriptions_CreateDspStreamSubscriptionCreate a new subscription Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-Account-ID Parameter…
AmazonMarketingStreamSubscriptions_GetDspStreamSubscriptionFetch a specific subscription by Id Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-Acc...
AmazonMarketingStreamSubscriptions_UpdateDspStreamSubscriptionUpdate an existing subscription Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-Account-ID…
AmazonMarketingStreamSubscriptions_ListStreamSubscriptionsList subscriptions Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in:…
AmazonMarketingStreamSubscriptions_CreateStreamSubscriptionCreate a new subscription Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter…
AmazonMarketingStreamSubscriptions_GetStreamSubscriptionFetch a specific subscription by Id Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-Acc...
AmazonMarketingStreamSubscriptions_UpdateStreamSubscriptionUpdate an existing subscription Note: trailing slash in request uri is not allowed Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId…
AMCAdAudience 10 tools
AMCAdAudience_AmcpLinkRemoveConnectionV2Delete a connection between the Partner and Advertiser's AMC Instances and/or DSP Advertisers.
AMCAdAudience_AmcpLinkGetConnectionsV2Get a list of connections between the Partner and Advertiser's AMC Instances & DSP Advertisers.
AMCAdAudience_AmcpLinkAddConnectionV2Create a new connection between the Partner and Advertiser's AMC Instances and/or DSP Advertisers.
AMCAdAudience_AmcpLinkGetTermsV2Get the Customer's AMC Terms and Conditions acceptance.
AMCAdAudience_AmcpLinkSetTermsAcceptanceV2Set the Customer's AMC Terms and Conditions acceptance.
AMCAdAudience_CreateAudienceMetadataV2Create a new Advertiser Audience Metadata.
AMCAdAudience_GetAudienceMetadataV2Get an Advertiser Audience Metadata using AudienceId.
AMCAdAudience_UpdateAudienceMetadataV2Update an existing Advertiser Audience Metadata.
AMCAdAudience_ManageAudienceV2Manage Advertiser audiences by adding or removing members from an Audience.
AMCAdAudience_ManageAudienceStatusV2Get the status of a manage audience members request.
AMCAdmin 20 tools
AMCAdmin_AmcpLinkListAmcAccountsGet a list of AMC Accounts that the user have access to.
AMCAdmin_listInstancesGets information about all AMC instances that the requesting entity has access to.
AMCAdmin_createInstanceCreates a new AMC instance.
AMCAdmin_deleteInstanceDeletes the requested AMC instance.
AMCAdmin_getInstanceGets information about the requested AMC instance.
AMCAdmin_updateInstanceUpdates the requested AMC instance.
AMCAdmin_getInstanceAdvertisersGets advertisers information about the requested AMC instance.
AMCAdmin_listAdvertiserUpdatesGets advertiser updates for the requested AMC instance.
AMCAdmin_createAdvertiserUpdateCreates a new advertiser update for the requested AMC instance.
AMCAdmin_getAdvertiserUpdateGets the requested advertiser update for the requested AMC instance.
AMCAdmin_getInstanceCollaborationGets the collaboration metadata for the requested AMC instance.
AMCAdmin_createCollaborationIdMappingTableCreates an ID Mapping Table in the requested AMC instance collaboration and starts the job to populate the table.
AMCAdmin_listCollaborationIdMappingTablesLists the ID mapping tables in the collaboration in the requested AMC instance.
AMCAdmin_deleteCollaborationIdMappingTableDeletes the given ID Mapping Table in the collaboration for the requested AMC instance.
AMCAdmin_getCollaborationIdMappingJobForTrackingIdRetrieves the ID mapping workflow job associated to the tracking ID.
AMCAdmin_listCollaborationIdMappingJobsLists the jobs associated to the given ID mapping table in the collaboration for the requested AMC instance.
AMCAdmin_getCollaborationIdMappingJobGets the metadata of the job associated to the ID Mapping Table in the collaboration for the requested AMC instance.
AMCAdmin_refreshCollaborationIdMappingTableStarts a workflow job to refresh the data in the given ID Mapping Table in the collaboration for the requested AMC instance.
AMCAdmin_listCollaborationIdNamespacesLists the advertiser ID namespaces that are not connected to an ID mapping table in the collaboration in the requested AMC instance.
AMCAdmin_updateInstanceCustomerAwsAccountMetadataUpdates customer's AWS account metadata in the requested AMC instance.
AMCRuleAudience 6 tools
AMCRuleAudience_createLookalikeAudienceCreates a lookalike audience execution metadata.
AMCRuleAudience_getAllQueryBasedAudiencesByInstanceIdReturns list of execution metadata information for a given instanceId.
AMCRuleAudience_createQueryBasedAudienceCreates a query based audience execution metadata.
AMCRuleAudience_deleteQueryBasedAudienceByAudienceExecutionIdDeletes an audience for a given instanceId and audienceExecutionId.
AMCRuleAudience_getQueryBasedAudienceByAudienceExecutionIdReturns execution metadata information for a given instanceId and audienceExecutionId.
AMCRuleAudience_updateQueryBasedAudienceByAudienceExecutionIdUpdates audience configuration for a given audienceExecutionId.
AMCWorkflow 17 tools
AMCWorkflow_listDataSourcesReturns a list of available data sources.
AMCWorkflow_getDataSourceGets information about the requested data source.
AMCWorkflow_listSchedulesReturns a list of schedules.
AMCWorkflow_createScheduleCreates a new schedule.
AMCWorkflow_deleteScheduleDeletes the requested schedule.
AMCWorkflow_getScheduleGets the requested schedule.
AMCWorkflow_updateScheduleUpdates the requested schedule.
AMCWorkflow_listWorkflowExecutionsReturns a list of workflow executions.
AMCWorkflow_createWorkflowExecutionCreates a new, ad-hoc execution of an existing workflow.
AMCWorkflow_getWorkflowExecutionGets status information about the requested workflow execution.
AMCWorkflow_UpdateWorkflowExecutionUpdates the requested workflow execution.
AMCWorkflow_getWorkflowExecutionDownloadUrlsGenerates and returns pre-signed S3 URLs for the result files produced by and metadata used by the provided workflow execution.
AMCWorkflow_listWorkflowsReturns a list of workflows.
AMCWorkflow_createWorkflowCreates a new workflow.
AMCWorkflow_deleteWorkflowDeletes the requested workflow.
AMCWorkflow_getWorkflowGets the requested workflow.
AMCWorkflow_updateWorkflowUpdates the requested workflow, using the request body directly as the new workflow definition.
AudiencesDiscovery 4 tools
AudiencesDiscovery_listAudiencesReturns a list of audience segments for an advertiser.
AudiencesDiscovery_fetchTaxonomyReturns a list of audience categories for a given category path Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Advertising-AccountId Param...
AudiencesDiscovery_DspAudienceDeleteDeletes an existing targeting audience based on audience ID.
AudiencesDiscovery_DspAudienceEditUpdates an existing targeting audience based on an audience definition and audience ID.
BrandBenchmarks 2 tools
BrandBenchmarks_ListAdvertiserReportMetadataGets all of the report metadata the specified advertiser at the specified marketplace.
BrandBenchmarks_GetAdvertiserReportGets the download link for an advertiser's metric report in the specified marketplace.
BrandMetrics 2 tools
BrandMetrics_generateBrandMetricsReportGenerates the Brand Metrics report in CSV or JSON format.
BrandMetrics_getBrandMetricsReportFetch the location and status of the report for the brands for which the metrics are available.
BrandStoresManagement 5 tools
BrandStoresManagement_ListBrandStoreEditionRequires one of these permissions: ["amazon_stores_edit","amazon_stores_view"]
BrandStoresManagement_QueryBrandStoreEditionPublishVersionA search read, allowing use of more complex filters.
BrandStoresManagement_QueryBrandStorePageA search read, allowing use of more complex filters.
BrandStoresManagement_UpdateBrandStoreEditionPublishVersionUpdates BrandStoreEditionPublishVersions.
BrandStoresManagement_UpdateBrandStorePageUpdates BrandStorePages.
CampaignConversionTracking 3 tools
CampaignConversionTracking_DspGetCampaignConversionTrackingProductsV1Gets the conversion tracking products for a given campaign.
CampaignConversionTracking_DspPostProductConversionTrackingV1Adds products to a campaign to enable product-related conversion metrics.
CampaignConversionTracking_DspDeleteProductConversionTrackingV1Removes one or more products from campaign conversion tracking.
CampaignManage 20 tools
CampaignManage_CreateAdAssociationCreates AdAssociations.
CampaignManage_CreateAdGroupCreates AdGroups.
CampaignManage_CreateAdCreates Ads.
CampaignManage_CreateCampaignCreates Campaigns.
CampaignManage_CreateTargetCreates Targets.
CampaignManage_DeleteAdAssociationArchives or deletes AdAssociations.
CampaignManage_DeleteAdGroupArchives or deletes AdGroups.
CampaignManage_DeleteAdArchives or deletes Ads.
CampaignManage_DeleteCampaignArchives or deletes Campaigns.
CampaignManage_DeleteTargetArchives or deletes Targets.
CampaignManage_QueryAdAssociationA search read, allowing use of more complex filters.
CampaignManage_QueryAdGroupA search read, allowing use of more complex filters.
CampaignManage_QueryAdA search read, allowing use of more complex filters.
CampaignManage_QueryCampaignA search read, allowing use of more complex filters.
CampaignManage_QueryTargetA search read, allowing use of more complex filters.
CampaignManage_UpdateAdAssociationUpdates AdAssociations.
CampaignManage_UpdateAdGroupUpdates AdGroups.
CampaignManage_UpdateAdUpdates Ads.
CampaignManage_UpdateCampaignUpdates Campaigns.
CampaignManage_UpdateTargetUpdates Targets.
ChangeHistory 1 tools
ChangeHistory_getHistoryReturns history of changes for provided event sources that match the filters and time ranges specified.
Conversions 17 tools
Conversions_dspAmazonAdTagGetEventsByAdTagIdAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
Conversions_dspAmazonAdTagGetAdTagByAdvertiserIdAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
Conversions_dspAmazonBatchGetConversionDefinitionsForOrdersAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_view"]
Conversions_dspAmazonCreateConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
Conversions_dspAmazonUpdateConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
Conversions_dspAmazonDeletionRequestAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
Conversions_dspAmazonIngestConversionDataAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
Conversions_dspAmazonListConversionDefinitionsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
Conversions_dspAmazonGetAdTagAssociatedEventAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
Conversions_dspAmazonUpdateAdTagAssociatedEventAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manag...
Conversions_dspAmazonGetAssociatedMobileAppForConversionDefinitionAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
Conversions_dspAmazonBatchCreateMobileMeasurementPartnerAppRegistrationAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
Conversions_dspAmazonBatchUpdateMobileMeasurementPartnerAppRegistrationAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
Conversions_dspAmazonDeleteMeasurementPartnerAppRegistrationsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_edit"]
Conversions_dspAmazonListMobileMeasurementPartnerAppRegistrationsAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["event_manager_view"]
Conversions_dspAmazonGetAssociatedConversionDefinitionsForOrderAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_view"]
Conversions_dspAmazonUpdateAssociatedConversionDefinitionsForOrderAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions: ["campaign_edit"]
CreativesAssets 6 tools
CreativesAssets_getAssetRetrieve an asset
CreativesAssets_assetsBatchRegisterThis is an asynchronous api that provides clients an identifier for their batch registration request.
CreativesAssets_getAssetsBatchRegisterRetrieves status of the batch asset registration request, uniquely identified by requestId.
CreativesAssets_registerAssetThe API should be called once the asset is uploaded to the location provided by the /asset/upload API endpoint.
CreativesAssets_searchAssetsSearch assets
CreativesAssets_getUploadLocationCreates an ephemeral resource (upload location) to upload Assets to Creative Assets tool.
ExportsSnapshots 5 tools
ExportsSnapshots_AdGroupExportCreates a file-based export of Ad Groups in the account satisfying the filtering criteria.
ExportsSnapshots_AdExportCreates a file-based export of Ads in the account satisfying the filtering criteria.
ExportsSnapshots_CampaignExportCreates a file-based export of Campaigns in the account satisfying the filtering criteria.
ExportsSnapshots_GetExportThis API will return a status of the specified export.
ExportsSnapshots_TargetExportCreates a file-based export of Targets in the account satisfying the filtering criteria.
Forecasts 1 tools
Forecasts_DSPRetrieveCampaignForecastA retrieve by ID read.
Locations 1 tools
Locations_listLocationsNote: This endpoint is currently limited to US only.
MediaPlanningReachForecasting 4 tools
MediaPlanningReachForecasting_CreateDeduplicatedReachForecastsV1Creates a list of De-duplicated Reach Forecasts.
MediaPlanningReachForecasting_CreateReachForecastsV1Creates a list of new Reach Forecasts in bulk action.
MediaPlanningReachForecasting_ListReachForecastsV1Gets a list of Reach Forecasts by IDs Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these…
MediaPlanningReachForecasting_ListReachForecastTargetsV1Gets a list of targets of a Reach Forecast Authorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these…
ModerationResults 1 tools
ModerationResults_moderationResultsAPI to get the moderation results for the ad.
ProductsEligibility 2 tools
ProductsEligibility_productEligibilityGets a list of advertising eligibility objects for a set of products.
ProductsEligibility_ProgramEligibilityChecks the advertiser's eligibility to ad programs.
ProductsMetadata 1 tools
ProductsMetadata_ProductMetadataAuthorized resource type: DSP Rodeo Entity ID, DSP Advertiser Account ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions:…
RecommendationsAudienceInsights 1 tools
RecommendationsAudienceInsights_insightsGetAudiencesOverlappingAudiencesRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
RecommendationsInsightsPartnerOpportunities 5 tools
RecommendationsInsightsPartnerOpportunities_partnerOpportunitiesListOpportunitiesGets a list of opportunities specific to the partner making the request.
RecommendationsInsightsPartnerOpportunities_partnerOpportunitiesSummarizeOpportunitiesGets aggregated information about all opportunities specific to the partner making the request.
RecommendationsInsightsPartnerOpportunities_partnerOpportunitiesApplicationStatusRetrieves the current status of applied recommendations.
RecommendationsInsightsPartnerOpportunities_partnerOpportunitiesApplyApplies a given set of recommendations.
RecommendationsInsightsPartnerOpportunities_partnerOpportunitiesGetOpportunityFileGets a 307 - TEMPORARY_REDIRECT to an opportunity data file.
RecommendationsInsightsPersonaBuilder 5 tools
RecommendationsInsightsPersonaBuilder_BandedSizeGet banded size of number of unique customers that are in the input expression.
RecommendationsInsightsPersonaBuilder_DemographicsGet demographic insights for the input expression.
RecommendationsInsightsPersonaBuilder_PrimeVideoGet Prime Video insights for the input expression.
RecommendationsInsightsPersonaBuilder_TopCategoriesPurchasedGet insights on top retail categories purchased by customers in the input expression.
RecommendationsInsightsPersonaBuilder_TopOverlappingAudiencesGet top audiences overlapping with the input expression.
RecommendationsInsightsTacticalRecommendations 3 tools
RecommendationsInsightsTacticalRecommendations_ApplyRecommendationsApplies one or more recommendations.
RecommendationsInsightsTacticalRecommendations_ListRecommendationsRetrieves a paginated list of recommendations with optional filtering.
RecommendationsInsightsTacticalRecommendations_UpdateRecommendationUpdates a recommendation.
ReportingMarketingMixModeling 4 tools
ReportingMarketingMixModeling_listMmmBrandGroupsLists the predefined brand groups for which reports may be requested.
ReportingMarketingMixModeling_createMmmReportCreates a report.
ReportingMarketingMixModeling_deleteMmmReportDeletes a report by ID.
ReportingMarketingMixModeling_getMmmReportGets the generation status of a report by ID.
ReportingVersion3 3 tools
ReportingVersion3_createAsyncReportCreates a report request.
ReportingVersion3_deleteAsyncReportDeletes a report by id.
ReportingVersion3_getAsyncReportGets a generation status of a report by id.
SponsoredBrandsV3 36 tools
SponsoredBrandsV3_getBrandsGets an array of Brand data objects for the Brand associated with the profile ID passed in the header.
SponsoredBrandsV3_completeUploadThe API should be called once the media is uploaded to the location provided by the /media/upload API endpoint.
SponsoredBrandsV3_describeMediaAPI to poll for media status.
SponsoredBrandsV3_listAsinsNote that for sellers, the addresss must be a Store page.
SponsoredBrandsV3_SBGetBudgetRulesRecommendationA rule enables an automatic budget increase for a specified date range or for a special event.
SponsoredBrandsV3_listKeywordsNote: Keywords associated with BrandVideo ad groups are only available in v3.2 version.
SponsoredBrandsV3_createKeywordsNote that state can't be set at keyword creation.
SponsoredBrandsV3_updateKeywordsUpdates one or more targeting clauses.
SponsoredBrandsV3_archiveKeywordThis operation is equivalent to an update operation that sets the status field to 'archived'.
SponsoredBrandsV3_getKeywordGets a keyword specified by identifier.
SponsoredBrandsV3_listNegativeKeywordsNote: Negative keywords associated with BrandVideo ad groups are only available in v3.2 version.
SponsoredBrandsV3_createNegativeKeywordsCreates one or more negative targeting clauses.
SponsoredBrandsV3_updateNegativeKeywordsUpdates one or more targeting clauses.
SponsoredBrandsV3_archiveNegativeKeywordThis operation is equivalent to an update operation that sets the status field to 'archived'.
SponsoredBrandsV3_getNegativeKeywordGets a negative keyword specified by identifier.
SponsoredBrandsV3_createNegativeTargetsCreate one or more negative targets.
SponsoredBrandsV3_updateNegativeTargetsUpdates one or more negative targets.
SponsoredBrandsV3_listNegativeTargetsNote: Negative targets associated with BrandVideo ad groups are only available in v3.2 version.
SponsoredBrandsV3_archiveNegativeTargetArchives a negative target specified by identifier.
SponsoredBrandsV3_getNegativeTargetGets a negative target specified by identifier.
SponsoredBrandsV3_getBidsRecommendationsGet a list of bid recommendation objects for a specified list of keywords or products.
SponsoredBrandsV3_getKeywordRecommendationsGets an array of keyword recommendation objects for a set of ASINs included either on a landing page or a Stores page.
SponsoredBrandsV3_getBrandRecommendationsThe Brand suggestions are based on a list of either category identifiers or keywords passed in the request.
SponsoredBrandsV3_getTargetingCategoriesRecommendations are based on the ASINs that are passed in the request.
SponsoredBrandsV3_getProductRecommendationsRecommendations are based on the ASINs that are passed in the request.
SponsoredBrandsV3_createTargetsCreate one or more targets.
SponsoredBrandsV3_updateTargetsUpdates one or more targets.
SponsoredBrandsV3_listTargetsGets a list of product targets associated with the client identifier passed in the authorization header, filtered by specified criteria.
SponsoredBrandsV3_archiveTargetThe identifier of an existing target.
SponsoredBrandsV3_getTargetGets a target specified by identifier.
SponsoredBrandsV3_sbCreateThemesNote that this endpoint does not support for Author profiles.
SponsoredBrandsV3_sbUpdateThemesNote that this endpoint does not support for Author profiles.
SponsoredBrandsV3_sbListThemesNote that this endpoint does not support for Author profiles.
SponsoredBrandsV3_listAssetsFor sellers or vendors, gets an array of assets associated with the specified brand entity identifier.
SponsoredBrandsV3_createAssetImage assets are stored in the Store Assets Library.
SponsoredBrandsV3_downloadReportGets a 307 Temporary Redirect response that includes a location header with the value set to an AWS S3 path where the report is located.
SponsoredBrandsV4 49 tools
SponsoredBrandsV4_CreateBrandVideoCreativeThis API creates a new version of an existing creative for given Sponsored Brands Ad by supplying brand video creative content Requires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_ListCreativesThis API gets an array of all Sponsored Brands creatives that qualify the given resource identifiers and filters Requires one of these permissions:…
SponsoredBrandsV4_CreateProductCollectionCreativeThis API creates a new version of creative for given Sponsored Brands ad by supplying product collection creative content Requires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_CreateExtendedProductCollectionCreativeThis API creates a new version of creative for given Sponsored Brands ad by supplying extended product collection creative content Requires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_CreateStoreSpotlightCreativeThis API creates a new version of creative for given Sponsored Brands ad by supplying store spotlight creative content Requires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_CreateVideoCreativeThis API creates a new version of an existing creative for given Sponsored Brands ad by supplying video creative content Requires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_GetSBBudgetRulesForAdvertiserGet budget rules
SponsoredBrandsV4_CreateBudgetRulesForSBCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_UpdateBudgetRulesForSBCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_GetBudgetRuleByRuleIdForSBCampaignsRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredBrandsV4_GetCampaignsAssociatedWithSBBudgetRuleGet campaigns associated with budget rule
SponsoredBrandsV4_sbCampaignsBudgetUsageRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredBrandsV4_GetBudgetRecommendationsProvides daily budget recommendations for a list of requested Sponsored Brands campaigns, with context on estimated historical missed opportunities.
SponsoredBrandsV4_SBInsightsCampaignInsightsCreates campaign level insights.
SponsoredBrandsV4_ListAssociatedBudgetRulesForSBCampaignsRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredBrandsV4_CreateAssociatedBudgetRulesForSBCampaignsA maximum of 250 rules can be associated to a campaign.
SponsoredBrandsV4_DisassociateAssociatedBudgetRuleForSBCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredBrandsV4_SBCampaignPerformanceForecastsReturns forecasts for a list of new campaigns specified in SB forecast request.
SponsoredBrandsV4_SBTargetingGetNegativeBrandsReturns brands recommended for negative targeting.
SponsoredBrandsV4_getHeadlineRecommendationsAPI to receive creative headline suggestions.
SponsoredBrandsV4_SBOptimizationRecommendationReturns recommended bid value for optimization rule enable campaigns.
SponsoredBrandsV4_CreateSponsoredBrandsOptimizationRulesCurrently available in beta.
SponsoredBrandsV4_UpdateSponsoredBrandsOptimizationRulesCurrently available in beta.
SponsoredBrandsV4_AssociateSponsoredBrandsOptimizationRulesCurrently available in beta.
SponsoredBrandsV4_DisassociateSponsoredBrandsOptimizationRulesCurrently available in beta.
SponsoredBrandsV4_ListSponsoredBrandsOptimizationRulesCurrently available in beta.
SponsoredBrandsV4_SBTargetingGetTargetableCategoriesReturns all targetable categories by default in a list.
SponsoredBrandsV4_SBTargetingGetRefinementsForCategoryReturns refinements according to category input.
SponsoredBrandsV4_SBTargetingGetTargetableASINCountsGet number of targetable asins based on refinements provided by the user.
SponsoredBrandsV4_CreateSponsoredBrandsAdGroupsCreates Sponsored Brands ad groups.
SponsoredBrandsV4_UpdateSponsoredBrandsAdGroupsUpdates Sponsored Brands ad groups.
SponsoredBrandsV4_DeleteSponsoredBrandsAdGroupsDeletes Sponsored Brands ad groups.
SponsoredBrandsV4_ListSponsoredBrandsAdGroupsLists Sponsored Brands ad groups.
SponsoredBrandsV4_UpdateSponsoredBrandsAdsUpdates Sponsored Brands ads.
SponsoredBrandsV4_CreateSponsoredBrandsBrandVideoAdsCreates Sponsored Brands brand video ads.
SponsoredBrandsV4_DeleteSponsoredBrandsAdsDeletes Sponsored Brands ads.
SponsoredBrandsV4_ListSponsoredBrandsAdsLists Sponsored Brands ads.
SponsoredBrandsV4_CreateSponsoredBrandsProductCollectionAdsCreates Sponsored Brands product collection ads.
SponsoredBrandsV4_CreateSponsoredBrandsExtendedProductCollectionAdsCreates Sponsored Brands product collection ads with collection of custom images[1-5].
SponsoredBrandsV4_CreateSponsoredBrandStoreSpotlightAdsCreates Sponsored Brands store spotlight ads.
SponsoredBrandsV4_CreateSponsoredBrandsVideoAdsCreates Sponsored Brands video ads.
SponsoredBrandsV4_CreateSponsoredBrandsCampaignsCreates Sponsored Brands campaigns.
SponsoredBrandsV4_UpdateSponsoredBrandsCampaignsUpdates Sponsored Brands campaigns.
SponsoredBrandsV4_DeleteSponsoredBrandsCampaignsDeletes Sponsored Brands campaigns.
SponsoredBrandsV4_ListSponsoredBrandsCampaignsLists Sponsored Brands campaigns.
SponsoredBrandsV4_StartMigrationJobCreates Migration Job for V3 campaigns.
SponsoredBrandsV4_MigrationJobResultsList Migration Results of all Campaign.
SponsoredBrandsV4_MigrationJobStatusList Migration Job Status.
SponsoredBrandsV4_MigrationResultsLists all Campaign Migration results for an advertiser
SponsoredDisplay 74 tools
SponsoredDisplay_listAdGroupsGets an array of AdGroup objects for a requested set of Sponsored Display ad groups.
SponsoredDisplay_createAdGroupsCreates one or more ad groups.
SponsoredDisplay_updateAdGroupsUpdates on or more ad groups.
SponsoredDisplay_listAdGroupsExGets an array of AdGroupResponseEx objects for a set of requested ad groups.
SponsoredDisplay_getAdGroupResponseExGets extended information for a requested ad group.
SponsoredDisplay_archiveAdGroupThis operation is equivalent to an update operation that sets the status field to 'archived'.
SponsoredDisplay_getAdGroupReturns an AdGroup object for a requested campaign.
SponsoredDisplay_associateOptimizationRulesWithAdGroupWhen an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.
SponsoredDisplay_disassociateOptimizationRulesFromAdGroupOnly one optimization rule can be disassociated per adGroup.
SponsoredDisplay_deleteBrandSafetyDenyListArchives all of the domains in the Brand Safety Deny List.
SponsoredDisplay_listDomainsGets an array of websites/apps that are on the advertiser's Brand Safety Deny List.
SponsoredDisplay_createBrandSafetyDenyListDomainsCreates one or more domains to add to a Brand Safety Deny List.
SponsoredDisplay_listRequestStatusList status of all Brand Safety List requests.
SponsoredDisplay_getRequestResultsWhen a user adds domains to their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user.
SponsoredDisplay_getRequestStatusWhen a user modifies their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user.
SponsoredDisplay_GetSDBudgetRulesForAdvertiserGet all budget rules created by an advertiser
SponsoredDisplay_CreateBudgetRulesForSDCampaignsCreates one or more budget rules.
SponsoredDisplay_UpdateBudgetRulesForSDCampaignsUpdate one or more budget rules.
SponsoredDisplay_GetBudgetRuleByRuleIdForSDCampaignsGets a budget rule specified by identifier.
SponsoredDisplay_GetCampaignsAssociatedWithSDBudgetRuleGets all the campaigns associated with a budget rule
SponsoredDisplay_listCampaignsGets an array of Campaign objects for a requested set of Sponsored Display campaigns.
SponsoredDisplay_createCampaignsCreates one or more campaigns.
SponsoredDisplay_updateCampaignsUpdates one or more campaigns.
SponsoredDisplay_sdCampaignsBudgetUsageRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredDisplay_getSDBudgetRecommendationsGiven a list of campaigns as input, this API provides the following metrics: 1.
SponsoredDisplay_listCampaignsExGets an array of CampaignResponseEx objects for a set of requested campaigns.
SponsoredDisplay_getCampaignResponseExReturns a CampaignResponseEx object for a requested campaign.
SponsoredDisplay_archiveCampaignThis operation is equivalent to an update operation that sets the status field to 'archived'.
SponsoredDisplay_getCampaignReturns a Campaign object for a requested campaign.
SponsoredDisplay_ListAssociatedBudgetRulesForSDCampaignsRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredDisplay_CreateAssociatedBudgetRulesForSDCampaignsA maximum of 250 rules can be associated to a campaign.
SponsoredDisplay_DisassociateAssociatedBudgetRuleForSDCampaignsDisassociates a budget rule specified by identifier from a campaign specified by identifier.
SponsoredDisplay_listCreativesGets a list of creatives
SponsoredDisplay_createCreativesA POST request of one or more creatives.
SponsoredDisplay_updateCreativesUpdates one or more creatives.
SponsoredDisplay_postCreativePreviewGets creative preview HTML.
SponsoredDisplay_createSDForecastReturns forecasts for a given ad group specified in SD forecast request.
SponsoredDisplay_listLocationsGets a list of Sponsored Display Location objects.
SponsoredDisplay_createLocationsThis resource is not available when productAds have ASIN or SKU fields and only available for advertisers that do not sell products on Amazon.
SponsoredDisplay_archiveLocationsThis is a bulk operation that accepts up to a limit of 1000 Location Expression Ids at a time.
SponsoredDisplay_listCreativeModerationsGets a list of creative moderations
SponsoredDisplay_listNegativeTargetingClausesGets a list of negative targeting clauses objects for a requested set of Sponsored Display negative targets.
SponsoredDisplay_createNegativeTargetingClausesSuccessfully created negative targeting clauses associated with an ad group are assigned a unique target identifier.
SponsoredDisplay_updateNegativeTargetingClausesUpdates one or more negative targeting clauses.
SponsoredDisplay_listNegativeTargetingClausesExGets an array of NegativeTargetingClauseEx objects for a set of requested negative targets.
SponsoredDisplay_getNegativeTargetsExGets a negative targeting clause with extended fields.
SponsoredDisplay_archiveNegativeTargetingClauseEquivalent to using the updateNegativeTargetingClauses operation to set the state property of a targeting clause to archived.
SponsoredDisplay_getNegativeTargetsThis call returns the minimal set of negative targeting clause fields, but is more efficient than getNegativeTargetsEx.
SponsoredDisplay_listOptimizationRulesGets an array of OptimizationRule objects for a requested set of Sponsored Display optimization rules.
SponsoredDisplay_createOptimizationRulesWhen an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.
SponsoredDisplay_updateOptimizationRulesUpdates one or more optimization rules.
SponsoredDisplay_listProductAdsGets an array of ProductAd objects for a requested set of Sponsored Display product ads.
SponsoredDisplay_createProductAdsCreates one or more product ads.
SponsoredDisplay_updateProductAdsUpdates one or more product ads.
SponsoredDisplay_listProductAdsExGets an array of ProductAdResponseEx objects for a set of requested ad groups.
SponsoredDisplay_getProductAdResponseExGets extended information for a product ad.
SponsoredDisplay_archiveProductAdThis operation is equivalent to an update operation that sets the status field to 'archived'.
SponsoredDisplay_getProductAdNote that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size.
SponsoredDisplay_getHeadlineRecommendationsForSDYou can use this Sponsored Display API to retrieve creative headline recommendations from an array of ASINs.
SponsoredDisplay_getSnapshotNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
SponsoredDisplay_downloadSnapshotNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
SponsoredDisplay_listTargetingClausesGets a list of targeting clauses objects for a requested set of Sponsored Display targets.
SponsoredDisplay_createTargetingClausesSuccessfully created targeting clauses are assigned a unique targetId value.
SponsoredDisplay_updateTargetingClausesUpdates one or more targeting clauses.
SponsoredDisplay_getTargetBidRecommendationsProvides a list of bid recommendations based on the list of input advertised ASINs and targeting clauses in the same format as the targeting API.
SponsoredDisplay_listTargetingClausesExGets an array of TargetingClauseEx objects for a set of requested targets.
SponsoredDisplay_getTargetsExGets a targeting clause object with extended fields.
SponsoredDisplay_getTargetRecommendationsThis API provides product, category and standard audience recommendations to target based on the list of input ASINs.
SponsoredDisplay_archiveTargetingClauseEquivalent to using the updateTargetingClauses operation to set the state property of a targeting clause to archived.
SponsoredDisplay_getTargetsThis call returns the minimal set of targeting clause fields.
SponsoredDisplay_requestReportTo understand the call flow for asynchronous reports, see Getting started with sponsored ads reports.
SponsoredDisplay_createSnapshotNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
SponsoredDisplay_getReportStatusUses the reportId value from the response of a report previously requested via POST method of the /sd/{recordType}/report operation.
SponsoredDisplay_downloadReportGets a 307 Temporary Redirect response that includes a location header with the value set to an AWS S3 path where the report is located.
SponsoredProducts 79 tools
SponsoredProducts_CreateSponsoredProductsAdGroupsCreate ad groups Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsAdGroupsUpdate ad groups Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsAdGroupsDelete ad groups Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsAdGroupsList ad groups Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_GetSPBudgetRulesForAdvertiserGet all budget rules created by an advertiser
SponsoredProducts_CreateBudgetRulesForSPCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_UpdateBudgetRulesForSPCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_GetBudgetRuleByRuleIdForSPCampaignsAuthorized resource type: Global Ad Account ID, Profile ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions:…
SponsoredProducts_GetCampaignsAssociatedWithSPBudgetRuleGets all the campaigns associated with a budget rule
SponsoredProducts_BulkBudgetRulesAssociationForSPA maximum of 250 rules can be associated to a campaign.
SponsoredProducts_BulkBudgetRulesDisAssociationForSPRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_getCampaignRecommendationsGets the top consolidated recommendations across bid, budget, targeting for SP campaigns given an advertiser profile id.
SponsoredProducts_CreateSponsoredProductsCampaignNegativeKeywordsCreate campaign negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsCampaignNegativeKeywordsUpdate campaign negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsCampaignNegativeKeywordsDelete campaign negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsCampaignNegativeKeywordsList campaign negative keywords Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateSponsoredProductsCampaignNegativeTargetingClausesCreate campaign negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsCampaignNegativeTargetingClausesUpdate campaign negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsCampaignNegativeTargetingClausesDelete campaign negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsCampaignNegativeTargetingClausesList campaign negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateSponsoredProductsCampaignsCreate campaigns Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsCampaignsUpdate campaigns Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_spCampaignsBudgetUsageRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_getBudgetRecommendationsGiven a list of campaigns as input, this API provides the following metrics - 1.
SponsoredProducts_SPGetBudgetRulesRecommendationA rule enables an automatic budget increase for a specified date range or for a special event.
SponsoredProducts_DeleteSponsoredProductsCampaignsDelete campaigns Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_getBudgetRecommendationCreates daily budget recommendation along with benchmark metrics when creating a new campaign.
SponsoredProducts_ListSponsoredProductsCampaignsList campaigns Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_ListAssociatedBudgetRulesForSPCampaignsAuthorized resource type: Global Ad Account ID, Profile ID Parameter name: Amazon-Ads-AccountId Parameter in: header Requires one of these permissions:…
SponsoredProducts_CreateAssociatedBudgetRulesForSPCampaignsA maximum of 250 rules can be associated to a campaign.
SponsoredProducts_DisassociateAssociatedBudgetRuleForSPCampaignsRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_AssociateOptimizationRulesToCampaignRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_GetMultiCountryThemeBasedBidRecommendationForAdGroup_v1The POST /sp/targets/bid/recommendations endpoint returns recommended bids for each target given either A) new ad group (a list of ad ASINs) or B) existing ad group (a campaign ID and ad grou...
SponsoredProducts_getGlobalRankedKeywordRecommendationThe POST /sp/global/targets/keywords/recommendations/list endpoint returns recommended keyword targets for a list of countries given either A) a list of ad ASINs per target country or B) a gl...
SponsoredProducts_CreateSponsoredProductsKeywordsCreate keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsKeywordsUpdate keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsKeywordsDelete keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsKeywordsList keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_CreateSponsoredProductsNegativeKeywordsCreate negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsNegativeKeywordsUpdate negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsNegativeKeywordsDelete negative keywords Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsNegativeKeywordsList negative keywords Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateSponsoredProductsNegativeTargetingClausesCreate negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsNegativeTargetingClausesUpdate negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_getNegativeBrandsReturns brands recommended for negative targeting.
SponsoredProducts_searchBrandsReturns up to 100 brands related to keyword input for negative targeting.
SponsoredProducts_DeleteSponsoredProductsNegativeTargetingClausesDelete negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsNegativeTargetingClausesList negative targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateSponsoredProductsProductAdsCreate product ads Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsProductAdsUpdate product ads Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_DeleteSponsoredProductsProductAdsDelete product ads Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_ListSponsoredProductsProductAdsList product ads Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateOptimizationRuleRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_UpdateOptimizationRuleRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_GetOptimizationRuleEligibilityRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_GetRuleNotificationRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_DeleteCampaignOptimizationRuleRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_GetCampaignOptimizationRuleRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateOptimizationRulesRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_UpdateOptimizationRulesRequires one of these permissions: ["advertiser_campaign_edit"]
SponsoredProducts_SearchOptimizationRulesRequires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_CreateTargetPromotionGroupsCreates a target promotion group, by grouping the auto-targeting adGroupId and manual-targeting adGroups, divided by keyword targeting adGroups, and product targeting adGroups.
SponsoredProducts_ListTargetPromotionGroupsReturns the target promotion groups for an advertiser and / or adGroupId, and / or target promotion group id.
SponsoredProducts_GetTargetPromotionGroupsRecommendationsRetrieves keyword and product targets of an auto-targeting campaign as recommendations for promoting to a manual-targeting campaign.
SponsoredProducts_CreateTargetPromotionGroupTargetsCreates keyword and/or product targets in the manual adGroup that are part of the target promotion group Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
SponsoredProducts_ListTargetPromotionGroupTargetsReturns the targets created through target promotion groups for an advertiser and / or given target promotion group.
SponsoredProducts_getKeywordGroupRecommendationsThis API (currently beta) recommends Keyword Group targets for a given list of Ad ASINs.
SponsoredProducts_CreateSponsoredProductsTargetingClausesCreate targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_UpdateSponsoredProductsTargetingClausesUpdate targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_GetThemeBasedBidRecommendationForAdGroup_v1The POST /sp/targets/bid/recommendations endpoint returns recommended bids for each target given either A) new ad group (a list of ad ASINs) or B) existing ad group (a campaign ID and ad grou...
SponsoredProducts_getTargetableCategoriesReturns all targetable categories.
SponsoredProducts_getCategoryRecommendationsForASINsReturns a list of category recommendations for the input list of ASINs.
SponsoredProducts_getRefinementsForCategoryReturns refinements according to category input.
SponsoredProducts_DeleteSponsoredProductsTargetingClausesDelete targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_getRankedKeywordRecommendationThe POST /sp/targets/keywords/recommendations endpoint returns recommended keyword targets given either A) a list of ad ASINs or B) a campaign ID and ad group ID.
SponsoredProducts_ListSponsoredProductsTargetingClausesList targeting clauses Requires one of these permissions: ["advertiser_campaign_edit","campaign_proposed"]
SponsoredProducts_getTargetableASINCountsGet number of targetable asins based on refinements provided by the user.
SponsoredProducts_getProductRecommendationsGiven an advertised ASIN as input, this API returns suggested ASINs to target in a product targeting campaign.
SponsoredProducts_SPGetAllRuleEventsA rule enables an automatic budget increase for a specified date range or for a special event.
SPSnapshotsSuggestedKeywords 11 tools
SPSnapshotsSuggestedKeywords_getAdGroupBidRecommendationsDeprecation notice: This endpoint will be deprecated on March 27, 2024.
SPSnapshotsSuggestedKeywords_getAdGroupSuggestedKeywordsGets suggested keywords for the specified ad group.
SPSnapshotsSuggestedKeywords_getAdGroupSuggestedKeywordsExGets suggested keywords with extended data for the specified ad group.
SPSnapshotsSuggestedKeywords_bulkGetAsinSuggestedKeywordsSuggested keywords are returned in an array ordered by descending effectiveness.
SPSnapshotsSuggestedKeywords_getAsinSuggestedKeywordsSuggested keywords are returned in an array ordered by descending effectiveness.
SPSnapshotsSuggestedKeywords_createKeywordBidRecommendationsDeprecation notice: This endpoint will be deprecated on March 27, 2024.
SPSnapshotsSuggestedKeywords_getKeywordBidRecommendationsDeprecation notice: This endpoint will be deprecated on March 27, 2024.
SPSnapshotsSuggestedKeywords_getSnapshotStatusNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
SPSnapshotsSuggestedKeywords_downloadSnapshotNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
SPSnapshotsSuggestedKeywords_getBidRecommendationsGets a list of bid recommendations for keyword, product, or auto targeting expressions.
SPSnapshotsSuggestedKeywords_requestSnapshotNote: Snapshots APIs are deprecated and will be shut off on October 15, 2024.
StoresAnalytics 2 tools
StoresAnalytics_getAsinEngagementForStoreStore asin metrics provides information about your store asin performance, including rendered impressions, viewed impressions, clicks and sales.
StoresAnalytics_getInsightsForStoreAPIStores insights provides information about your store's performance, including traffic and sales.
TestAccount 2 tools
TestAccount_GetAccountInformationAPI to get Account information.
TestAccount_createAccountSubmit a account creation request.
UnifiedPreModerationResults 1 tools
UnifiedPreModerationResults_preModerationThis API will be accepting different components of the ad/page and will be automatically validating the components and send back the policy violations if any.