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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python-amazon-ad-api-0.1.2.tar.gz.
File metadata
- Download URL: python-amazon-ad-api-0.1.2.tar.gz
- Upload date:
- Size: 36.4 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a32a2a346d5df078c0123b098f5e7df72b1a8d3fee2b68e4d13643c8f00cd184
|
|
| MD5 |
e145533ff235d3ac0a116358f1d1c371
|
|
| BLAKE2b-256 |
05d4dc295d8b7692cab119416b12dfe652bdbebc9f2e6e842f39a28f019ac16c
|
File details
Details for the file python_amazon_ad_api-0.1.2-py3-none-any.whl.
File metadata
- Download URL: python_amazon_ad_api-0.1.2-py3-none-any.whl
- Upload date:
- Size: 65.6 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31bb6958a12087636a6630ee939fbdcd4d6ba2a367d7cc115b0b04557055e0aa
|
|
| MD5 |
d83421b9ff30ce3f23b94d5ace54f2c1
|
|
| BLAKE2b-256 |
23464866198c4c5268269357fae5f90f057a4cb48cd7861f9b561fe39220606e
|
