repository·main·Indexed 41 days ago
https://github.com/denisneuf/python-amazon-ad-apiA Python 3 wrapper for Amazon's Advertising API. It provides modules for Sponsored Products (v3), Sponsored Brands (v3/v4), Sponsored Display, Amazon Attribution, Brand Metrics, and the Demand Side Platform (DSP) API. The library includes built-in support for credential management via YAML, marketplace configuration for NA, EU, and FE, and automated pagination handling via the load_all_categories decorator.
The Sponsored Products API 2.0 allows for management operations across several advertising entities. You can use this API to manage:
The library provides extensive coverage for various Amazon Advertising services. Key modules include:
Profiles, Manager AccountsCampaigns, Ad Groups, Keywords, Negative Keywords, Product Targeting, Budget Rules, etc.Campaigns, Ad Groups, Keywords, Stores, BrandsCampaigns, Ad Groups, Targets, Creatives, ForecastsAmazon Attribution (open beta), Brand Metrics (open beta), DSP (Reports), Portfolios (Note: Portfolios V2 is being deprecated in favor of V3).The ad_api.api.sp.BudgetRules class provides access to Sponsored Product v3 budget rule management.
Important Constraints:
The library provides specialized modules for different Amazon Advertising services. You can interact with the following APIs:
The CampaignNegativeKeywordsV3 class provides methods to manage negative keywords for Sponsored Product campaigns using API version 3.0.
Important Constraints:
Available operations include creating, listing, updating, and deleting campaign negative keywords.
The ad_api.api.Localization class provides operations to localize data used when creating advertising campaigns. Localization includes translating text, converting monetary amounts, or mapping entities (like products or keywords) from a source marketplace to target marketplaces.
Key capabilities include:
The PortfoliosV3 API allows you to manage portfolios that group campaigns together. Notably, the Portfolios API can be used as a sandbox environment for testing purposes.
Key capabilities include:
The python-amazon-ad-api library provides access to Amazon DSP (Demand-Side Platform), allowing advertisers to programmatically buy display, video, and audio ads both on and off Amazon.
For detailed official documentation regarding DSP reports, refer to the Amazon Advertising API documentation: https://advertising.amazon.com/API/docs/en-us/dsp-reports-beta-3p/#/Reports.
The ad_api.api.sp.CampaignOptimization class provides access to Sponsored Product (SP) v3 campaign optimization rules.
Important Constraints:
403 error: {'code': 403, 'message': 'Client does not have access to this API', ...}.The Product Targeting API contains both version 2.0 and version 3.0 endpoints to maintain backward compatibility.
Important Migration Notes:
/v2/sp/targets) and v3.0 endpoints (e.g., /sp/targets/categories/recommendations) to specific methods within the ad_api.api.sp.Targets class.To handle pagination and avoid rate limits when retrieving large sets of audiences, use the @Utils.load_all_categories decorator. This decorator automates the process of following nextToken tokens to fetch all pages.
Decorator Options:
throttle_by_seconds: The number of seconds to wait between requests to prevent throttling.next_token_param: The name of the parameter used for pagination (typically "nextToken").When using this decorator, the decorated function becomes a generator that yields response pages.
import logging
from ad_api.api import Audiences
from ad_api.base import AdvertisingApiException, Utils
@Utils.load_all_categories(throttle_by_seconds=5, next_token_param="nextToken")
def get_all_categories(**kwargs):
return Audiences(debug=True).list_audiences(**kwargs)
if __name__ == '__main__':
request = {
"adType": "SD",
}
for page in get_all_categories(maxResults=20, body=request):
result = page.payload
audiences = result.get("audiences")
for audience in audiences:
logging.info(audience)The BrandSafety class in ad_api.api.sd allows you to manage the Brand Safety Deny List for Sponsored Display campaigns. This list contains websites and apps that the advertiser wants to exclude from their advertising.
Important Limitation: Sponsored Display features are not available for the Sandbox endpoint.