Python Amazon 广告 API
A python 3 wrapper to access Amazon's Advertising API with an easy-to-use interface.
pip install python-amazon-ad-apiIf you find this project is useful consider donating or sponsor it to keep on going on it, thank you.
You need obtain your own credentials with Amazon that may include an amazon developer account and access as seller or vendor. Please view the checklist of Amazon Ads API onboarding overview
You can use your credentials as follows passing it to the client as a dict. Please review the full documentation to see all posibilities to include your credentials.
from ad_api.api import sponsored_products
my_credentials = dict(
refresh_token='your-refresh_token',
client_id='your-client_id',
client_secret='your-client_secret',
profile_id='your-profile_id',
)
info = \
{
"stateFilter":
{
"include": [
"ENABLED"
]
}
}
result = sponsored_products.CampaignsV3(credentials=my_credentials).list_campaigns(
body=info
)
Use a credentials.yml file with your credentials for more convenience and manage diferent accounts or profiles. Amazon requires one profile per marketplace so it is helpful to keep all in one file and switch directly from the code, using the account.
Create a file credentials.yml
version: '1.0'
default:
refresh_token: 'your-refresh-token'
client_id: 'your-client-id'
client_secret: 'your-client-secret'
profile_id: 'your-profile-id'
germany:
refresh_token: 'other-refresh-token'
client_id: 'other-client-id'
client_secret: 'other-client-secret'
profile_id: 'other-profile-id'
Python code
from ad_api.api import sponsored_products
# Leave empty will use the 'default' account
result=sponsored_products.CampaignsV3().list_campaigns()
# will use germany account data
result=sponsored_products.CampaignsV3(account="germany").list_campaigns()~/.config/python-ad-api%APPDATA%\python-ad-api where the APPDATA environment variable falls
back to %HOME%\AppData\Roaming if undefinedMarketplaces are used to define basically the API endpoints Amazon need to use depending on the regions, by default it will use EU so if you are using one of the marketplaces that are under the Europe (EU). Covers UK, FR, IT, ES, DE, NL, AE, SE, PL, and TR marketplaces you can skip. If you are using either North America (NA) or Far East (FE), you will need import from base and pass the marketplace as follows:
from ad_api.api import sponsored_products
from ad_api.base import Marketplaces
# You can pass NA or US, CA, MX or BR for North America and JP, AU or SG for Far East
result=sponsored_products.CampaignsV3(marketplace=Marketplaces.NA).list_campaigns()
You can use a try except statement when you call the API and catch exceptions if some problem ocurred:
from ad_api.api import sponsored_products
from ad_api.base import AdvertisingApiException
info = \
{
"stateFilter":
{
"include": [
"ENABLED"
]
}
}
try:
result = sponsored_products.CampaignsV3().list_campaigns(
body=info
)
logging.info(result)
except AdvertisingApiException as error:
logging.info(error)Use debug=True if you want see some logs like the header you submit to the api endpoint, the method and path used among the params and the data submitted if any, to trace some possible errors.
from ad_api.api import sponsored_products
from ad_api.base import AdvertisingApiException
info = \
{
"stateFilter":
{
"include": [
"ENABLED"
]
}
}
try:
result = sponsored_products.CampaignsV3(debug=True).list_campaigns(
body=info
)
logging.info(result)
except AdvertisingApiException as error:
logging.info(error)…Or you could do with a curl command, note the {"countryCode":"ES"} that refers to the marketplace you will operate.
curl \
-X PUT \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Your-Token \
-H "Amazon-Advertising-API-ClientId: your-client-id" \
--data '{"countryCode":"ES"}' \
https://advertising-api-test.amazon.com/v2/profiles/register
Warning: [PLANNED DEPRECATION 1/3/2025] There is a new version 3 Portfolios API, please check the migration guide.
Warning: [PLANNED DEPRECATION 6/30/2023] There is a new version 3 of Sponsored Product API, please check the migration guide.
暂无开放 Issues,或尚未同步最近议题。