PYTHON-AMAZON-AD-API [AMAZON ADVERTISING]
Python Amazon Advertising Api
Install
pip install python-amazon-ad-api
Donate
If you find this project is useful consider donating to keep on going on it
Set Up
Create a .env file and put in the root of your project ( SANDBOX or PRODUCTION )
# environment variables defined inside a .env file
AWS_ENV=SANDBOX
.
├── .env
└── campaign_client.py
Switcher SandBox Environment
Use a .env to manage the environment. Is high recommended try the SANDBOX environment as some features may delete (archive) modules as campaigns, ad groups,...etc and this cannot be undone.
AWS_ENV=SANDBOX
# AWS_ENV=PRODUCTION
You may create a test profile id to include in your credentials 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
Credentials
Use a credentials.yml file with your credentials if you dont know how to obtain your refresh token, please visit:
version: '1.0'
default:
refresh_token: 'your-refresh-token'
client_id: 'your-client-id'
client_secret: 'your-client-secret'
profile_id: 'your-profile-id'
Search path for credentials.yml
- macOS and Other Unix:
~/.config/python-ad-api - Windows:
%APPDATA%\python-ad-apiwhere the APPDATA environment variable falls back to%HOME%\AppData\Roamingif undefined
Modules Available Common Resources
- Profiles
- Invoices aka Billing
- Elegibility
- Metadata aka Product metadata
- History
- Localization
- Audiences
- Portfolios
- Insights
Modules Available Sponsored Products
- Ad Groups
- Bid Recommendations
- Campaigns
- Keywords
- Negative Keywords
- Product Ads
- Suggested Keywords
- Product Targeting
- Negative Product Targeting
- Campaign Negative Keywords
- Reports
- Snapshots
Modules Available Sponsored Brands
- Campaigns
- AdGroups
- Keywords
- Negative Keywords
- Product Targeting
- Negative Product Targeting
- Targeting Recommendations
- Bid Recommendations
- Stores
- Landing Page Asins
- Media
- Brands
- Moderation
- Reports
Modules Available Sponsored Display
- Campaigns
- AdGroups
- Reports
Usage Campaigns
import logging
from ad_api.base import AdvertisingApiException, Marketplaces
from ad_api.api.sp import Campaigns
logging.basicConfig(
level=logging.DEBUG,
format="%(asctime)s:%(levelname)s:%(message)s"
)
try:
states = 'enabled'
res = Campaigns().list_campaigns_extended(
stateFilter=states
)
campaigns = res.payload
for campaign in campaigns:
logging.info(campaign)
logging.info(len(campaigns))
except AdvertisingApiException as ex:
print(ex)
LICENSE
1 maintainer
Metadata
1 maintainer
Release files for python-amazon-ad-api 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| python-amazon-ad-api-0.1.2.tar.gz | 36.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| python_amazon_ad_api-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 102.0 kB
Release files / python-amazon-ad-api-0.1.2.tar.gz
| Download URL | python-amazon-ad-api-0.1.2.tar.gz |
|---|---|
| Size | 36.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a32a2a346d5df078c0123b098f5e7df72b1a8d3fee2b68e4d13643c8f00cd184
|
|
BLAKE2b-256 checksum How to use checksums |
05d4dc295d8b7692cab119416b12dfe652bdbebc9f2e6e842f39a28f019ac16c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.2
|
Release files / python_amazon_ad_api-0.1.2-py3-none-any.whl
| Download URL | python_amazon_ad_api-0.1.2-py3-none-any.whl |
|---|---|
| Size | 65.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
31bb6958a12087636a6630ee939fbdcd4d6ba2a367d7cc115b0b04557055e0aa
|
|
BLAKE2b-256 checksum How to use checksums |
23464866198c4c5268269357fae5f90f057a4cb48cd7861f9b561fe39220606e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.2
|
