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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.9.7
+Version: 0.9.9
 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.9}/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*

{python_amazon_ad_api-0.9.7 → python_amazon_ad_api-0.9.9}/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.9/ad_api/api/sp/campaigns.py

@@ -0,0 +1,398 @@
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
+import json
+
+
+class Campaigns(Client):
+    r"""
+    Campaigns(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API - Sponsored Products
+
+    """
+
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns', method='PUT')
+    # @Utils.deprecated
+    # def edit_single_campaign_assistant(
+    #     self,
+    #     campaign_id: int,
+    #     portfolio_id: int = None,
+    #     campaign_name: str = None,
+    #     po_number: str = None,
+    #     account_manager: str = None,
+    #     campaign_status: str = None,
+    #     daily_budget: int = None,
+    #     start_date: str = None,
+    #     end_date: str = None,
+    #     premium_bid_adjustment: bool = None,
+    #     strategy: str = None,
+    #     predicate: str or tuple = None,
+    #     percentage: str or tuple = None,
+    #     **kwargs,
+    # ) -> ApiResponse:
+    #     r"""
+    #     edit_single_campaign_assistant(campaign_id: int, portfolio_id: int = None, campaign_name: str, po_number: str = None, account_manager: str = None, campaign_status: str = None, daily_budget: int, start_date: str, end_date: str = None, premium_bid_adjustment: bool = None, strategy:str = None, predicate:str or tuple = None, percentage:int or tuple = None, **kwargs) -> ApiResponse
+    #
+    #     Edit one campaigns and create the body based on the params provided, at least one of the optional params need to be set or a INVALID_ARGUMENT code is thorwn
+    #
+    #     Kwargs:
+    #         | **campaign_id** (number): [required] The identifier of an existing campaign to update.
+    #         | **portfolio_id** (number): [optional] The identifier of an existing portfolio to which the campaign is associated
+    #         | **campaign_name** (string): [optional] A name for the campaign
+    #         | **po_number** (string): [optional] 'A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers
+    #         | **account_manager** (string): [optional] A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers
+    #         | **campaign_status**': (string): [optional] The current resource state Values: enabled, paused, archived. Default: enabled
+    #         | **daily_budget** (float): [optional] A daily budget for the campaign
+    #         | **start_date** (string): [optional] A starting date for the campaign to go live. The format of the date is YYYYMMDD
+    #         | **end_date** (string): [optional] An ending date for the campaign to stop running. The format of the date is YYYYMMDD
+    #         | **premium_bid_adjustment**' (boolean): [optional] If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information. Tip: When Campaign has been adopted to enhanced bidding premiumBidAdjustment can not be set
+    #         | **strategy** (string): [optional] The bidding strategy. 'Values': legacyForSales (Dynamic bids - down only), autoForSales (Dynamic bids - up and down), manual (Fixed bid)
+    #         | **predicate** (string or tuple(str)): [optional] You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a specified placement. 'Values':  placementTop (str), placementProductPage (str), ("placementTop", "placementProductPage") (tuple)
+    #         | **percentage** (float or tuple(float)): [optional] The bid adjustment percentage value. Example: 15 (float), (15, 25) (tuple)
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #
+    #     optional = {}
+    #
+    #     if portfolio_id is not None:
+    #         optional.update({'portfolioId': portfolio_id})
+    #
+    #     if campaign_name is not None:
+    #         optional.update({'name': campaign_name})
+    #
+    #     if po_number is not None and account_manager is not None:
+    #         optional.update({"tags": {'PONumber': po_number, 'accountManager': account_manager}})
+    #
+    #     if campaign_status is not None:
+    #         optional.update({'state': campaign_status})
+    #
+    #     if daily_budget is not None:
+    #         optional.update({'dailyBudget': daily_budget})
+    #
+    #     if start_date is not None:
+    #         optional.update({'startDate': start_date})
+    #
+    #     if end_date is not None:
+    #         optional.update({'endDate': end_date})
+    #
+    #     if premium_bid_adjustment is not None:
+    #         optional.update({'premiumBidAdjustment': premium_bid_adjustment})
+    #
+    #     if strategy is not None and predicate is None and percentage is None:
+    #         optional.update({'bidding': {'strategy': strategy, 'adjustments': []}})
+    #
+    #     if strategy is not None and predicate is not None and percentage is not None:
+    #         if isinstance(predicate, str):
+    #             optional.update(
+    #                 {
+    #                     'bidding': {
+    #                         'strategy': strategy,
+    #                         'adjustments': [{'predicate': predicate, 'percentage': percentage}],
+    #                     }
+    #                 }
+    #             )
+    #
+    #         if isinstance(predicate, tuple) and len(predicate) == 2 and len(percentage) == 2:
+    #             options = []
+    #             for i in range(len(predicate)):
+    #                 option = {"predicate": predicate[i], "percentage": percentage[i]}
+    #                 options.append(option)
+    #
+    #             bidding = {'strategy': strategy, 'adjustments': options}
+    #
+    #             dictionary = {}
+    #             dictionary["bidding"] = bidding
+    #
+    #             optional.update(dictionary)
+    #
+    #     required = {
+    #         'campaignId': campaign_id,
+    #     }
+    #
+    #     if not optional:
+    #         description = 'No changes submitted for entity %s' % campaign_id
+    #         obj = [{'code': 'INVALID_ARGUMENT', 'description': description}]
+    #         return ApiResponse(obj)
+    #     else:
+    #         required.update(optional)
+    #         data_str = json.dumps([required])
+    #         return self._request(kwargs.pop('path'), data=data_str, params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns', method='POST')
+    # @Utils.deprecated
+    # def create_single_campaign_assistant(
+    #     self,
+    #     campaign_name: str,
+    #     targeting_type: str,
+    #     daily_budget: int,
+    #     start_date: str,
+    #     end_date: str = None,
+    #     campaign_status: str = "enabled",
+    #     portfolio_id: int = None,
+    #     po_number: str = None,
+    #     account_manager: str = None,
+    #     premium_bid_adjustment: bool = None,
+    #     strategy: str = None,
+    #     predicate: str or tuple = None,
+    #     percentage: int or tuple = None,
+    #     **kwargs,
+    # ) -> ApiResponse:
+    #     r"""
+    #     create_single_campaign_assistant(campaign_name: str,targeting_type: str, daily_budget: int, start_date: str, end_date: str = None, campaign_status: str = "enabled", portfolio_id: int = None, po_number: str = None, account_manager: str = None, premium_bid_adjustment: bool = False, strategy:str = None, predicate:str = None, percentage:int = None, **kwargs) -> ApiResponse
+    #
+    #     Creates one campaigns and create the body based on the params provided
+    #
+    #     Kwargs:
+    #
+    #         | **campaign_name** (string): [required] A name for the campaign
+    #         | **campaign_type** (string): [fixed] The advertising product managed by this campaign. Value: sponsoredProducts
+    #         | **targeting_type** (string): [required] The type of targeting for the campaign. Values: manual, auto
+    #         | **daily_budget** (float): [required] A daily budget for the campaign
+    #         | **start_date** (string): [required] A starting date for the campaign to go live. The format of the date is YYYYMMDD
+    #         | **end_date** (string): [optional] An ending date for the campaign to stop running. The format of the date is YYYYMMDD
+    #         | **campaign_status**': (string): [optional] The current resource state Values: enabled, paused, archived. Default: enabled
+    #         | **portfolio_id** (number): [optional] The identifier of an existing portfolio to which the campaign is associated
+    #         | **po_number** (string): [optional] 'A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers
+    #         | **account_manager** (string): [optional] A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers
+    #         | **premium_bid_adjustment**' (boolean) If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.
+    #         | **strategy** (string): [optional] The bidding strategy. 'Values': legacyForSales (Dynamic bids - down only), autoForSales (Dynamic bids - up and down), manual (Fixed bid)
+    #         | **predicate** (string): [optional] You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a specified placement. 'Values':  placementTop, placementProductPage
+    #         | **percentage** (float): [optional] The bid adjustment percentage value.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #
+    #     optional = {}
+    #
+    #     if portfolio_id is not None:
+    #         optional.update({'portfolioId': portfolio_id})
+    #
+    #     if po_number is not None and account_manager is not None:
+    #         optional.update({"tags": {'PONumber': po_number, 'accountManager': account_manager}})
+    #
+    #     if end_date is not None:
+    #         optional.update({'endDate': end_date})
+    #
+    #     if premium_bid_adjustment is not None:
+    #         optional.update({'premiumBidAdjustment': premium_bid_adjustment})
+    #
+    #     if strategy is not None and predicate is not None and percentage is not None:
+    #         if isinstance(predicate, str):
+    #             optional.update(
+    #                 {
+    #                     'bidding': {
+    #                         'strategy': strategy,
+    #                         'adjustments': [{'predicate': predicate, 'percentage': percentage}],
+    #                     }
+    #                 }
+    #             )
+    #
+    #         if isinstance(predicate, tuple) and len(predicate) == 2 and len(percentage) == 2:
+    #             options = []
+    #             for i in range(len(predicate)):
+    #                 option = {"predicate": predicate[i], "percentage": percentage[i]}
+    #                 options.append(option)
+    #
+    #             bidding = {'strategy': strategy, 'adjustments': options}
+    #
+    #             dictionary = {}
+    #             dictionary["bidding"] = bidding
+    #
+    #             optional.update(dictionary)
+    #
+    #     required = {
+    #         'name': campaign_name,
+    #         'campaignType': 'sponsoredProducts',
+    #         'targetingType': targeting_type,
+    #         'state': campaign_status,
+    #         'dailyBudget': daily_budget,
+    #         'startDate': start_date,
+    #     }
+    #
+    #     if optional:
+    #         required.update(optional)
+    #
+    #     data_str = json.dumps([required])
+    #     return self._request(kwargs.pop('path'), data=data_str, params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns', method='POST')
+    # @Utils.deprecated
+    # def create_campaigns(self, **kwargs) -> ApiResponse:
+    #     r"""
+    #     create_campaigns(body: (dict, str, list)) -> ApiResponse
+    #
+    #     Creates one or more campaigns.
+    #
+    #     body: | REQUIRED {'description': 'An array of campaigns.}'
+    #
+    #         | '**portfolioId**': *number*, {'description': 'The identifier of an existing portfolio to which the campaign is associated'}
+    #         | '**name**': *string*, {'description': 'A name for the campaign'}
+    #         | '**tags**': *string*, {'description': 'A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.'}
+    #         | '**campaignType**': *string*, {'description': 'The advertising product managed by this campaign', 'Enum': '[ sponsoredProducts ]'}
+    #         | '**targetingType**': *string*, {'description': 'The type of targeting for the campaign.', 'Enum': '[ manual, auto ]'}
+    #         | '**state**': *string*, {'description': 'The current resource state.', 'Enum': '[ enabled, paused, archived ]'}
+    #         | '**dailyBudget**': *number($float)*, {'description': 'A daily budget for the campaign.'}
+    #         | '**startDate**': *string*, {'description': 'A starting date for the campaign to go live. The format of the date is YYYYMMDD.'}
+    #         | '**endDate**': *string* nullable: true, {'description': 'An ending date for the campaign to stop running. The format of the date is YYYYMMDD.'}
+    #         | '**premiumBidAdjustment**': *boolean*, {'description': 'If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.'}
+    #         | '**bidding**': *Bidding*, {'strategy': 'string', 'Enum': '[ legacyForSales, autoForSales, manual ]', 'adjustments': '{...}'}
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     body = Utils.convert_body(kwargs.pop('body'))
+    #     return self._request(kwargs.pop('path'), data=body, params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns', method='PUT')
+    # @Utils.deprecated
+    # def edit_campaigns(self, **kwargs) -> ApiResponse:
+    #     r"""
+    #     edit_campaigns(body: (dict, str, list)) -> ApiResponse
+    #
+    #     Updates one or more campaigns.
+    #
+    #     body: | REQUIRED {'description': 'An array of campaigns.}'
+    #
+    #         | '**campaignId**': *number*, {'description': 'The identifier of an existing campaign to update.'}
+    #         | '**portfolioId**': *number*, {'description': 'The identifier of an existing portfolio to which the campaign is associated'}
+    #         | '**name**': *string*, {'description': 'The name for the campaign'}
+    #         | '**tags**': *CampaignTags*, {'description': 'A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.'}
+    #         | '**state**': *string*, {'description': 'The current resource state.', 'Enum': '[ enabled, paused, archived ]'}
+    #         | '**dailyBudget**': *number($float)*, {'description': 'The daily budget for the campaign.'}
+    #         | '**startDate**': *string*, {'description': 'The starting date for the campaign to go live. The format of the date is YYYYMMDD.'}
+    #         | '**endDate**': *string* nullable: true, {'description': 'The ending date for the campaign to stop running. The format of the date is YYYYMMDD.'}
+    #         | '**premiumBidAdjustment**': *boolean*, {'description': 'If set to true, Amazon increases the default bid for ads that are eligible to appear in this placement. See developer notes for more information.'}
+    #         | '**bidding**': *Bidding*, {'strategy': 'string', 'Enum': '[ legacyForSales, autoForSales, manual ]', 'adjustments': '{...}'}
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     body = Utils.convert_body(kwargs.pop('body'))
+    #     return self._request(kwargs.pop('path'), data=body, params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns', method='GET')
+    # @Utils.deprecated
+    # def list_campaigns(self, **kwargs) -> ApiResponse:
+    #     r"""
+    #     list_campaigns(**kwargs) -> ApiResponse
+    #
+    #     Gets an array of campaigns.
+    #
+    #         query **startIndex**:*integer* | Optional. 0-indexed record offset for the result set. Default value : 0
+    #
+    #         query **count**:*integer* | Optional. Number of records to include in the paged response. Defaults to max page size.
+    #
+    #         query **stateFilter**:*string* | Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived Default value : enabled, paused, archived.
+    #
+    #         query **name**:*string* | Optional. Restricts results to campaigns with the specified name.
+    #
+    #         query **portfolioIdFilter**:*string* | Optional. A comma-delimited list of portfolio identifiers.
+    #
+    #         query **campaignIdFilter**:*string* | Optional. A comma-delimited list of campaign identifiers.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     return self._request(kwargs.pop('path'), params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns/{}', method='GET')
+    # @Utils.deprecated
+    # def get_campaign(self, campaignId, **kwargs) -> ApiResponse:
+    #     r"""
+    #
+    #     get_campaign(campaignId: int) -> ApiResponse
+    #
+    #     Gets a campaign specified by identifier.
+    #
+    #         path **campaignId**:*number* | Required. The identifier of an existing campaign.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns/{}', method='DELETE')
+    # @Utils.deprecated
+    # def delete_campaign(self, campaignId, **kwargs) -> ApiResponse:
+    #     r"""
+    #
+    #     delete_campaign(campaignId: int) -> ApiResponse
+    #
+    #     Sets the campaign status to archived. Archived entities cannot be made active again. See developer notes for more information.
+    #
+    #         path **campaignId**:*number* | Required. The identifier of an existing campaign.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns/extended', method='GET')
+    # @Utils.deprecated
+    # def list_campaigns_extended(self, **kwargs) -> ApiResponse:
+    #     r"""
+    #     list_campaigns_extended(**kwargs) -> ApiResponse
+    #
+    #     Gets an array of campaigns with extended data fields.
+    #
+    #         query **startIndex**:*integer* | Optional. 0-indexed record offset for the result set. Default value : 0
+    #
+    #         query **count**:*integer* | Optional. Number of records to include in the paged response. Defaults to max page size.
+    #
+    #         query **stateFilter**:*string* | Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived Default value : enabled, paused, archived.
+    #
+    #         query **name**:*string* | Optional. Restricts results to campaigns with the specified name.
+    #
+    #         query **portfolioIdFilter**:*string* | Optional. A comma-delimited list of portfolio identifiers.
+    #
+    #         query **campaignIdFilter**:*string* | Optional. A comma-delimited list of campaign identifiers.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     return self._request(kwargs.pop('path'), params=kwargs)
+    #
+    # DEPRECATED v2 — superseded by v1 endpoints. Kept commented for reference.
+    # @sp_endpoint('/v2/sp/campaigns/extended/{}', method='GET')
+    # @Utils.deprecated
+    # def get_campaign_extended(self, campaignId, **kwargs) -> ApiResponse:
+    #     r"""
+    #     get_campaign_extended(campaignId: int) -> ApiResponse
+    #
+    #     Gets an array of campaigns with extended data fields.
+    #
+    #         path **campaignId**:*number* | Required. The identifier of an existing campaign.
+    #
+    #     Returns:
+    #
+    #         ApiResponse
+    #
+    #     """
+    #     return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)
+    #

python_amazon_ad_api-0.9.9/ad_api/version.py

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

{python_amazon_ad_api-0.9.7 → python_amazon_ad_api-0.9.9}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.9.7
+Version: 0.9.9
 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.9}/setup.cfg

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

{python_amazon_ad_api-0.9.7 → python_amazon_ad_api-0.9.9}/setup.py

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