Download the PHP package cedricziel/amznsponsoredproductsapiphp without Composer
On this page you can find all versions of the php package cedricziel/amznsponsoredproductsapiphp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cedricziel/amznsponsoredproductsapiphp
More information about cedricziel/amznsponsoredproductsapiphp
Files in cedricziel/amznsponsoredproductsapiphp
Package amznsponsoredproductsapiphp
Short Description An API client for the Amazon Sponsored Products API
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package amznsponsoredproductsapiphp
amzn-sponsored-products-api-php
An API client for the Amazon Sponsored Products API.
Docs
General
Instantiate a client, configure your secrets and continue to use:
GetThemeBasedBidRecommendationForAdGroup_v1 - post /sp/targets/bid/recommendations
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
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"]
getRankedKeywordRecommendation - post /sp/targets/keywords/recommendations
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 endpoint.
Version 5.0
New Features
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.
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
Version 5.0 is only available in the following marketplaces: US, CA, UK, DE, FR, ES, IN, JP.Version 4.0
New features
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
Version 4.0 is available in all marketplaces.Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
ListSponsoredProductsKeywords - post /sp/keywords/list
List keywords
Requires one of these permissions: ["advertiser_campaign_edit"]
DeleteSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/delete
Delete negative keywords
Requires one of these permissions: ["advertiser_campaign_edit"]
getTargetableASINCounts - post /sp/targets/products/count
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"]
getTargetableCategories - get /sp/targets/categories
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"]
CreateOptimizationRule - post /sp/rules/campaignOptimization
Creates a campaign optimization rule.
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateOptimizationRule - put /sp/rules/campaignOptimization
Updates a campaign optimization rule.
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateAssociatedBudgetRulesForSPCampaigns - post /sp/campaigns/{campaignId}/budgetRules
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"]
ListAssociatedBudgetRulesForSPCampaigns - get /sp/campaigns/{campaignId}/budgetRules
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"]
searchBrands - post /sp/negativeTargets/brands/search
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"]
getRefinementsForCategory - get /sp/targets/category/{categoryId}/refinements
Returns refinements according to category input. Returns refinements according to category input.
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
GetRuleNotification - post /sp/rules/campaignOptimization/state
Gets campaign optimization rule state. Recommended refresh frequency is once a day.
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
ListTargetPromotionGroups - post /sp/targetPromotionGroups/list
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"]
ListSponsoredProductsProductAds - post /sp/productAds/list
List product ads
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
CreateOptimizationRules - post /sp/rules/optimization
Creates one or more optimization rules.
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateOptimizationRules - put /sp/rules/optimization
Updates one or more optimization rules.
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateTargetPromotionGroups - post /sp/targetPromotionGroups
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"]
CreateTargetPromotionGroupTargets - post /sp/targetPromotionGroups/targets
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"]
ListSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/list
List negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
getKeywordGroupRecommendations - post /sp/targeting/recommendations/keywordGroups
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.
CreateSponsoredProductsProductAds - post /sp/productAds
Create product ads
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsProductAds - put /sp/productAds
Update product ads
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateBudgetRulesForSPCampaigns - post /sp/budgetRules
Creates one or more budget rules.
Requires one of these permissions: ["advertiser_campaign_edit"]
GetSPBudgetRulesForAdvertiser - get /sp/budgetRules
Get all budget rules created by an advertiser
UpdateBudgetRulesForSPCampaigns - put /sp/budgetRules
Updates one or more budget rules.
Requires one of these permissions: ["advertiser_campaign_edit"]
getCategoryRecommendationsForASINs - post /sp/targets/categories/recommendations
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"]
GetTargetPromotionGroupsRecommendations - post /sp/targetPromotionGroups/recommendations
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"]
getBudgetRecommendation - post /sp/campaigns/initialBudgetRecommendation
Creates daily budget recommendation along with benchmark metrics when creating a new campaign.
DeleteSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets/delete
Delete campaign negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
DeleteSponsoredProductsProductAds - post /sp/productAds/delete
Delete product ads
Requires one of these permissions: ["advertiser_campaign_edit"]
getNegativeBrands - get /sp/negativeTargets/brands/recommendations
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"]
getBudgetRecommendations - post /sp/campaigns/budgetRecommendations
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"]
CreateSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets
Create negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsNegativeTargetingClauses - put /sp/negativeTargets
Update negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateSponsoredProductsTargetingClauses - post /sp/targets
Create targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsTargetingClauses - put /sp/targets
Update targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
SPGetBudgetRulesRecommendation - post /sp/campaigns/budgetRules/recommendations
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"]
CreateSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets
Create campaign negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsCampaignNegativeTargetingClauses - put /sp/campaignNegativeTargets
Update campaign negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateSponsoredProductsKeywords - post /sp/keywords
Create keywords
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsKeywords - put /sp/keywords
Update keywords
Requires one of these permissions: ["advertiser_campaign_edit"]
ListSponsoredProductsCampaignNegativeTargetingClauses - post /sp/campaignNegativeTargets/list
List campaign negative targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
DeleteSponsoredProductsTargetingClauses - post /sp/targets/delete
Delete targeting clauses
Requires one of these permissions: ["advertiser_campaign_edit"]
SearchOptimizationRules - post /sp/rules/optimization/search
Searches optimization rules based on optional filters.
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
CreateSponsoredProductsCampaigns - post /sp/campaigns
Create campaigns
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsCampaigns - put /sp/campaigns
Update campaigns
Requires one of these permissions: ["advertiser_campaign_edit"]
ListSponsoredProductsAdGroups - post /sp/adGroups/list
List ad groups
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
DeleteSponsoredProductsAdGroups - post /sp/adGroups/delete
Delete ad groups
Requires one of these permissions: ["advertiser_campaign_edit"]
getCampaignRecommendations - get /sp/campaign/recommendations
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"]
DeleteSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords/delete
Delete campaign negative keywords
Requires one of these permissions: ["advertiser_campaign_edit"]
AssociateOptimizationRulesToCampaign - post /sp/campaigns/{campaignId}/optimizationRules
Associates one or multiple optimization rules with a campaign.
Requires one of these permissions: ["advertiser_campaign_edit"]
ListSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords/list
List campaign negative keywords
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
DeleteSponsoredProductsCampaigns - post /sp/campaigns/delete
Delete campaigns
Requires one of these permissions: ["advertiser_campaign_edit"]
ListSponsoredProductsCampaigns - post /sp/campaigns/list
List campaigns
Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
GetCampaignsAssociatedWithSPBudgetRule - get /sp/budgetRules/{budgetRuleId}/campaigns
Gets all the campaigns associated with a budget rule
DisassociateAssociatedBudgetRuleForSPCampaigns - delete /sp/campaigns/{campaignId}/budgetRules/{budgetRuleId}
Disassociates a budget rule specified by identifier from a campaign specified by identifier.
Requires one of these permissions: ["advertiser_campaign_edit"]
CreateSponsoredProductsAdGroups - post /sp/adGroups
Create ad groups
Requires one of these permissions: ["advertiser_campaign_edit"]
UpdateSponsoredProductsAdGroups - put /sp/adGroups
Update ad groups
Requires one of these permissions: ["advertiser_campaign_edit"]
getProductRecommendations - post /sp/targets/products/recommendations
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
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 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 ### DeleteSponsoredProductsNegativeTargetingClauses - post /sp/negativeTargets/delete Delete negative targeting clauses **Requires one of these permissions**: ["advertiser_campaign_edit"] ### DeleteSponsoredProductsKeywords - post /sp/keywords/delete Delete keywords **Requires one of these permissions**: ["advertiser_campaign_edit"] ### GetOptimizationRuleEligibility - post /sp/rules/campaignOptimization/eligibility Gets a campaign optimization rule recommendation for SP campaigns. **Requires one of these permissions**: ["advertiser_campaign_edit","advertiser_campaign_view"] ### GetBudgetRuleByRuleIdForSPCampaigns - get /sp/budgetRules/{budgetRuleId} 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"] ### GetCampaignOptimizationRule - get /sp/rules/campaignOptimization/{campaignOptimizationId} Gets a campaign optimization rule specified by identifier. **Requires one of these permissions**: ["advertiser_campaign_edit","advertiser_campaign_view"] ### DeleteCampaignOptimizationRule - delete /sp/rules/campaignOptimization/{campaignOptimizationId} Deletes a campaign optimization rule specified by identifier. **Requires one of these permissions**: ["advertiser_campaign_edit"] ### CreateSponsoredProductsCampaignNegativeKeywords - post /sp/campaignNegativeKeywords Create campaign negative keywords **Requires one of these permissions**: ["advertiser_campaign_edit"] ### UpdateSponsoredProductsCampaignNegativeKeywords - put /sp/campaignNegativeKeywords Update campaign negative keywords **Requires one of these permissions**: ["advertiser_campaign_edit"] ### ListTargetPromotionGroupTargets - post /sp/targetPromotionGroups/targets/list 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"] ### ListSponsoredProductsTargetingClauses - post /sp/targets/list List targeting clauses **Requires one of these permissions**: ["advertiser_campaign_edit"] ### ListSponsoredProductsNegativeKeywords - post /sp/negativeKeywords/list List negative keywords **Requires one of these permissions**: ["advertiser_campaign_edit","advertiser_campaign_view"] ### getGlobalRankedKeywordRecommendation - post /sp/global/targets/keywords/recommendations/list 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 recommendation API.
