python-amazon-ad-api 0.6.2__tar.gz → 0.6.4__tar.gz

{python_amazon_ad_api-0.6.2/python_amazon_ad_api.egg-info → python_amazon_ad_api-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 0.6.2
+Version: 0.6.4
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -13,11 +13,18 @@ Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests<2.33.0,>=2.27.1
-Requires-Dist: six~=1.16.0
+Requires-Dist: six<1.18,>=1.16
 Requires-Dist: cachetools<5.6,>=5.0
-Requires-Dist: pycryptodome<3.22,>=3.13
-Requires-Dist: pytz<2025.0,>=2021.3
+Requires-Dist: pycryptodome<3.23,>=3.13
+Requires-Dist: pytz<2026.0,>=2021.3
 Requires-Dist: confuse<2.1,>=1.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # PYTHON-AMAZON-AD-API
 
@@ -25,7 +32,9 @@ Requires-Dist: confuse<2.1,>=1.7
 ![CodeQL](https://img.shields.io/badge/Docs-sphinx-green)
 ![CodeQL](https://img.shields.io/github/v/release/denisneuf/python-amazon-ad-api)
 [![Documentation Status](https://readthedocs.org/projects/python-amazon-ad-api/badge/?version=latest)](https://python-amazon-ad-api.readthedocs.io/en/latest/?badge=latest)
-
+![PyPI Downloads](https://static.pepy.tech/badge/python-amazon-ad-api)
+[![Downloads](https://static.pepy.tech/badge/python-amazon-ad-api/month)](https://pepy.tech/project/python-amazon-ad-api)
+[![Downloads](https://static.pepy.tech/badge/python-amazon-ad-api/week)](https://pepy.tech/project/python-amazon-ad-api)
 
 ## Amazon's Advertising API
 
@@ -67,7 +76,19 @@ my_credentials = dict(
     profile_id='your-profile_id',
 )
 
-result=sponsored_products.Campaigns(credentials=my_credentials).list_campaigns()
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
+result = sponsored_products.CampaignsV3(credentials=my_credentials).list_campaigns(
+    body=info
+)
 
 ```
 
@@ -99,9 +120,9 @@ Python code
 from ad_api.api import sponsored_products
 
 # Leave empty will use the 'default' account
-result=sponsored_products.Campaigns().list_campaigns()
+result=sponsored_products.CampaignsV3().list_campaigns()
 # will use germany account data
-result=sponsored_products.Campaigns(account="germany").list_campaigns()
+result=sponsored_products.CampaignsV3(account="germany").list_campaigns()
 ```
 
 
@@ -125,7 +146,7 @@ from ad_api.api import sponsored_products
 from ad_api.base import Marketplaces
 
 # You can pass NA or US, CA, MX or BR for North America and JP, AU or SG for Far East
-result=sponsored_products.Campaigns(marketplace=Marketplaces.NA).list_campaigns()
+result=sponsored_products.CampaignsV3(marketplace=Marketplaces.NA).list_campaigns()
 
 ```
 
@@ -137,10 +158,20 @@ You can use a [try](https://docs.python.org/3.10/reference/compound_stmts.html#t
 from ad_api.api import sponsored_products
 from ad_api.base import AdvertisingApiException
 
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
 try:
 
-    result = sponsored_products.Campaigns().get_campaign_extended(
-        campaignId=campaign_id
+    result = sponsored_products.CampaignsV3().list_campaigns(
+        body=info
     )
 
     logging.info(result)
@@ -157,10 +188,21 @@ Use debug=True if you want see some logs like the header you submit to the api e
 from ad_api.api import sponsored_products
 from ad_api.base import AdvertisingApiException
 
+
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
 try:
 
-    result = sponsored_products.Campaigns(debug=True).get_campaign_extended(
-        campaignId=campaign_id
+    result = sponsored_products.CampaignsV3(debug=True).list_campaigns(
+        body=info
     )
 
     logging.info(result)
@@ -220,7 +262,12 @@ curl \
 
 * [Profiles](https://python-amazon-ad-api.readthedocs.io/en/latest/api/profiles.html)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/api/manager_accounts.html)
+
+Warning: [PLANNED DEPRECATION 1/3/2025]
+There is a new version 3 Portfolios API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/portfolios-v2-v3).
+
 * [Portfolios](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfolios.html)
+* [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [Invoices](https://python-amazon-ad-api.readthedocs.io/en/latest/api/invoices.html)
 * [Billing](https://python-amazon-ad-api.readthedocs.io/en/latest/api/billing.html)
 * [Audiences](https://python-amazon-ad-api.readthedocs.io/en/latest/api/audiences.html)
@@ -332,38 +379,52 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 ```python
 import logging
 from ad_api.base import AdvertisingApiException
-from ad_api.api.sp import Campaigns
+from ad_api.api import sponsored_products
 
 logging.basicConfig(
     level=logging.DEBUG,
     format="%(asctime)s:%(levelname)s:%(message)s"
 )
 
+def sp_list_campaigns_v3(info: dict = None):
 
-credentials = dict(
-    refresh_token='your-refresh_token',
-    client_id='your-client_id',
-    client_secret='your-client_secret',
-    profile_id='your-profile_id',
-)
+    credentials = dict(
+        refresh_token='your-refresh_token',
+        client_id='your-client_id',
+        client_secret='your-client_secret',
+        profile_id='your-profile_id',
+    )
 
-try:
+    try:
+        result = sponsored_products.CampaignsV3(credentials=credentials, debug=True).list_campaigns(
+            body=info
+        )
+        payload = result.payload
+        return payload
+    except AdvertisingApiException as error:
+        logging.error(error)
+        logging.error(error.code)
 
-    states = 'enabled'
 
-    res = Campaigns(credentials=credentials, debug=True).list_campaigns_extended(
-        stateFilter=states
-    )
+state_filter = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
 
-    campaigns = res.payload
-    for campaign in campaigns:
-        logging.info(campaign)
+enabled_campaigns = sp_list_campaigns_v3(state_filter).get("campaigns")
 
-    logging.info(len(campaigns))
+
+for campaign in enabled_campaigns:
+    logging.info(campaign)
+
+logging.info(len(campaigns))
 
 
-except AdvertisingApiException as error:
-    logging.info(error)
 
 ```
 

python_amazon_ad_api-0.6.2/PKG-INFO → python_amazon_ad_api-0.6.4/README.md

@@ -1,31 +1,12 @@
-Metadata-Version: 2.1
-Name: python-amazon-ad-api
-Version: 0.6.2
-Summary: Python wrapper for the Amazon Advertising API
-Home-page: https://github.com/denisneuf/python-amazon-ad-api
-Author: Daniel Alvaro
-Author-email: denisneuf@hotmail.com
-License: MIT
-Project-URL: Bug Tracker, https://github.com/denisneuf/python-amazon-ad-api/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests<2.33.0,>=2.27.1
-Requires-Dist: six~=1.16.0
-Requires-Dist: cachetools<5.6,>=5.0
-Requires-Dist: pycryptodome<3.22,>=3.13
-Requires-Dist: pytz<2025.0,>=2021.3
-Requires-Dist: confuse<2.1,>=1.7
-
 # PYTHON-AMAZON-AD-API
 
 ![CodeQL](https://img.shields.io/badge/coverage-95%25-green)
 ![CodeQL](https://img.shields.io/badge/Docs-sphinx-green)
 ![CodeQL](https://img.shields.io/github/v/release/denisneuf/python-amazon-ad-api)
 [![Documentation Status](https://readthedocs.org/projects/python-amazon-ad-api/badge/?version=latest)](https://python-amazon-ad-api.readthedocs.io/en/latest/?badge=latest)
-
+![PyPI Downloads](https://static.pepy.tech/badge/python-amazon-ad-api)
+[![Downloads](https://static.pepy.tech/badge/python-amazon-ad-api/month)](https://pepy.tech/project/python-amazon-ad-api)
+[![Downloads](https://static.pepy.tech/badge/python-amazon-ad-api/week)](https://pepy.tech/project/python-amazon-ad-api)
 
 ## Amazon's Advertising API
 
@@ -67,7 +48,19 @@ my_credentials = dict(
     profile_id='your-profile_id',
 )
 
-result=sponsored_products.Campaigns(credentials=my_credentials).list_campaigns()
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
+result = sponsored_products.CampaignsV3(credentials=my_credentials).list_campaigns(
+    body=info
+)
 
 ```
 
@@ -99,9 +92,9 @@ Python code
 from ad_api.api import sponsored_products
 
 # Leave empty will use the 'default' account
-result=sponsored_products.Campaigns().list_campaigns()
+result=sponsored_products.CampaignsV3().list_campaigns()
 # will use germany account data
-result=sponsored_products.Campaigns(account="germany").list_campaigns()
+result=sponsored_products.CampaignsV3(account="germany").list_campaigns()
 ```
 
 
@@ -125,7 +118,7 @@ from ad_api.api import sponsored_products
 from ad_api.base import Marketplaces
 
 # You can pass NA or US, CA, MX or BR for North America and JP, AU or SG for Far East
-result=sponsored_products.Campaigns(marketplace=Marketplaces.NA).list_campaigns()
+result=sponsored_products.CampaignsV3(marketplace=Marketplaces.NA).list_campaigns()
 
 ```
 
@@ -137,10 +130,20 @@ You can use a [try](https://docs.python.org/3.10/reference/compound_stmts.html#t
 from ad_api.api import sponsored_products
 from ad_api.base import AdvertisingApiException
 
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
 try:
 
-    result = sponsored_products.Campaigns().get_campaign_extended(
-        campaignId=campaign_id
+    result = sponsored_products.CampaignsV3().list_campaigns(
+        body=info
     )
 
     logging.info(result)
@@ -157,10 +160,21 @@ Use debug=True if you want see some logs like the header you submit to the api e
 from ad_api.api import sponsored_products
 from ad_api.base import AdvertisingApiException
 
+
+info = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
+
 try:
 
-    result = sponsored_products.Campaigns(debug=True).get_campaign_extended(
-        campaignId=campaign_id
+    result = sponsored_products.CampaignsV3(debug=True).list_campaigns(
+        body=info
     )
 
     logging.info(result)
@@ -220,7 +234,12 @@ curl \
 
 * [Profiles](https://python-amazon-ad-api.readthedocs.io/en/latest/api/profiles.html)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/api/manager_accounts.html)
+
+Warning: [PLANNED DEPRECATION 1/3/2025]
+There is a new version 3 Portfolios API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/portfolios-v2-v3).
+
 * [Portfolios](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfolios.html)
+* [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [Invoices](https://python-amazon-ad-api.readthedocs.io/en/latest/api/invoices.html)
 * [Billing](https://python-amazon-ad-api.readthedocs.io/en/latest/api/billing.html)
 * [Audiences](https://python-amazon-ad-api.readthedocs.io/en/latest/api/audiences.html)
@@ -332,38 +351,52 @@ There is a new version 3 of Sponsored Product API, please check the [migration g
 ```python
 import logging
 from ad_api.base import AdvertisingApiException
-from ad_api.api.sp import Campaigns
+from ad_api.api import sponsored_products
 
 logging.basicConfig(
     level=logging.DEBUG,
     format="%(asctime)s:%(levelname)s:%(message)s"
 )
 
+def sp_list_campaigns_v3(info: dict = None):
 
-credentials = dict(
-    refresh_token='your-refresh_token',
-    client_id='your-client_id',
-    client_secret='your-client_secret',
-    profile_id='your-profile_id',
-)
+    credentials = dict(
+        refresh_token='your-refresh_token',
+        client_id='your-client_id',
+        client_secret='your-client_secret',
+        profile_id='your-profile_id',
+    )
 
-try:
+    try:
+        result = sponsored_products.CampaignsV3(credentials=credentials, debug=True).list_campaigns(
+            body=info
+        )
+        payload = result.payload
+        return payload
+    except AdvertisingApiException as error:
+        logging.error(error)
+        logging.error(error.code)
 
-    states = 'enabled'
 
-    res = Campaigns(credentials=credentials, debug=True).list_campaigns_extended(
-        stateFilter=states
-    )
+state_filter = \
+    {
+        "stateFilter":
+            {
+                "include": [
+                    "ENABLED"
+                ]
+            }
+    }
 
-    campaigns = res.payload
-    for campaign in campaigns:
-        logging.info(campaign)
+enabled_campaigns = sp_list_campaigns_v3(state_filter).get("campaigns")
 
-    logging.info(len(campaigns))
+
+for campaign in enabled_campaigns:
+    logging.info(campaign)
+
+logging.info(len(campaigns))
 
 
-except AdvertisingApiException as error:
-    logging.info(error)
 
 ```
 

{python_amazon_ad_api-0.6.2 → python_amazon_ad_api-0.6.4}/ad_api/api/__init__.py

@@ -10,6 +10,7 @@ from .creative_assets import CreativeAssets
 from .localization import Localization
 from .audiences import Audiences
 from .portfolios import Portfolios
+from .portfolios_v3 import PortfoliosV3
 from .insights import Insights
 from . import sp as sponsored_products
 from . import sb as sponsored_brands

{python_amazon_ad_api-0.6.2 → python_amazon_ad_api-0.6.4}/ad_api/api/portfolios.py

@@ -5,6 +5,7 @@ class Portfolios(Client):
     """ """
 
     @sp_endpoint('/v2/portfolios', method='GET')
+    @Utils.deprecated
     def list_portfolios(self, **kwargs) -> ApiResponse:
         r"""
 
@@ -27,6 +28,7 @@ class Portfolios(Client):
         return self._request(kwargs.pop('path'), params=kwargs)
 
     @sp_endpoint('/v2/portfolios/extended', method='GET')
+    @Utils.deprecated
     def list_portfolios_extended(self, **kwargs) -> ApiResponse:
         r"""
         list_portfolios_extended(**kwargs) -> ApiResponse
@@ -47,6 +49,7 @@ class Portfolios(Client):
         return self._request(kwargs.pop('path'), params=kwargs)
 
     @sp_endpoint('/v2/portfolios/{}', method='GET')
+    @Utils.deprecated
     def get_portfolio(self, portfolioId, **kwargs) -> ApiResponse:
         r"""
         get_portfolio(portfolioId) -> ApiResponse
@@ -59,6 +62,7 @@ class Portfolios(Client):
         return self._request(fill_query_params(kwargs.pop('path'), portfolioId), params=kwargs)
 
     @sp_endpoint('/v2/portfolios/extended/{}', method='GET')
+    @Utils.deprecated
     def get_portfolio_extended(self, portfolioId, **kwargs) -> ApiResponse:
         r"""
         get_portfolio_extended(portfolioId) -> ApiResponse
@@ -71,6 +75,7 @@ class Portfolios(Client):
         return self._request(fill_query_params(kwargs.pop('path'), portfolioId), params=kwargs)
 
     @sp_endpoint('/v2/portfolios', method='POST')
+    @Utils.deprecated
     def create_portfolios(self, **kwargs) -> ApiResponse:
         r"""
 
@@ -98,6 +103,7 @@ class Portfolios(Client):
         return self._request(kwargs.pop('path'), data=body, params=kwargs)
 
     @sp_endpoint('/v2/portfolios', method='PUT')
+    @Utils.deprecated
     def edit_portfolios(self, **kwargs) -> ApiResponse:
         r"""
 

python_amazon_ad_api-0.6.4/ad_api/api/portfolios_v3.py

@@ -0,0 +1,68 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class PortfoliosV3(Client):
+    """ """
+
+    @sp_endpoint('/portfolios/list', method='POST')
+    def list_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+
+        list_portfolios(body: (str, dict)) -> ApiResponse
+
+        """
+
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+
+
+    @sp_endpoint('/portfolios', method='POST')
+    def create_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+
+        create_portfolios(body: (str, dict)) -> ApiResponse
+
+
+        """
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/portfolios', method='PUT')
+    def edit_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+
+        edit_portfolios(body: (str, dict)) -> ApiResponse
+
+
+        """
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+
+    @sp_endpoint('/portfolios/budget/usage', method='POST')
+    def get_budget_usage_for_portfolios(self, version: int = 1, **kwargs) -> ApiResponse:
+        r"""
+
+        get_budget_usage_for_portfolios(body: (str, dict)) -> ApiResponse
+
+
+        """
+        schema_version = 'application/vnd.portfoliobudgetusage.v' + str(version) + '+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-0.6.4/ad_api/version.py

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