cedricziel / amznsponsoredproductsapiphp
Amazon Sponsored Products API 的 API 客户端
Requires
- php: ^8.3
- jane-php/open-api-runtime: ^7.8
- nyholm/psr7: ^1.8
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.59
- jane-php/jane-php: dev-vnd-plus-json as 7.8.0
README
Amazon Sponsored Products API 的 API 客户端。
composer require cedricziel/amznsponsoredproductsapiphp
文档
通用
实例化客户端,配置您的密钥并继续使用
use CedricZiel\AmznSponsoredProductsApiPHP\Endpoint; use CedricZiel\AmznSponsoredProductsApiPHP\Generated\Model\SponsoredProductsListSponsoredProductsCampaignsRequestContent; use CedricZiel\AmznSponsoredProductsApiPHP\Header; use CedricZiel\AmznSponsoredProductsApiPHP\SponsoredProductsApiClient; // You need to obtain a token via the Amazon LwA workflow $accessToken = '...'; $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); // execute the endpoint of choice, see below ... $body = new SponsoredProductsListSponsoredProductsCampaignsRequestContent(); $res = $client->listSponsoredProductsCampaigns($body, [ Header::AmazonAdvertisingApiClientId->value => '...', Header::AmazonAdvertisingApiScope->value => '...', ]);
GetThemeBasedBidRecommendationForAdGroup_v1 - post /sp/targets/bid/recommendations
获取广告组的出价建议。此 API 目前在提供 SP 的市场中可用。该 API 支持关键词、自动和产品目标。当提供不支持的市场或目标时,API 将返回 422 响应。
版本 4.0
新特性
版本 4.0 允许用户获取针对产品目标表达式(包括 PAT_ASIN、PAT_CATEGORY 和 PAT_CATEGORY_REFINEMENT)的主题出价建议。版本 4.0 在所有市场中都支持关键词、自动和产品目标。版本 4.0 在返回每个出价建议时移除了“影响指标”。版本 4.0 还允许用户获取针对类型为 KEYWORD_GROUP 的关键词组目标表达式(主题出价建议)。此新类型仅在 US 市场可用。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getThemeBasedBidRecommendationForAdGroupV1();
getRankedKeywordRecommendation - post /sp/targets/keywords/recommendations
获取关键词建议 POST /sp/targets/keywords/recommendations 端点返回根据 A) 一系列广告 ASIN 或 B) 营销活动 ID 和广告组 ID 提供的推荐关键词目标。请使用 recommendationType 字段指定您想使用选项 A 或选项 B。此端点还将返回与每个推荐关键词目标一起的推荐出价。
排名
关键词建议将按用户提供的 sortDimension 字段的点击量或展示量降序排列。您还可以通过使用 targets 数组将您自己的关键词目标输入到与关键词建议一起排名。
本地化
使用 locale 字段获取您指定地区的关键词。可以在 POST /keywords/localize 端点找到受支持的市场到地区的映射。
版本 5.0
新特性
版本 5.0 使用新主题出价建议,可以在 /sp/targets/bid/recommendations 端点检索,为每个关键词提供改进的出价建议。主题出价建议提供“主题”和“影响指标”,以帮助您选择适合关键词目标的最合适的出价。主题
现在可以为每个关键词目标返回多个出价建议。每个建议将有一个主题来表示出价的商业目标。可用的主题有:
- CONVERSION_OPPORTUNITIES - 默认主题,旨在最大化转换数量。
- SPECIAL_DAYS - 可用于像 Prime Day 这样的高销量活动期间的主题,以预期销售和竞争的增加。
我们已经添加了影响指标,它提供了有关在特定出价下针对关键词所获得的点击量和转换量的洞察。
出价策略
您现在可以在KEYWORDS_BY_ASINS请求中指定您的出价策略,以获取针对您的出价策略定制的出价建议。对于KEYWORDS_BY_ADGROUP请求,您无需指定出价策略,因为将使用广告组的出价策略。三种出价策略如下
- LEGACY_FOR_SALES - 动态出价(仅降价)
- AUTO_FOR_SALES - 动态出价(升降)
- MANUAL - 固定出价
可用性
版本5.0仅在以下市场提供:美国、加拿大、英国、德国、法国、西班牙、印度、日本。版本 4.0
新功能
版本4.0允许用户检索按点击或转化量降序排列的推荐关键词目标。默认排序维度,如未指定,则按我们内部排名机制排序。我们还添加了搜索词指标。《搜索词展示份额》表示在过去30天内,您在特定关键词上收到的所有广告归因展示的百分比份额。此指标帮助广告商根据其在相关关键词上的份额识别潜在机会。《搜索词展示排名》表示您在市场中的所有广告商中按广告展示量在关键词上的排名。它告诉广告商有多少广告商的出价份额更高。搜索词信息仅适用于广告商通过广告展示量指定的关键词。可用性
版本4.0在所有市场提供。需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getRankedKeywordRecommendation();
ListSponsoredProductsKeywords - post /sp/keywords/list
列出关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsKeywords();
DeleteSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/delete
删除负面关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsNegativeKeywords();
getTargetableASINCounts - post /sp/targets/products/count
根据用户提供的细化信息获取可目标化的ASIN数量。根据用户提供的细化信息获取可目标化的ASIN数量。请使用GetTargetableCategories API或GetCategoryRecommendationsForASINs API检索类别ID。请使用GetRefinementsByCategory API检索类别细化数据。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getTargetableASINCounts();
getTargetableCategories - get /sp/targets/categories
返回所有可目标化类别。返回所有可目标化类别。此API返回一个包含类别节点树的JSON字符串。每个类别节点都有类别ID、类别名称和子类别字段。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getTargetableCategories();
CreateOptimizationRule - post /sp/rules/campaignOptimization
创建广告活动优化规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createOptimizationRule();
UpdateOptimizationRule - put /sp/rules/campaignOptimization
更新广告活动优化规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateOptimizationRule();
CreateAssociatedBudgetRulesForSPCampaigns - post /sp/campaigns/{campaignId}/budgetRules
将一个或多个预算规则关联到由标识符指定的广告活动。每个广告活动最多可关联250个规则。请注意,与广告活动关联的每个规则名称都必须是唯一的。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createAssociatedBudgetRulesForSPCampaigns();
ListAssociatedBudgetRulesForSPCampaigns - get /sp/campaigns/{campaignId}/budgetRules
获取由标识符指定的广告活动关联的预算规则列表。
授权资源类型:全球广告账户ID,配置文件ID
参数名称:Amazon-Ads-AccountId
参数位置:header
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listAssociatedBudgetRulesForSPCampaigns();
searchBrands - post /sp/negativeTargets/brands/search
返回与负面定位输入相关的关键词品牌。返回最多100个与负面定位输入相关的关键词品牌。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->searchBrands();
getRefinementsForCategory - get /sp/targets/category/{categoryId}/refinements
根据类别输入返回细化信息。根据类别输入返回细化信息。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getRefinementsForCategory();
GetRuleNotification - post /sp/rules/campaignOptimization/state
获取广告活动优化规则状态。建议刷新频率为每天一次。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getRuleNotification();
ListTargetPromotionGroups - post /sp/targetPromotionGroups/list
返回广告商的目标促销组,以及/或adGroupId,以及/或目标促销组id。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listTargetPromotionGroups();
ListSponsoredProductsProductAds - post /sp/productAds/list
列出产品广告
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsProductAds();
CreateOptimizationRules - post /sp/rules/optimization
创建一个或多个优化规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createOptimizationRules();
UpdateOptimizationRules - put /sp/rules/optimization
更新一个或多个优化规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateOptimizationRules();
CreateTargetPromotionGroups - post /sp/targetPromotionGroups
通过将自动定位adGroupId和手动定位adGroups分组,以及通过关键词定位adGroups和产品定位adGroups来创建一个目标促销组。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createTargetPromotionGroups();
CreateTargetPromotionGroupTargets - post /sp/targetPromotionGroups/targets
在目标促销组中创建关键词和/或产品目标,这些目标是手动adGroup的一部分
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createTargetPromotionGroupTargets();
ListSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/list
列出负面定位条款
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsNegativeTargetingClauses();
getKeywordGroupRecommendations - post /sp/targeting/recommendations/keywordGroups
此API(目前处于测试版)为给定的广告ASIN列表推荐关键词组目标。关键词组是亚马逊广告赞助产品基于关键词的活动的新的控制功能,使广告商能够通过一组关键词接触相关受众。
一旦创建关键词组规范,关键词组的表现将在搜索词报告中可用。关键词组通过在活动生命周期内动态更新组内的关键词来提高活动性能,并消除了广告商需要不断管理新关键词的需求。此外,关键词组可以与同一广告组内的关键词一起使用。
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getKeywordGroupRecommendations();
CreateSponsoredProductsProductAds - post /sp/productAds
创建产品广告
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsProductAds();
UpdateSponsoredProductsProductAds - put /sp/productAds
更新产品广告
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsProductAds();
CreateBudgetRulesForSPCampaigns - post /sp/budgetRules
创建一个或多个预算规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createBudgetRulesForSPCampaigns();
GetSPBudgetRulesForAdvertiser - get /sp/budgetRules
获取广告商创建的所有预算规则
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getSPBudgetRulesForAdvertiser();
UpdateBudgetRulesForSPCampaigns - put /sp/budgetRules
更新一个或多个预算规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateBudgetRulesForSPCampaigns();
getCategoryRecommendationsForASINs - post /sp/targets/categories/recommendations
返回输入列表ASINs的类别推荐列表。使用此API发现相关类别以进行定位。要查找ASIN,请使用产品元数据API或浏览亚马逊零售网站。
- 可以通过接受头部请求不同的版本。请查看响应媒体类型以获取更多信息。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getCategoryRecommendationsForASINs();
GetTargetPromotionGroupsRecommendations - post /sp/targetPromotionGroups/recommendations
检索自动定位活动的关键词和产品目标,作为推广到手动定位活动的推荐。这些推荐基于目标性能启发式。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getTargetPromotionGroupsRecommendations();
getBudgetRecommendation - post /sp/campaigns/initialBudgetRecommendation
在创建新活动时创建每日预算推荐以及基准指标。
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getBudgetRecommendation();
DeleteSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets/delete
删除活动负面定位条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsCampaignNegativeTargetingClauses();
DeleteSponsoredProductsProductAds - post /sp/productAds/delete
删除产品广告
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsProductAds();
getNegativeBrands - get /sp/negativeTargets/brands/recommendations
返回推荐的负面定位品牌。这些推荐包括您的品牌,因为针对自己的品牌通常会导致性能低于针对竞争对手的品牌。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getNegativeBrands();
getBudgetRecommendations - post /sp/campaigns/budgetRecommendations
获取推荐每日预算和估计的错失机会。给定活动列表作为输入,此API提供以下指标-
1. 推荐每日预算 - 估计每天全24小时内保持活动在预算内的每日所需预算。考虑此每日预算以最大限度地减少活动耗尽预算的机会。
2. 预算时间百分比 - 实际平均百分比,该活动在响应中指定的开始和结束日期之间在预算内。注意:值-1表示我们没有足够的信息来计算活动的预算时间百分比。
3. 预计错过的影响、点击和销售 - 这些是估计的额外曝光、点击和销售范围,如果活动在指定响应的起始和结束日期期间100%处于预算内,则可能产生。这些是根据历史流量和活动的过往表现(例如,曝光和点击量)进行的估计,但不保证。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getBudgetRecommendations();
创建推广产品否定目标条款 - post /sp/negativeTargets
创建否定目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsNegativeTargetingClauses();
更新推广产品否定目标条款 - put /sp/negativeTargets
更新否定目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsNegativeTargetingClauses();
创建推广产品目标条款 - post /sp/targets
创建目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsTargetingClauses();
更新推广产品目标条款 - put /sp/targets
更新目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsTargetingClauses();
SPGetBudgetRulesRecommendation - post /sp/campaigns/budgetRules/recommendations
获取指定标识符的活动的建议日期范围和建议预算增加的特别事件列表。规则可以启用指定日期范围或特别事件的自动预算增加。响应还包括每个特别事件的建议预算增加。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->sPGetBudgetRulesRecommendation();
创建推广产品活动否定目标条款 - post /sp/campaignNegativeTargets
创建活动否定目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsCampaignNegativeTargetingClauses();
更新推广产品活动否定目标条款 - put /sp/campaignNegativeTargets
更新活动否定目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsCampaignNegativeTargetingClauses();
创建推广产品关键词 - post /sp/keywords
创建关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsKeywords();
更新推广产品关键词 - put /sp/keywords
更新关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsKeywords();
列出推广产品活动否定目标条款 - post /sp/campaignNegativeTargets/list
列出活动否定目标条款
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsCampaignNegativeTargetingClauses();
删除推广产品目标条款 - post /sp/targets/delete
删除目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsTargetingClauses();
SearchOptimizationRules - post /sp/rules/optimization/search
基于可选过滤器搜索优化规则。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->searchOptimizationRules();
创建推广产品活动 - post /sp/campaigns
创建活动
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsCampaigns();
更新推广产品活动 - put /sp/campaigns
更新活动
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsCampaigns();
列出推广产品广告组 - post /sp/adGroups/list
列出广告组
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsAdGroups();
删除推广产品广告组 - post /sp/adGroups/delete
删除广告组
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsAdGroups();
getCampaignRecommendations - get /sp/campaign/recommendations
获取给定广告商配置文件ID的SP活动的最高整合推荐,包括出价、预算、定位。这些推荐每天都会刷新。
需要以下权限之一:["advertiser_campaign_view","advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getCampaignRecommendations();
删除推广产品活动否定关键词 - post /sp/campaignNegativeKeywords/delete
删除活动否定关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsCampaignNegativeKeywords();
AssociateOptimizationRulesToCampaign - post /sp/campaigns/{campaignId}/optimizationRules
将一个或多个优化规则与活动关联。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->associateOptimizationRulesToCampaign();
列出推广产品活动否定关键词 - post /sp/campaignNegativeKeywords/list
列出活动否定关键词
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsCampaignNegativeKeywords();
删除推广产品活动 - post /sp/campaigns/delete
删除活动
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsCampaigns();
列出推广产品活动 - post /sp/campaigns/list
列出活动
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsCampaigns();
GetCampaignsAssociatedWithSPBudgetRule - get /sp/budgetRules/{budgetRuleId}/campaigns
获取与预算规则关联的所有活动
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getCampaignsAssociatedWithSPBudgetRule();
DisassociateAssociatedBudgetRuleForSPCampaigns - delete /sp/campaigns/{campaignId}/budgetRules/{budgetRuleId}
从指定标识符的活动删除指定的预算规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->disassociateAssociatedBudgetRuleForSPCampaigns();
创建推广产品广告组 - post /sp/adGroups
创建广告组
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsAdGroups();
更新推广产品广告组 - put /sp/adGroups
更新广告组
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsAdGroups();
getProductRecommendations - post /sp/targets/products/recommendations
给定一个推广的ASIN作为输入,此API返回在产品定位活动中要定位的建议ASIN。我们使用各种方法生成这些建议。这包括使用您广告的历史表现、购物者经常一起查看和购买的项目等。建议的目标可以检索为单个列表,或按“主题”分组 - 即推荐项目的原因的伴随背景。您可以使用Accepts标头选择所需的格式,请参阅响应mediaTypes获取更多信息。
分页行为
该API支持使用编码的游标值进行基于游标的分页,以返回下一组记录或之前服务的记录。请求体中的count参数将用于在请求上一页或下一页时确定结果的大小。如果在请求中未提供count值,则假定默认值。请参考GetProductRecommendationsRequest请求模式下的范围和默认值。注意:客户端不应本地缓存分页游标值,因为这些值将在一定时间后过期。然而,在值未过期的情况下,可以重复使用游标值进行重试,以处理失败情况。
主题
主题为我们推荐产品作为目标提供额外的上下文。以下是当前可用的主题列表:顶级转化目标 – 在过去30天内为输入ASIN生成转化率的ASIN(例如,您的产品在这些物品的详情页面上作为广告出现,购物者点击并购买了您的产品)。此主题下的建议ASIN按为您推广的项目产生的销售量降序排列。
相似商品(经常一起查看) – 在购物过程中,购物者经常与您的广告商品一起查看和点击的商品。
互补商品 – 经常一起购买作为互补的商品。例如,如果您正在推广网球拍,您可能会看到网球在这种主题下被推荐。
低评分和评论的相似商品 – 包含评分低于3星或评论少于5条的“相似商品”主题的子集。
读者阅读的其他书籍 – 在购物过程中,购物者经常与您的广告商品一起查看和点击的商品。
注意:主题的可用性因输入ASIN而异 - 一些ASIN可能没有上述所有主题都可用。
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getProductRecommendations();
DeleteSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/delete
删除否定目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsNegativeTargetingClauses();
DeleteSponsoredProductsKeywords - post /sp/keywords/delete
删除关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteSponsoredProductsKeywords();
GetOptimizationRuleEligibility - post /sp/rules/campaignOptimization/eligibility
获取SP活动的优化规则推荐。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getOptimizationRuleEligibility();
GetBudgetRuleByRuleIdForSPCampaigns - get /sp/budgetRules/{budgetRuleId}
获取指定标识符的预算规则。
授权资源类型:全球广告账户ID,配置文件ID
参数名称:Amazon-Ads-AccountId
参数位置:header
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getBudgetRuleByRuleIdForSPCampaigns();
GetCampaignOptimizationRule - get /sp/rules/campaignOptimization/{campaignOptimizationId}
获取指定标识符的营销活动优化规则。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getCampaignOptimizationRule();
DeleteCampaignOptimizationRule - delete /sp/rules/campaignOptimization/{campaignOptimizationId}
删除指定标识符的营销活动优化规则。
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->deleteCampaignOptimizationRule();
CreateSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords
创建营销活动否定关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsCampaignNegativeKeywords();
UpdateSponsoredProductsCampaignNegativeKeywords - put /sp/campaignNegativeKeywords
更新营销活动否定关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsCampaignNegativeKeywords();
ListTargetPromotionGroupTargets - post /sp/targetPromotionGroups/targets/list
返回通过目标促销组创建的广告商和/或指定目标促销组的目标。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listTargetPromotionGroupTargets();
ListSponsoredProductsTargetingClauses - post /sp/targets/list
列出目标条款
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsTargetingClauses();
ListSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/list
列出否定关键词
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->listSponsoredProductsNegativeKeywords();
getGlobalRankedKeywordRecommendation - post /sp/global/targets/keywords/recommendations/list
获取全球关键词推荐 POST /sp/global/targets/keywords/recommendations/list 端点返回针对给定A)目标国家每个广告ASIN的列表或B)全球活动ID和广告组ID的列表的推荐关键词目标。请使用recommendationType字段指定您想要使用选项A还是选项B。此端点还将返回与每个推荐关键词目标一起的推荐出价。
CountryCodes
全局API端点接受countryCodes字典。键是2位字母的国家代码。值是一个包含两个数组asins和targets的对象。每个国家将根据版本5推荐API的规则并行处理。
可用性
全局关键词推荐API在所有市场都可用。// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->getGlobalRankedKeywordRecommendation();
CreateSponsoredProductsNegativeKeywords - post /sp/negativeKeywords
创建负面关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->createSponsoredProductsNegativeKeywords();
UpdateSponsoredProductsNegativeKeywords - put /sp/negativeKeywords
更新负面关键词
需要以下权限之一:["advertiser_campaign_edit"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->updateSponsoredProductsNegativeKeywords();
spCampaignsBudgetUsage - post /sp/campaigns/budget/usage
SP活动预算使用API
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->spCampaignsBudgetUsage();
SPGetAllRuleEvents - post /sp/v1/events
获取广告商市场中的所有特殊个体和分组事件,包括建议的日期范围。一条规则允许在指定日期范围或特殊事件中自动增加预算。响应包括每个特殊事件的建议日期范围。
需要以下权限之一:["advertiser_campaign_edit","advertiser_campaign_view"]
// see above how to create a client $client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken); $client->sPGetAllRuleEvents();
许可证
Apache 2.0