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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.9.7
+Version: 0.9.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -299,6 +299,34 @@ 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)
+
+New unified endpoint generation. Campaigns are queried with a single `POST /adsApi/v1/query/campaigns` resource instead of the versioned v2/v3 endpoints.
+
+| Method | Endpoint | Body |
+|---|---|---|
+| `query_campaigns` | `POST /adsApi/v1/query/campaigns` | filters + `maxResults`/`nextToken` |
+| `create_campaigns` | `POST /adsApi/v1/create/campaigns` | `campaigns[]` (`adProduct`, `name`, `state` required) |
+| `update_campaigns` | `POST /adsApi/v1/update/campaigns` | `campaigns[]` (`campaignId` required) |
+| `delete_campaigns` | `POST /adsApi/v1/delete/campaigns` | `campaignIds[]` |
+
+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
+
+result = sponsored_products.Campaigns(credentials=credentials, debug=True).query_campaigns(
+    body={
+        "adProductFilter": {"include": ["SPONSORED_PRODUCTS"]},
+        "stateFilter": {"include": ["ENABLED"]},
+        "maxResults": 100,
+    }
+)
+
+campaigns = result.payload.get("campaigns")
+next_token = result.payload.get("nextToken")
+```
+
 ### [Modules Available Sponsored Products 2.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v2.html)
 
 Warning: [PLANNED DEPRECATION 6/30/2023]
@@ -307,6 +335,8 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 
 ### [Modules Available Sponsored Products 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v3.html)
 
+Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method instead.
+
 
 * [ThemeBased Bid Recommendation](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/bid_recommendations_v3.html)
 * [Keyword Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/ranked_keywords_recommendations.html)
@@ -375,7 +405,9 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 
 * [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp/reports.html)
 
-### Simple Example Usage Campaigns with Credentials
+### Simple Example Usage Campaigns with Credentials (v3, legacy)
+
+Warning: this example uses `CampaignsV3.list_campaigns`, which is deprecated. See the v1 `query_campaigns` example above.
 
 ```python
 import logging
@@ -443,4 +475,4 @@ We are not affiliated with Amazon but they used our api :)
 
 
 ---
-*Last release: v0.8.9 (via electroduende automated release random access memory)*
+*Last release: v0.9.7*

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

@@ -271,6 +271,34 @@ 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)
+
+New unified endpoint generation. Campaigns are queried with a single `POST /adsApi/v1/query/campaigns` resource instead of the versioned v2/v3 endpoints.
+
+| Method | Endpoint | Body |
+|---|---|---|
+| `query_campaigns` | `POST /adsApi/v1/query/campaigns` | filters + `maxResults`/`nextToken` |
+| `create_campaigns` | `POST /adsApi/v1/create/campaigns` | `campaigns[]` (`adProduct`, `name`, `state` required) |
+| `update_campaigns` | `POST /adsApi/v1/update/campaigns` | `campaigns[]` (`campaignId` required) |
+| `delete_campaigns` | `POST /adsApi/v1/delete/campaigns` | `campaignIds[]` |
+
+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
+
+result = sponsored_products.Campaigns(credentials=credentials, debug=True).query_campaigns(
+    body={
+        "adProductFilter": {"include": ["SPONSORED_PRODUCTS"]},
+        "stateFilter": {"include": ["ENABLED"]},
+        "maxResults": 100,
+    }
+)
+
+campaigns = result.payload.get("campaigns")
+next_token = result.payload.get("nextToken")
+```
+
 ### [Modules Available Sponsored Products 2.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v2.html)
 
 Warning: [PLANNED DEPRECATION 6/30/2023]
@@ -279,6 +307,8 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 
 ### [Modules Available Sponsored Products 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v3.html)
 
+Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method instead.
+
 
 * [ThemeBased Bid Recommendation](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/bid_recommendations_v3.html)
 * [Keyword Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/ranked_keywords_recommendations.html)
@@ -347,7 +377,9 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 
 * [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp/reports.html)
 
-### Simple Example Usage Campaigns with Credentials
+### Simple Example Usage Campaigns with Credentials (v3, legacy)
+
+Warning: this example uses `CampaignsV3.list_campaigns`, which is deprecated. See the v1 `query_campaigns` example above.
 
 ```python
 import logging
@@ -415,4 +447,4 @@ We are not affiliated with Amazon but they used our api :)
 
 
 ---
-*Last release: v0.8.9 (via electroduende automated release random access memory)*
+*Last release: v0.9.7*