python-amazon-ad-api 0.9.8__tar.gz → 1.0.0__tar.gz

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.9.8
+Version: 1.0.0
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -299,9 +299,13 @@ There is a new version 3 Portfolios API, please check the [migration guide](http
 * [Get test account information](https://python-amazon-ad-api.readthedocs.io/en/latest/api/advertising_test_account.html#ad_api.api.AdvertisingTestAccount.AdvertisingTestAccount.get_test_account)
 
 
-### Sponsored Products v1 (new)
+### Amazon Ads API v1 (new, unified)
 
-New unified endpoint generation. Campaigns are queried with a single `POST /adsApi/v1/query/campaigns` resource instead of the versioned v2/v3 endpoints.
+The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call targets the same resource and the product is selected in the request body with `adProductFilter`. It supersedes the per-product v2/v3 endpoints.
+
+```python
+from ad_api.api import v1
+```
 
 | Method | Endpoint | Body |
 |---|---|---|
@@ -313,9 +317,9 @@ New unified endpoint generation. Campaigns are queried with a single `POST /adsA
 All four return a **207 MultiStatus** response (except `query_campaigns`, which returns 200), so check the payload for per-entity errors.
 
 ```python
-from ad_api.api import sponsored_products
+from ad_api.api import v1
 
-result = sponsored_products.Campaigns(credentials=credentials, debug=True).query_campaigns(
+result = v1.Campaigns(credentials=credentials, debug=True).query_campaigns(
     body={
         "adProductFilter": {"include": ["SPONSORED_PRODUCTS"]},
         "stateFilter": {"include": ["ENABLED"]},

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/README.md

@@ -271,9 +271,13 @@ There is a new version 3 Portfolios API, please check the [migration guide](http
 * [Get test account information](https://python-amazon-ad-api.readthedocs.io/en/latest/api/advertising_test_account.html#ad_api.api.AdvertisingTestAccount.AdvertisingTestAccount.get_test_account)
 
 
-### Sponsored Products v1 (new)
+### Amazon Ads API v1 (new, unified)
 
-New unified endpoint generation. Campaigns are queried with a single `POST /adsApi/v1/query/campaigns` resource instead of the versioned v2/v3 endpoints.
+The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call targets the same resource and the product is selected in the request body with `adProductFilter`. It supersedes the per-product v2/v3 endpoints.
+
+```python
+from ad_api.api import v1
+```
 
 | Method | Endpoint | Body |
 |---|---|---|
@@ -285,9 +289,9 @@ New unified endpoint generation. Campaigns are queried with a single `POST /adsA
 All four return a **207 MultiStatus** response (except `query_campaigns`, which returns 200), so check the payload for per-entity errors.
 
 ```python
-from ad_api.api import sponsored_products
+from ad_api.api import v1
 
-result = sponsored_products.Campaigns(credentials=credentials, debug=True).query_campaigns(
+result = v1.Campaigns(credentials=credentials, debug=True).query_campaigns(
     body={
         "adProductFilter": {"include": ["SPONSORED_PRODUCTS"]},
         "stateFilter": {"include": ["ENABLED"]},

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/ad_api/api/__init__.py

@@ -12,6 +12,7 @@ from .audiences import Audiences
 from .portfolios import Portfolios
 from .portfolios_v3 import PortfoliosV3
 from .insights import Insights
+from . import v1
 from . import sp as sponsored_products
 from . import sb as sponsored_brands
 from . import sd as sponsored_display
@@ -26,6 +27,7 @@ from .exports import Exports
 from .stores import Stores
 
 __all__ = [
+    "v1",
     "sp",
     "sb",
     "sd",

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/ad_api/api/sp/campaigns.py

@@ -396,167 +396,3 @@ class Campaigns(Client):
     #     """
     #     return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)
     #
-    @sp_endpoint('/adsApi/v1/query/campaigns', method='POST')
-    def query_campaigns(self, **kwargs) -> ApiResponse:
-        r"""
-        query_campaigns(body: dict) -> ApiResponse
-
-        Amazon Ads API v1 - Query Campaigns (operationId: QueryCampaign)
-
-        Request Body [Required]
-            | **adProductFilter** (dict): [required]
-                | **include** (list<AdProduct>) : Enum [ AMAZON_DSP, SPONSORED_BRANDS, SPONSORED_DISPLAY, SPONSORED_PRODUCTS, SPONSORED_TELEVISION ]
-            | **campaignIdFilter** (dict) [optional]
-                | **include** (list<string>) : Campaign identifiers
-            | **goalFilter** (dict) [optional]
-                | **include** (list<Goal>) : Enum [ AWARENESS, CONSIDERATION, CONVERSIONS ]
-            | **marketplaceScopeFilter** (dict) [optional]
-                | **include** (list<MarketplaceScope>) : Enum [ GLOBAL, SINGLE_MARKETPLACE ]
-            | **nameFilter** (dict) [optional]
-                | **include** (list<string>) : Campaign names
-                | **queryTermMatchType** (string) : [required] Enum [ BROAD_MATCH, EXACT_MATCH ]
-            | **portfolioIdFilter** (dict) [optional]
-                | **include** (list<string>) : Portfolio identifiers
-            | **retailerScopeFilter** (dict) [optional]
-                | **include** (list<RetailerScope>) : Enum [ AMAZON, OTHER_RETAILERS ]
-            | **stateFilter** (dict) [optional]
-                | **include** (list<State>) : Enum [ ARCHIVED, DRAFT, ENABLED, PAUSED ]
-            | **maxResults** (int) [optional] Minimum 1, Maximum 1000
-            | **nextToken** (string) [optional] Token to navigate to the next page
-
-        Headers
-            | **Amazon-Ads-AccountId** (string) [optional] Advertiser account identifier
-
-        Returns
-            ApiResponse
-                | **campaigns** (list), **nextToken** (string)
-
-        """
-        schema_version = 'application/json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/adsApi/v1/delete/campaigns', method='POST')
-    def delete_campaigns(self, **kwargs) -> ApiResponse:
-        r"""
-        delete_campaigns(body: dict) -> ApiResponse
-
-        Amazon Ads API v1 - Delete Campaigns (operationId: DeleteCampaign)
-
-        Request Body [Required]
-            | **campaignIds** (list<string>) : [required] Campaign identifiers to delete
-
-        Headers
-            | **Amazon-Ads-AccountId** (string) [optional] Advertiser account identifier
-
-        Returns
-            ApiResponse
-                | **207** MultiStatus response with partial errors. Inspect the payload
-                  to know which campaign ids succeeded and which failed.
-
-        """
-        schema_version = 'application/json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/adsApi/v1/update/campaigns', method='POST')
-    def update_campaigns(self, **kwargs) -> ApiResponse:
-        r"""
-        update_campaigns(body: dict) -> ApiResponse
-
-        Amazon Ads API v1 - Update Campaigns (operationId: UpdateCampaign)
-
-        Request Body [Required]
-            | **campaigns** (list<dict>) : [required] One or more campaign objects to update.
-              Each object requires **campaignId** and may include any of the fields below.
-
-        Campaign fields [optional except campaignId]
-            | **campaignId** (string) : [required] The identifier of the campaign to update.
-            | **adProduct** (string) : Enum [ AMAZON_DSP, SPONSORED_BRANDS, SPONSORED_DISPLAY, SPONSORED_PRODUCTS, SPONSORED_TELEVISION ]
-            | **name** (string) : The name of the campaign.
-            | **state** (string) : Enum [ DRAFT, ENABLED, PAUSED ]
-            | **budgets** (list<dict>) : Budget objects for the campaign.
-            | **startDateTime** (string) : Campaign start date and time.
-            | **endDateTime** (string) : Campaign end date and time.
-            | **portfolioId** (string) : The identifier of the portfolio.
-            | **purchaseOrderNumber** (string) : Advertiser purchase order number.
-            | **tags** (list<dict>) : Advertiser-specified custom identifiers.
-            | **marketplaces** (list<dict>) : Marketplaces where the campaign runs.
-            | **marketplaceConfigurations** (list<dict>) : Per-marketplace overrides.
-            | **countries** (list<string>) : Country codes.
-            | **costType** (string) : Enum [ CPC, CPM, FIXED_PRICE, VCPM ]
-            | **fees** (list<dict>) : Fee definitions.
-            | **flights** (list<dict>) : Flight schedules.
-            | **frequencies** (list<dict>) : Frequency cap definitions.
-            | **optimizations** (dict) : Campaign optimization settings.
-            | **siteRestrictions** (list<dict>) : Site restrictions.
-            | **skanAppId** (string) : SKAdNetwork app id.
-            | **targetedPGDealId** (string) : Targeted programmatic guaranteed deal id.
-            | **adomains** (list<string>) : Ad domains.
-
-        Headers
-            | **Amazon-Ads-AccountId** (string) [optional] Advertiser account identifier
-
-        Returns
-            ApiResponse
-                | **207** MultiStatus response with partial errors. Inspect the payload
-                  to know which campaigns succeeded and which failed.
-
-        """
-        schema_version = 'application/json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/adsApi/v1/create/campaigns', method='POST')
-    def create_campaigns(self, **kwargs) -> ApiResponse:
-        r"""
-        create_campaigns(body: dict) -> ApiResponse
-
-        Amazon Ads API v1 - Create Campaigns (operationId: CreateCampaign)
-
-        Request Body [Required]
-            | **campaigns** (list<dict>) : [required] One or more campaign objects to create.
-              Each object requires **adProduct**, **name** and **state**.
-
-        Campaign fields
-            | **adProduct** (string) : [required] Enum [ AMAZON_DSP, SPONSORED_BRANDS, SPONSORED_DISPLAY, SPONSORED_PRODUCTS, SPONSORED_TELEVISION ]
-            | **name** (string) : [required] The name of the campaign.
-            | **state** (string) : [required] Enum [ DRAFT, ENABLED, PAUSED ]
-            | **budgets** (list<dict>) : Budget objects for the campaign.
-                | **budgetType** (string) : [required] Budget type.
-                | **budgetValue** (dict) : [required] Budget amount.
-                | **recurrenceTimePeriod** (string) : [required] Recurrence period.
-            | **startDateTime** (string) : Campaign start date and time.
-            | **endDateTime** (string) : Campaign end date and time.
-            | **portfolioId** (string) : The identifier of the portfolio.
-            | **purchaseOrderNumber** (string) : Advertiser purchase order number.
-            | **tags** (list<dict>) : [required key+value] Advertiser-specified custom identifiers.
-            | **marketplaces** (list<dict>) : Marketplaces where the campaign runs.
-            | **marketplaceConfigurations** (list<dict>) : Per-marketplace overrides, each with
-              **marketplace** and **overrides** (both required).
-            | **countries** (list<string>) : Country codes.
-            | **costType** (string) : Enum [ CPC, CPM, FIXED_PRICE, VCPM ]
-            | **fees** (list<dict>) : [required feeType+feeValue+feeValueType] Fee definitions.
-            | **flights** (list<dict>) : [required budget+startDateTime+endDateTime] Flight schedules.
-            | **frequencies** (list<dict>) : [required eventMaxCount+frequencyTargetingSetting+
-              timeCount+timeUnit] Frequency cap definitions.
-            | **optimizations** (dict) : Campaign optimization settings.
-            | **siteRestrictions** (list<dict>) : Site restrictions.
-            | **brandId** (string) : Brand identifier.
-            | **skanAppId** (string) : SKAdNetwork app id.
-            | **targetedPGDealId** (string) : Targeted programmatic guaranteed deal id.
-            | **adomains** (list<string>) : Ad domains.
-            | **autoCreationSettings** (dict) : Automatic creation settings.
-
-        Headers
-            | **Amazon-Ads-AccountId** (string) [optional] Advertiser account identifier
-
-        Returns
-            ApiResponse
-                | **207** MultiStatus response with partial errors. Inspect the payload
-                  to know which campaigns were created and which failed.
-
-        """
-        schema_version = 'application/json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

python_amazon_ad_api-1.0.0/ad_api/version.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.9.8
+Version: 1.0.0
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -299,9 +299,13 @@ There is a new version 3 Portfolios API, please check the [migration guide](http
 * [Get test account information](https://python-amazon-ad-api.readthedocs.io/en/latest/api/advertising_test_account.html#ad_api.api.AdvertisingTestAccount.AdvertisingTestAccount.get_test_account)
 
 
-### Sponsored Products v1 (new)
+### Amazon Ads API v1 (new, unified)
 
-New unified endpoint generation. Campaigns are queried with a single `POST /adsApi/v1/query/campaigns` resource instead of the versioned v2/v3 endpoints.
+The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call targets the same resource and the product is selected in the request body with `adProductFilter`. It supersedes the per-product v2/v3 endpoints.
+
+```python
+from ad_api.api import v1
+```
 
 | Method | Endpoint | Body |
 |---|---|---|
@@ -313,9 +317,9 @@ New unified endpoint generation. Campaigns are queried with a single `POST /adsA
 All four return a **207 MultiStatus** response (except `query_campaigns`, which returns 200), so check the payload for per-entity errors.
 
 ```python
-from ad_api.api import sponsored_products
+from ad_api.api import v1
 
-result = sponsored_products.Campaigns(credentials=credentials, debug=True).query_campaigns(
+result = v1.Campaigns(credentials=credentials, debug=True).query_campaigns(
     body={
         "adProductFilter": {"include": ["SPONSORED_PRODUCTS"]},
         "stateFilter": {"include": ["ENABLED"]},

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = python-amazon-ad-api
-version = 0.9.8
+version = 1.0.0
 author = Daniel Alvaro
 author_email = denisneuf@hotmail.com
 description = Python wrapper for the Amazon Advertising API

{python_amazon_ad_api-0.9.8 → python_amazon_ad_api-1.0.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='0.9.8',
+    version='1.0.0',
     install_requires=[
         "requests>=2.27.1,<2.35.0",
         "six>=1.16,<1.18",

python_amazon_ad_api-0.9.8/ad_api/version.py

@@ -1 +0,0 @@
-__version__ = "0.9.8"