PHPackages                             cedricziel/amznsponsoredproductsapiphp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. cedricziel/amznsponsoredproductsapiphp

ActiveLibrary[API Development](/categories/api)

cedricziel/amznsponsoredproductsapiphp
======================================

An API client for the Amazon Sponsored Products API

v1.3.5(1y ago)0247[5 PRs](https://github.com/cedricziel/amzn-sponsored-products-api-php/pulls)MITPHPPHP ^8.3CI passing

Since Jul 14Pushed 6mo ago1 watchersCompare

[ Source](https://github.com/cedricziel/amzn-sponsored-products-api-php)[ Packagist](https://packagist.org/packages/cedricziel/amznsponsoredproductsapiphp)[ GitHub Sponsors](https://github.com/cedricziel)[ RSS](/packages/cedricziel-amznsponsoredproductsapiphp/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (10)Dependencies (4)Versions (16)Used By (0)

amzn-sponsored-products-api-php
===============================

[](#amzn-sponsored-products-api-php)

An API client for the Amazon Sponsored Products API.

```
composer require cedricziel/amznsponsoredproductsapiphp
```

Docs
----

[](#docs)

### General

[](#general)

Instantiate a client, configure your secrets and continue to use:

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

[](#getthemebasedbidrecommendationforadgroup_v1---post-sptargetsbidrecommendations)

Get bid recommendations for ad groups This API is currently available at marketplaces where SP is available. The API supports keyword, auto and product targets. The API will return a 422 response when an unsupported marketplace or target is provided.

 Version 4.0
=============

[](#-version-40-)

 New Features
--------------

[](#-new-features-)

 Version 4.0 allows users to get theme-based bid recommendations for product targeting expressions, including PAT\_ASIN, PAT\_CATEGORY and PAT\_CATEGORY\_REFINEMENT. Version 4.0 supports keyword, auto and product targets in all marketplaces. Version 4.0 removes "impact metrics" when returning each bid suggestion.
 Version 4.0 also allows users to get theme-based bid recommendations for keyword group targeting expressions with the type KEYWORD\_GROUP. This new type is only available in US marketplace.
**Requires one of these permissions**: \["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

[](#getrankedkeywordrecommendation---post-sptargetskeywordsrecommendations)

Get keyword recommendations The  **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. Please use the recommendationType field to specify if you want to use option A or option B. This endpoint will also return recommended bids along with each recommendation keyword target.

  **Ranking**
 The keyword recommendations will be ranked in descending order of clicks or impressions, depending on the **sortDimension** field provided by the user. You may also input your own keyword targets to be ranked alongside the keyword recommendations by using the **targets** array.

  **Localization**
 Use the  **locale**  field to get keywords in your specified locale. Supported marketplace to locale mappings can be found at the [POST /keywords/localize](https://advertising.amazon.com/API/docs/en-us/localization/#/Keyword%20Localization) endpoint.

 Version 5.0
=============

[](#-version-50-)

 New Features
--------------

[](#-new-features--1)

 Version 5.0 utilizes the new theme-based bid recommendations, which can be retrieved at the endpoint **/sp/targets/bid/recommendations**, to return improved bid recommendations for each keyword. Theme-based bid recommendations provide \\"themes\\" and \\"impact metrics\\" along with each bid suggestion to help you choose the right bid for your keyword target.

**Themes**
 We now may return multiple bid suggestions for each keyword target. Each suggestion will have a theme to express the business objective of the bid. Available themes are: - CONVERSION\_OPPORTUNITIES - The default theme which aims to maximize number of conversions.
- SPECIAL\_DAYS - A theme available during high sales events such as Prime Day, to anticipate an increase in sales and competition.

**Impact Metrics**
We have added impact metrics which provide insight on the number of clicks and conversions you will receive for targeting a keyword at a certain bid.

**Bidding Strategy**
 You may now specify your bidding strategy in the KEYWORDS\_BY\_ASINS request to get bid suggestions tailored to your bidding strategy. For KEYWORDS\_BY\_ADGROUP requests, you will not specify a bidding strategy, because the bidding strategy of the ad group is used. The three bidding strategies are: - LEGACY\_FOR\_SALES - Dynamic bids (down only)
- AUTO\_FOR\_SALES - Dynamic bids (up and down)
- MANUAL - Fixed bids

###  Availability

[](#-availability-)

 Version 5.0 is only available in the following marketplaces: US, CA, UK, DE, FR, ES, IN, JP.  Version 4.0
=============

[](#-version-40--1)

 New features
--------------

[](#-new-features--2)

 Version 4.0 allows users to retrieve recommended keyword targets which are sorted in descending order of clicks or conversions. The default sort dimension, if not specified, ranks recommendations by our interal ranking mechanism. We have also added search term metrics.  **Search term impression share**  indicates the percentage share of all ad-attributed impressions you received on that keyword in the last 30 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords.  **Search term impression rank**  indicates your ranking among all advertisers for the keyword by ad impressions in a marketplace. It tells an advertiser how many advertisers had higher share of ad impressions.  *Search term information is only available for keywords the advertiser targeted with ad impressions.* ###  Availability

[](#-availability--1)

 Version 4.0 is available in all marketplaces.**Requires one of these permissions**: \["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

[](#listsponsoredproductskeywords---post-spkeywordslist)

List keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->listSponsoredProductsKeywords();
```

### DeleteSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/delete

[](#deletesponsoredproductsnegativekeywords---post-spnegativekeywordsdelete)

Delete negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsNegativeKeywords();
```

### getTargetableASINCounts - post /sp/targets/products/count

[](#gettargetableasincounts---post-sptargetsproductscount)

Get number of targetable asins based on refinements provided by the user. Get number of targetable asins based on refinements provided by the user. Please use the GetTargetableCategories API or the GetCategoryRecommendationsForASINs API to retrieve the category ID. Please use the GetRefinementsByCategory API to retrieve refinements data for a category.

**Requires one of these permissions**: \["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

[](#gettargetablecategories---get-sptargetscategories)

Returns all targetable categories. Returns all targetable categories. This API returns a large JSON string containing a tree of category nodes. Each category node has the fields - category id, category name, and child categories.

**Requires one of these permissions**: \["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

[](#createoptimizationrule---post-sprulescampaignoptimization)

Creates a campaign optimization rule.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createOptimizationRule();
```

### UpdateOptimizationRule - put /sp/rules/campaignOptimization

[](#updateoptimizationrule---put-sprulescampaignoptimization)

Updates a campaign optimization rule.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateOptimizationRule();
```

### CreateAssociatedBudgetRulesForSPCampaigns - post /sp/campaigns/{campaignId}/budgetRules

[](#createassociatedbudgetrulesforspcampaigns---post-spcampaignscampaignidbudgetrules)

Associates one or more budget rules to a campaign specified by identifer. A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createAssociatedBudgetRulesForSPCampaigns();
```

### ListAssociatedBudgetRulesForSPCampaigns - get /sp/campaigns/{campaignId}/budgetRules

[](#listassociatedbudgetrulesforspcampaigns---get-spcampaignscampaignidbudgetrules)

Gets a list of budget rules associated to a campaign specified by identifier.

**Authorized resource type**: Global Ad Account ID, Profile ID

**Parameter name**: Amazon-Ads-AccountId

**Parameter in**: header

**Requires one of these permissions**: \["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

[](#searchbrands---post-spnegativetargetsbrandssearch)

Returns brands related to keyword input for negative targeting. Returns up to 100 brands related to keyword input for negative targeting.

**Requires one of these permissions**: \["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

[](#getrefinementsforcategory---get-sptargetscategorycategoryidrefinements)

Returns refinements according to category input. Returns refinements according to category input.

**Requires one of these permissions**: \["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

[](#getrulenotification---post-sprulescampaignoptimizationstate)

Gets campaign optimization rule state. Recommended refresh frequency is once a day.

**Requires one of these permissions**: \["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

[](#listtargetpromotiongroups---post-sptargetpromotiongroupslist)

Returns the target promotion groups for an advertiser and / or adGroupId, and / or target promotion group id.

**Requires one of these permissions**: \["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

[](#listsponsoredproductsproductads---post-spproductadslist)

List product ads

**Requires one of these permissions**: \["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

[](#createoptimizationrules---post-sprulesoptimization)

Creates one or more optimization rules.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createOptimizationRules();
```

### UpdateOptimizationRules - put /sp/rules/optimization

[](#updateoptimizationrules---put-sprulesoptimization)

Updates one or more optimization rules.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateOptimizationRules();
```

### CreateTargetPromotionGroups - post /sp/targetPromotionGroups

[](#createtargetpromotiongroups---post-sptargetpromotiongroups)

Creates a target promotion group, by grouping the auto-targeting adGroupId and manual-targeting adGroups, divided by keyword targeting adGroups, and product targeting adGroups.

**Requires one of these permissions**: \["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

[](#createtargetpromotiongrouptargets---post-sptargetpromotiongroupstargets)

Creates 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"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createTargetPromotionGroupTargets();
```

### ListSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/list

[](#listsponsoredproductsnegativetargetingclauses---post-spnegativetargetslist)

List negative targeting clauses

**Requires one of these permissions**: \["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

[](#getkeywordgrouprecommendations---post-sptargetingrecommendationskeywordgroups)

This API (currently beta) recommends Keyword Group targets for a given list of Ad ASINs. Keyword Groups is a new control for Amazon Ads Sponsored Products keyword-based campaigns that enables advertisers to reach relevant audiences through a collection of keywords.

Once a Keyword Group specification is created, the performance of Keyword Groups will be available in the search terms report. Keyword Groups improves campaign performance by dynamically updating the keywords within a group through the campaign lifecycle and eliminates the need for advertisers to constantly curate new keywords. Additionally, Keyword Groups can be used alongside keywords within the same ad group.

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getKeywordGroupRecommendations();
```

### CreateSponsoredProductsProductAds - post /sp/productAds

[](#createsponsoredproductsproductads---post-spproductads)

Create product ads

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsProductAds();
```

### UpdateSponsoredProductsProductAds - put /sp/productAds

[](#updatesponsoredproductsproductads---put-spproductads)

Update product ads

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsProductAds();
```

### CreateBudgetRulesForSPCampaigns - post /sp/budgetRules

[](#createbudgetrulesforspcampaigns---post-spbudgetrules)

Creates one or more budget rules.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createBudgetRulesForSPCampaigns();
```

### GetSPBudgetRulesForAdvertiser - get /sp/budgetRules

[](#getspbudgetrulesforadvertiser---get-spbudgetrules)

Get all budget rules created by an advertiser

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getSPBudgetRulesForAdvertiser();
```

### UpdateBudgetRulesForSPCampaigns - put /sp/budgetRules

[](#updatebudgetrulesforspcampaigns---put-spbudgetrules)

Updates one or more budget rules.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateBudgetRulesForSPCampaigns();
```

### getCategoryRecommendationsForASINs - post /sp/targets/categories/recommendations

[](#getcategoryrecommendationsforasins---post-sptargetscategoriesrecommendations)

Returns a list of category recommendations for the input list of ASINs. Returns a list of category recommendations for the input list of ASINs. Use this API to discover relevant categories to target. To find ASINs, either use the Product Metadata API or browse the Amazon Retail Website.

- Response can be requested in different versions with the help of accept header. Please review the response mediaTypes for more information.
**Requires one of these permissions**: \["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

[](#gettargetpromotiongroupsrecommendations---post-sptargetpromotiongroupsrecommendations)

Retrieves keyword and product targets of an auto-targeting campaign as recommendations for promoting to a manual-targeting campaign. The recommendations are based on performance heuristics of the targets.

**Requires one of these permissions**: \["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

[](#getbudgetrecommendation---post-spcampaignsinitialbudgetrecommendation)

Creates daily budget recommendation along with benchmark metrics when creating a new campaign.

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getBudgetRecommendation();
```

### DeleteSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets/delete

[](#deletesponsoredproductscampaignnegativetargetingclauses---post-spcampaignnegativetargetsdelete)

Delete campaign negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsCampaignNegativeTargetingClauses();
```

### DeleteSponsoredProductsProductAds - post /sp/productAds/delete

[](#deletesponsoredproductsproductads---post-spproductadsdelete)

Delete product ads

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsProductAds();
```

### getNegativeBrands - get /sp/negativeTargets/brands/recommendations

[](#getnegativebrands---get-spnegativetargetsbrandsrecommendations)

Returns brands recommended for negative targeting. Returns brands recommended for negative targeting. Only available for Sellers and Vendors. These recommendations include your own brands because targeting your own brands usually results in lower performance than targeting competitors' brands.

**Requires one of these permissions**: \["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

[](#getbudgetrecommendations---post-spcampaignsbudgetrecommendations)

Get recommended daily budget and estimated missed opportunities for campaigns. Given a list of campaigns as input, this API provides the following metrics -
 **1. Recommended daily budget -**  Estimated daily budget needed to keep the campaign in budget for the full 24-hour period in a day. Consider this daily budget to minimize your campaign's chances of running out of budget.
 **2. Percent time in budget**  - Actual average percentage of time the campaign was in budget between the start and end date specified in the response. Note: value -1 means we don’t have enough information to compute the campaign’s percent time in budget.
 **3. Estimated missed impressions, clicks and sales**  - These are the estimated range of additional impressions, clicks and sales the campaign might have generated between the start and end date specified in the response had it been in budget 100% of the time. These are estimates based on historical traffic and the campaign's past performance (e.g. impressions & clicks generated) but not guaranteed.

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getBudgetRecommendations();
```

### CreateSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets

[](#createsponsoredproductsnegativetargetingclauses---post-spnegativetargets)

Create negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsNegativeTargetingClauses();
```

### UpdateSponsoredProductsNegativeTargetingClauses - put /sp/negativeTargets

[](#updatesponsoredproductsnegativetargetingclauses---put-spnegativetargets)

Update negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsNegativeTargetingClauses();
```

### CreateSponsoredProductsTargetingClauses - post /sp/targets

[](#createsponsoredproductstargetingclauses---post-sptargets)

Create targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsTargetingClauses();
```

### UpdateSponsoredProductsTargetingClauses - put /sp/targets

[](#updatesponsoredproductstargetingclauses---put-sptargets)

Update targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsTargetingClauses();
```

### SPGetBudgetRulesRecommendation - post /sp/campaigns/budgetRules/recommendations

[](#spgetbudgetrulesrecommendation---post-spcampaignsbudgetrulesrecommendations)

Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier. A rule enables an automatic budget increase for a specified date range or for a special event. The response also includes a suggested budget increase for each special event.

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->sPGetBudgetRulesRecommendation();
```

### CreateSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets

[](#createsponsoredproductscampaignnegativetargetingclauses---post-spcampaignnegativetargets)

Create campaign negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsCampaignNegativeTargetingClauses();
```

### UpdateSponsoredProductsCampaignNegativeTargetingClauses - put /sp/campaignNegativeTargets

[](#updatesponsoredproductscampaignnegativetargetingclauses---put-spcampaignnegativetargets)

Update campaign negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsCampaignNegativeTargetingClauses();
```

### CreateSponsoredProductsKeywords - post /sp/keywords

[](#createsponsoredproductskeywords---post-spkeywords)

Create keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsKeywords();
```

### UpdateSponsoredProductsKeywords - put /sp/keywords

[](#updatesponsoredproductskeywords---put-spkeywords)

Update keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsKeywords();
```

### ListSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets/list

[](#listsponsoredproductscampaignnegativetargetingclauses---post-spcampaignnegativetargetslist)

List campaign negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->listSponsoredProductsCampaignNegativeTargetingClauses();
```

### DeleteSponsoredProductsTargetingClauses - post /sp/targets/delete

[](#deletesponsoredproductstargetingclauses---post-sptargetsdelete)

Delete targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsTargetingClauses();
```

### SearchOptimizationRules - post /sp/rules/optimization/search

[](#searchoptimizationrules---post-sprulesoptimizationsearch)

Searches optimization rules based on optional filters.

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->searchOptimizationRules();
```

### CreateSponsoredProductsCampaigns - post /sp/campaigns

[](#createsponsoredproductscampaigns---post-spcampaigns)

Create campaigns

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsCampaigns();
```

### UpdateSponsoredProductsCampaigns - put /sp/campaigns

[](#updatesponsoredproductscampaigns---put-spcampaigns)

Update campaigns

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsCampaigns();
```

### ListSponsoredProductsAdGroups - post /sp/adGroups/list

[](#listsponsoredproductsadgroups---post-spadgroupslist)

List ad groups

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->listSponsoredProductsAdGroups();
```

### DeleteSponsoredProductsAdGroups - post /sp/adGroups/delete

[](#deletesponsoredproductsadgroups---post-spadgroupsdelete)

Delete ad groups

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsAdGroups();
```

### getCampaignRecommendations - get /sp/campaign/recommendations

[](#getcampaignrecommendations---get-spcampaignrecommendations)

Gets the top consolidated recommendations across bid, budget, targeting for SP campaigns given an advertiser profile id. The recommendations are refreshed everyday.

**Requires one of these permissions**: \["advertiser\_campaign\_view","advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getCampaignRecommendations();
```

### DeleteSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords/delete

[](#deletesponsoredproductscampaignnegativekeywords---post-spcampaignnegativekeywordsdelete)

Delete campaign negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsCampaignNegativeKeywords();
```

### AssociateOptimizationRulesToCampaign - post /sp/campaigns/{campaignId}/optimizationRules

[](#associateoptimizationrulestocampaign---post-spcampaignscampaignidoptimizationrules)

Associates one or multiple optimization rules with a campaign.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->associateOptimizationRulesToCampaign();
```

### ListSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords/list

[](#listsponsoredproductscampaignnegativekeywords---post-spcampaignnegativekeywordslist)

List campaign negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->listSponsoredProductsCampaignNegativeKeywords();
```

### DeleteSponsoredProductsCampaigns - post /sp/campaigns/delete

[](#deletesponsoredproductscampaigns---post-spcampaignsdelete)

Delete campaigns

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsCampaigns();
```

### ListSponsoredProductsCampaigns - post /sp/campaigns/list

[](#listsponsoredproductscampaigns---post-spcampaignslist)

List campaigns

**Requires one of these permissions**: \["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

[](#getcampaignsassociatedwithspbudgetrule---get-spbudgetrulesbudgetruleidcampaigns)

Gets all the campaigns associated with a budget rule

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getCampaignsAssociatedWithSPBudgetRule();
```

### DisassociateAssociatedBudgetRuleForSPCampaigns - delete /sp/campaigns/{campaignId}/budgetRules/{budgetRuleId}

[](#disassociateassociatedbudgetruleforspcampaigns---delete-spcampaignscampaignidbudgetrulesbudgetruleid)

Disassociates a budget rule specified by identifier from a campaign specified by identifier.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->disassociateAssociatedBudgetRuleForSPCampaigns();
```

### CreateSponsoredProductsAdGroups - post /sp/adGroups

[](#createsponsoredproductsadgroups---post-spadgroups)

Create ad groups

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsAdGroups();
```

### UpdateSponsoredProductsAdGroups - put /sp/adGroups

[](#updatesponsoredproductsadgroups---put-spadgroups)

Update ad groups

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsAdGroups();
```

### getProductRecommendations - post /sp/targets/products/recommendations

[](#getproductrecommendations---post-sptargetsproductsrecommendations)

Suggested target ASINs for your advertised product Given an advertised ASIN as input, this API returns suggested ASINs to target in a product targeting campaign. We use various methods to generate these suggestions. These include using historical performance of your ad, items that shoppers they frequently view and purchase together, etc. The suggested targets can be retrieved either as a single list, or grouped by ‘theme' – i.e. an accompanying context for why we recommend the items. You can pick the desired format using the Accepts header, please see the response mediaTypes for more information.

#### Pagination Behavior

[](#pagination-behavior)

 The API supports cursor based pagination using encoded cursor values to return next set of records or previously served records. The **count** parameter in the request body will be used to determine the size of results when requesting the previous page or next page. If no value for **count** is passed in the request, a default value is assumed. Please refer the range and defaults for these values in the request schema under GetProductRecommendationsRequest.
 ***Note:** The clients should never cache pagination cursor values locally as these values will expire after a certain time period. However a cursor value can be reused to perform retries in case of failures as long as the value has not expired.

#### Themes

[](#themes-)

 Themes provide additional context for why we are recommending a product as a target. See below for an overall list of themes currently available –
**- Top converting targets** – These ASINs generated conversions for the input ASIN in the past 30 days (e.g. your product appeared as an ad on the detail page of these items, and a shopper clicked and purchased your item). The suggested ASINs under this theme are sorted in decreasing order of sales generated for your promoted item.
**- Similar items (frequently viewed together)** – Items that shoppers frequently view and click along with your advertised item during a shopping session.
**- Complements** – Items that are frequently purchased together as complements. For example, if you are promoting a tennis racquet, you may see tennis balls recommended under this theme.
**- Similar items with low ratings and reviews** – Subset of the ‘similar items’ theme containing items that are rated lower than 3 stars and/or with fewer than 5 reviews.
**- Other books read by your readers** – Items that shoppers frequently view and click along with your advertised item during a shopping session.

***Note:** Availability of themes differs by input ASIN - some ASINs may not have all above themes available*```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getProductRecommendations();
```

### DeleteSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/delete

[](#deletesponsoredproductsnegativetargetingclauses---post-spnegativetargetsdelete)* Delete negative targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsNegativeTargetingClauses();
```

### DeleteSponsoredProductsKeywords - post /sp/keywords/delete

[](#deletesponsoredproductskeywords---post-spkeywordsdelete)

Delete keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteSponsoredProductsKeywords();
```

### GetOptimizationRuleEligibility - post /sp/rules/campaignOptimization/eligibility

[](#getoptimizationruleeligibility---post-sprulescampaignoptimizationeligibility)

Gets a campaign optimization rule recommendation for SP campaigns.

**Requires one of these permissions**: \["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}

[](#getbudgetrulebyruleidforspcampaigns---get-spbudgetrulesbudgetruleid)

Gets a budget rule specified by identifier.

**Authorized resource type**: Global Ad Account ID, Profile ID

**Parameter name**: Amazon-Ads-AccountId

**Parameter in**: header

**Requires one of these permissions**: \["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}

[](#getcampaignoptimizationrule---get-sprulescampaignoptimizationcampaignoptimizationid)

Gets a campaign optimization rule specified by identifier.

**Requires one of these permissions**: \["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}

[](#deletecampaignoptimizationrule---delete-sprulescampaignoptimizationcampaignoptimizationid)

Deletes a campaign optimization rule specified by identifier.

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->deleteCampaignOptimizationRule();
```

### CreateSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords

[](#createsponsoredproductscampaignnegativekeywords---post-spcampaignnegativekeywords)

Create campaign negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsCampaignNegativeKeywords();
```

### UpdateSponsoredProductsCampaignNegativeKeywords - put /sp/campaignNegativeKeywords

[](#updatesponsoredproductscampaignnegativekeywords---put-spcampaignnegativekeywords)

Update campaign negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsCampaignNegativeKeywords();
```

### ListTargetPromotionGroupTargets - post /sp/targetPromotionGroups/targets/list

[](#listtargetpromotiongrouptargets---post-sptargetpromotiongroupstargetslist)

Returns the targets created through target promotion groups for an advertiser and / or given target promotion group.

**Requires one of these permissions**: \["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

[](#listsponsoredproductstargetingclauses---post-sptargetslist)

List targeting clauses

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->listSponsoredProductsTargetingClauses();
```

### ListSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/list

[](#listsponsoredproductsnegativekeywords---post-spnegativekeywordslist)

List negative keywords

**Requires one of these permissions**: \["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

[](#getglobalrankedkeywordrecommendation---post-spglobaltargetskeywordsrecommendationslist)

Get global keyword recommendations The  **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 global campaign ID and ad group ID. Please use the recommendationType field to specify if you want to use option A or option B. This endpoint will also return recommended bids along with each recommendation keyword target.

  **CountryCodes**
Global API endpoint accepts **countryCodes** dictionary. Key is the 2-letter country code. Value is an object with two arrays **asins** and **targets**. Each country will be processed in parallel according to rules of [version 5](https://advertising.amazon.com/API/docs/en-us/sponsored-products/3-0/openapi/prod#tag/Keyword-Targets:~:text=keywords/localize%20endpoint.-,Version%205.0,-New%20Features) recommendation API.

###  Availability

[](#-availability--2)

 Global keyword recommendation API is available in all the marketplaces.```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->getGlobalRankedKeywordRecommendation();
```

### CreateSponsoredProductsNegativeKeywords - post /sp/negativeKeywords

[](#createsponsoredproductsnegativekeywords---post-spnegativekeywords)

Create negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->createSponsoredProductsNegativeKeywords();
```

### UpdateSponsoredProductsNegativeKeywords - put /sp/negativeKeywords

[](#updatesponsoredproductsnegativekeywords---put-spnegativekeywords)

Update negative keywords

**Requires one of these permissions**: \["advertiser\_campaign\_edit"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->updateSponsoredProductsNegativeKeywords();
```

### spCampaignsBudgetUsage - post /sp/campaigns/budget/usage

[](#spcampaignsbudgetusage---post-spcampaignsbudgetusage)

Budget usage API for SP campaigns

**Requires one of these permissions**: \["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

[](#spgetallruleevents---post-spv1events)

Gets all special individual and grouped events with suggested date range in advertiser's marketplace. A rule enables an automatic budget increase for a specified date range or for a special event. The response includes the suggested date range for each special event.

**Requires one of these permissions**: \["advertiser\_campaign\_edit","advertiser\_campaign\_view"\]

```
// see above how to create a client
$client = SponsoredProductsApiClient::createFor(Endpoint::Europe, $accessToken);
$client->sPGetAllRuleEvents();
```

License
-------

[](#license)

Apache 2.0

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance52

Moderate activity, may be stable

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 97.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

10

Last Release

687d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2ac8297e12671d91305ec01ab56add8cb141fa82d678ba96f0012eeb7f88ea0c?d=identicon)[cedricziel](/maintainers/cedricziel)

---

Top Contributors

[![cedricziel](https://avatars.githubusercontent.com/u/418970?v=4)](https://github.com/cedricziel "cedricziel (35 commits)")[![actions-user](https://avatars.githubusercontent.com/u/65916846?v=4)](https://github.com/actions-user "actions-user (1 commits)")

---

Tags

amazonamazon-api

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/cedricziel-amznsponsoredproductsapiphp/health.svg)

```
[![Health](https://phpackages.com/badges/cedricziel-amznsponsoredproductsapiphp/health.svg)](https://phpackages.com/packages/cedricziel-amznsponsoredproductsapiphp)
```

###  Alternatives

[mollie/mollie-api-php

Mollie API client library for PHP. Mollie is a European Payment Service provider and offers international payment methods such as Mastercard, VISA, American Express and PayPal, and local payment methods such as iDEAL, Bancontact, SOFORT Banking, SEPA direct debit, Belfius Direct Net, KBC Payment Button and various gift cards such as Podiumcadeaukaart and fashioncheque.

60315.4M74](/packages/mollie-mollie-api-php)[aimeos/ai-admin-graphql

Aimeos Admin GraphQL API extension

1.0k106.6k7](/packages/aimeos-ai-admin-graphql)[jolicode/slack-php-api

An up to date PHP client for Slack's API

2554.6M13](/packages/jolicode-slack-php-api)[deepseek-php/deepseek-php-client

deepseek PHP client is a robust and community-driven PHP client library for seamless integration with the Deepseek API, offering efficient access to advanced AI and data processing capabilities.

46784.5k5](/packages/deepseek-php-deepseek-php-client)[toshy/bunnynet-php

BunnyNet API client for PHP

61195.4k13](/packages/toshy-bunnynet-php)[kirschbaum-development/laravel-openapi-validator

Automatic OpenAPI validation for Laravel HTTP tests

581.2M5](/packages/kirschbaum-development-laravel-openapi-validator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)