Download the PHP package jootop/amazon-advertising-api-php-sdk without Composer
On this page you can find all versions of the php package jootop/amazon-advertising-api-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jootop/amazon-advertising-api-php-sdk
More information about jootop/amazon-advertising-api-php-sdk
Files in jootop/amazon-advertising-api-php-sdk
Package amazon-advertising-api-php-sdk
Short Description Amazon Advertising API Client Library
License Apache OSL-2
Homepage https://advertising.amazon.com/
Informations about the package amazon-advertising-api-php-sdk
Synopsis
Official Amazon Advertising API PHP client library.
This repository has been deprecated and will no longer receive updates.
Requirements
PHP >= 5.3.0
cURL >= 7.18
Documentation
API Reference
Access Request
Getting Started
Tutorials
Register Sandbox Profile - This tutorial will show you how to register a profile in sandbox using CURL.
Generate and download a report using CURL - You will need to complete registering a profile in sandbox prior to doing this tutorial.
Sandbox self-service
If you would like to test the API in sandbox you will need to register a profile for the region in which you would like to test. The registerProfile
API call can be made to do this. Make sure you instantiate the client in sandbox
mode before making this call or it will fail.
The following country codes are available for testing.
US, CA, UK, DE, FR, ES, IT, IN, CN, JP
Quick Start
Instantiate the client
You can pass in
accessToken
if you do not have a refresh token.
Refresh access token
You can refresh your access token when it expires by using the following method. The new access token will be in the request response. This method will set it for you so it's mainly for reference if you need it.
Get a list of profiles
Set profile Id
Once you've set the profile Id you are ready to start making API calls.
Example API Calls
- Profiles
- listProfiles
- getProfile
- updateProfiles
- Portfolios
- getPortfolio
- getPortfolioEx
- createPortfolios
- updatePortfolios
- listPortfolios
- listPortfoliosEx
- Campaigns
- listCampaigns
- listCampaignsEx
- getCampaign
- createCampaigns
- updateCampaigns
- archiveCampaign
- Ad Groups
- listAdGroups
- listAdGroupsEx
- getAdGroup
- createAdGroups
- updateAdGroups
- archiveAdGroup
- Biddable Keywords
- listBiddableKeywords
- listBiddableKeywordsEx
- getBiddableKeyword
- createBiddableKeywords
- updateBiddableKeywords
- archiveBiddableKeyword
- Negative Keywords
- listNegativeKeywords
- listNegativeKeywordsEx
- getNegativeKeyword
- createNegativeKeywords
- updateNegativeKeywords
- archiveNegativeKeyword
- Campaign Negative Keywords
- listCampaignNegativeKeywords
- getCampaignNegativeKeyword
- createCampaignNegativeKeywords
- updateCampaignNegativeKeywords
- removeCampaignNegativeKeyword
- Product Ads
- listProductAds
- listProductAdsEx
- getProductAd
- createProductAds
- updateProductAds
- archiveProductAd
- Product targeting
- getTargetingClause
- listTargetingClauses
- getTargetingClauseEx
- listTargetingClausesEx
- createTargetingClauses
- updateTargetingClauses
- archiveTargetingClause
- getTargetingCategories
- getBrandRecommendations
- getNegativeTargetingClause
- getNegativeTargetingClauseEx
- createNegativeTargetingClauses
- listNegativeTargetingClauses
- listNegativeTargetingClausesEx
- archiveNegativeTargetingClause
- updateNegativeTargetingClauses
- Snapshots
- requestSnapshot
- getSnapshot
- Reports
- requestReport
- getReport
- Bid Recommendations
- getAdGroupBidRecommendations
- getKeywordBidRecommendations
- bulkGetKeywordBidRecommendations
- Keyword Suggestions
- getAdGroupKeywordSuggestions
- getAdGroupKeywordSuggestionsEx
- getAsinKeywordSuggestions
- bulkGetAsinKeywordSuggestions
getProfile
Retrieves a single profile by Id.
updateProfiles
Updates one or more profiles. Advertisers are identified using their
profileIds
.
getPortfolio
Retrieves a Portfolio by Id
getPortfolioEx
Retrieves a PortfolioEx by Id
createPortfolios
updatePortfolios
listPortfolios
listPortfoliosEx
listCampaigns
Retrieves a list of campaigns satisfying optional criteria.
{ "campaignId": 1234567890, "name": "CampaignOne", "campaignType": "sponsoredProducts", "targetingType": "manual", "dailyBudget": 15.0, "startDate": "20160330", "state": "enabled" }
[ { "code": "SUCCESS", "campaignId": 173284463890123 }, { "code": "SUCCESS", "campaignId": 27074907785456 } ]
[ { "code": "SUCCESS", "campaignId": 173284463890123 }, { "code": "SUCCESS", "campaignId": 27074907785456 } ]
{ "code": "SUCCESS", "campaignId": 1234567890 }
[ { "adGroupId": 262960563101486, "name": "AdGroup One", "campaignId": 181483024866689, "defaultBid": 1.0, "state": "enabled" }, { "adGroupId": 52169162825843, "name": "AdGroup Two", "campaignId": 250040549047739, "defaultBid": 2.0, "state": "enabled" } ]
{ "adGroupId": 262960563101486, "name": "AdGroup One", "campaignId": 181483024866689, "defaultBid": 1.0, "state": "enabled" }
[ { "code": "SUCCESS", "adGroupId": 117483076163518 }, { "code": "SUCCESS", "adGroupId": 123431426718271 } ]
[ { "code": "SUCCESS", "adGroupId": 117483076163518 }, { "code": "SUCCESS", "adGroupId": 123431426718271 } ]
{ "code": "SUCCESS", "adGroupId": 117483076163518 }
[ { "keywordId": 174140697976855, "adGroupId": 52169162825843, "campaignId": 250040549047739, "keywordText": "KeywordOne", "matchType": "exact", "state": "enabled" }, { "keywordId": 118195812188994, "adGroupId": 52169162825843, "campaignId": 250040549047739, "keywordText": "KeywordTwo", "matchType": "exact", "state": "enabled" } ]
{ "keywordId": 174140697976855, "adGroupId": 52169162825843, "campaignId": 250040549047739, "keywordText": "KeywordOne", "matchType": "exact", "state": "enabled" }
[ { "code": "SUCCESS", "keywordId": 112210768353976 }, { "code": "SUCCESS", "keywordId": 249490346605943 } ]
[ { "code": "SUCCESS", "keywordId": 112210768353976 }, { "code": "SUCCESS", "keywordId": 249490346605943 } ]
{ "code": "200", "requestId": "0TR95PJD6Z16FFCZDXD0" }
[ { "keywordId": 281218602770639, "adGroupId": 52169162825843, "campaignId": 250040549047739, "keywordText": "KeywordOne", "matchType": "negativeExact", "state": "enabled" }, { "keywordId": 280875877064090, "adGroupId": 262960563101486, "campaignId": 181483024866689, "keywordText": "KeywordTwo", "matchType": "negativeExact", "state": "enabled" } ]
{ "keywordId": 281218602770639, "adGroupId": 52169162825843, "campaignId": 250040549047739, "keywordText": "KeywordOne", "matchType": "negativeExact", "state": "enabled" }
[ { "code": "SUCCESS", "keywordId": 61857817062026 }, { "code": "SUCCESS", "keywordId": 147623067066967 } ]
[ { "code": "SUCCESS", "keywordId": 61857817062026 }, { "code": "INVALID_ARGUMENT", "description": "Entity with id 61857817062026 already specified in this update operation." } ]
{ "code": "SUCCESS", "keywordId": 61857817062026 }
[ { "keywordId": 131747786239884, "adGroupId": null, "campaignId": 181483024866689, "keywordText": "Negative Keyword", "matchType": "negativeExact", "state": "enabled" }, { "keywordId": 197201372210821, "adGroupId": null, "campaignId": 181483024866689, "keywordText": "My Negative Keyword", "matchType": "negativeExact", "state": "enabled" } ]
{ "keywordId": 197201372210821, "adGroupId": null, "campaignId": 181483024866689, "keywordText": "My Negative Keyword", "matchType": "negativeExact", "state": "enabled" }
[ { "code": "SUCCESS", "keywordId": 196797670902082 }, { "code": "SUCCESS", "keywordId": 186203479904657 } ]
{ "code": "SUCCESS", "keywordId": 186203479904657 }
[ { "adId": 247309761200483, "adGroupId": 262960563101486, "campaignId": 181483024866689, "sku": "TEST001", "state": "enabled" } ]
{ "adId": 247309761200483, "adGroupId": 262960563101486, "campaignId": 181483024866689, "sku": "TEST001", "state": "enabled" }
[ { "code": "SUCCESS", "adId": 239870616623537 }, { "code": "SUCCESS", "adId": 191456410590622 } ]
[ { "code": "SUCCESS", "adId": 239870616623537 }, { "code": "SUCCESS", "adId": 191456410590622 } ]
{ "code": "SUCCESS", "adId": 239870616623537 }
{ "snapshotId": "amzn1.clicksAPI.v1.p1.573A0477.ec41773a-1659-4013-8eb9-fa18c87ef5df", "recordType": "campaign", "status": "IN_PROGRESS" }
[ { "campaignId": 181483024866689, "name": "Campaign One", "campaignType": "sponsoredProducts", "targetingType": "manual", "dailyBudget": 5.0, "startDate": "20160330", "state": "archived" }, { "campaignId": 59836775211065, "name": "Campaign Two", "campaignType": "sponsoredProducts", "targetingType": "manual", "dailyBudget": 10.99, "startDate": "20160330", "state": "archived" }, { "campaignId": 254238342004647, "name": "Campaign Three", "campaignType": "sponsoredProducts", "targetingType": "manual", "dailyBudget": 99.99, "startDate": "20160510", "state": "enabled" } ]
{ "reportId": "amzn1.clicksAPI.v1.m1.573A0808.32908def-66a1-4ce2-8f12-780dc4ae1d43", "recordType": "campaign", "status": "IN_PROGRESS", "statusDetails": "Report is submitted" }
[ { "cost": 647.75, "campaignId": 230751293360275, "clicks": 2591, "impressions": 58288 }, { "cost": 619.5, "campaignId": 52110033002744, "clicks": 2478, "impressions": 68408 }, { "cost": 151.91, "campaignId": 140739567440917, "clicks": 633, "impressions": 17343 }, { "cost": 143.46, "campaignId": 79132327246328, "clicks": 797, "impressions": 48903 } ]
{ "adGroupId": 1234509876, "suggestedBid": { "rangeEnd": 2.16, "rangeStart": 0.67, "suggested": 1.67 } }
{ "keywordId": 85243141758914, "adGroupId": 252673310548066, "suggestedBid": { "rangeEnd": 3.18, "rangeStart": 0.35, "suggested": 2.97 } }
{ "adGroupId": 242783265349805, "recommendations": [ { "code": "SUCCESS", "keyword": "testKeywordOne", "matchType": "exact", "suggestedBid": { "rangeEnd": 2.67, "rangeStart": 0.38, "suggested": 2.07 } }, { "code": "SUCCESS", "keyword": "testKeywordTwo", "matchType": "exact", "suggestedBid": { "rangeEnd": 3.19, "rangeStart": 0.79, "suggested": 3.03 } } ] }
{ "adGroupId": 1234567890, "suggestedKeywords": [ { "keywordText": "keyword PRODUCT_AD_A 1", "matchType": "broad" }, { "keywordText": "keyword PRODUCT_AD_B 1", "matchType": "broad" } ] }
[ { "adGroupId": 1234567890, "campaignId": 0987654321, "keywordText": "keyword TESTASINXX 1", "matchType": "broad", "state": "enabled", "bid": 1.84 }, { "adGroupId": 1234567890, "campaignId": 0987654321, "keywordText": "keyword TESTASINXX 2", "matchType": "broad", "state": "enabled", "bid": 1.07 } ]
[ { "keywordText": "keyword B00IJSNPM0 1", "matchType": "broad" }, { "keywordText": "keyword B00IJSNPM0 2", "matchType": "broad" } ]
[ { "keywordText": "keyword B00IJSNPM0 1", "matchType": "broad" }, { "keywordText": "keyword B00IJSO1NM 1", "matchType": "broad" } ]
All versions of amazon-advertising-api-php-sdk with dependencies
php Version >=5.3.0