python-amazon-ad-api 0.5.6__tar.gz → 0.5.8__tar.gz

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: python-amazon-ad-api
-Version: 0.5.6
+Version: 0.5.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
-Author-email: info@leadtech.es
+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
@@ -12,9 +12,9 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests<2.32.0,>=2.27.1
+Requires-Dist: requests<2.33.0,>=2.27.1
 Requires-Dist: six~=1.16.0
-Requires-Dist: cachetools<5.4,>=5.0
+Requires-Dist: cachetools<5.6,>=5.0
 Requires-Dist: pycryptodome<3.21,>=3.13
 Requires-Dist: pytz<2025.0,>=2021.3
 Requires-Dist: confuse<2.1,>=1.7

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/ad_api/api/__init__.py

@@ -1,3 +1,4 @@
+from .account import Account
 from .profiles import Profiles
 from .manager_accounts import ManagerAccounts
 from .invoices import Invoices
@@ -50,5 +51,6 @@ __all__ = [
     "Recommendations",
     "Stream",
     "Exports",
-    "Stores"
+    "Stores",
+    "Account"
 ]

python_amazon_ad_api-0.5.8/ad_api/api/account.py

@@ -0,0 +1,53 @@
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
+
+
+class Account(Client):
+    @sp_endpoint('/adsAccounts/list', method='POST')
+    def list_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        list_accounts(body: (dict, str)) -> ApiResponse
+
+        body: | Optional
+            | **max_results** (int) Number of records to include in the paginated response. Defaults to max page size for given API. Minimum 10 and a Maximum of 100 [optional]
+            | **next_token** (string) Token value allowing to navigate to the next response page. [optional]
+
+        Returns: List all advertising accounts for the user associated with the access token.
+        """
+        schema_version = 'application/vnd.listaccountsresource.v1+json'
+        headers = {'Accept': schema_version, 'Content-Type': schema_version}
+
+        body = Utils.convert_body(kwargs.pop('body'), wrap=False)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs, headers=headers)
+
+    @sp_endpoint('/adsAccounts/{}', method='GET')
+    def get_account(self, advertisingAccountId: str, **kwargs) -> ApiResponse:
+        r"""
+        get_account(advertisingAccountId: str) -> ApiResponse
+
+        Request attributes of a given advertising account.
+
+        path **advertisingAccountId**:string | Required. This is the global advertising account Id from the client.
+        """
+        schema_version = 'application/vnd.listaccountsresource.v1+json'
+        headers = {'Accept': schema_version, 'Content-Type': schema_version}
+
+        return self._request(fill_query_params(kwargs.pop('path'), advertisingAccountId), params=kwargs, headers=headers)
+
+    @sp_endpoint('/adsAccounts', method='POST')
+    def create_account(self, **kwargs) -> ApiResponse:
+        r"""
+        create_account(body: (dict, str)) -> ApiResponse
+
+        Create a new advertising account tied to a specific Amazon vendor, seller or author, or to a business who does not sell on Amazon.
+
+        body: | REQUIRED
+            | **associations** (list[dict]) Associations you would like to link to this advertising account, could be Amazon Vendor, Seller, or just a regular business
+            | **countryCodes** (list[string]) The countries that you want this account to operate in.
+            | **accountName** (string) Account names are typically the name of the company or brand being advertised.
+            | **termsToken** (string) An obfuscated identifier of the termsToken, which is activated when an advertisers accepts the Amazon Ads Agreement in relation to the ads account being register.
+        """
+        schema_version = 'application/vnd.registeradsaccountresource.v1+json'
+        headers = {'Accept': schema_version, 'Content-Type': schema_version}
+
+        body = Utils.convert_body(kwargs.pop('body'), wrap=False)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs, headers=headers)

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/ad_api/api/sb/__init__.py

@@ -20,6 +20,7 @@ from .stores import Stores
 from .media import Media
 from .reports import Reports
 from .snapshots import Snapshots
+from .benchmarks import Benchmarks
 
 __all__ = [
     "Brands",
@@ -44,4 +45,5 @@ __all__ = [
     "Media",
     "Reports",
     "Snapshots",
+    "Benchmarks"
 ]

python_amazon_ad_api-0.5.8/ad_api/api/sb/benchmarks.py

@@ -0,0 +1,65 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils, fill_query_params
+
+
+class Benchmarks(Client):
+    """
+    Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
+    """
+    @sp_endpoint('/benchmarks/brands/{}/categories/{}', method='POST')
+    def list_brand_and_category(self, brandName, categoryId, version: int = 1, **kwargs) -> ApiResponse:
+
+
+        json_version = 'application/vnd.timeseriesdata.v' + str(version) + "+json"
+
+        headers = {
+            "Accept": json_version,
+        }
+
+        return self._request(fill_query_params(kwargs.pop('path'), brandName, categoryId), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+
+    @sp_endpoint('/benchmarks/brands', method='GET')
+    def list_brands(self, **kwargs) -> ApiResponse:
+        """
+        Gets an array of Brand data objects for the Brand associated with the profile ID passed in the header. For more information about Brands, see [Brand Services](https://brandservices.amazon.com/).
+
+        Keyword Args
+            | None
+
+        Returns:
+            ApiResponse payload:
+
+            | '**brandId**': *string*, {'description': 'The Brand identifier.'}
+            | '**brandEntityId**': *string*, {'description': 'The Brand entity identifier.'}
+            | '**brandRegistryName**': *string*, {'description': 'The Brand name.'}
+
+        """
+        return self._request(kwargs.pop('path'), params=kwargs)
+
+
+    @sp_endpoint('/benchmarks/brandsAndCategories', method='POST')
+    def list_brands_and_categories(self, version: int = 1, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands campaigns.
+
+        Request body (Required)
+            Request body
+            | **name** (string): [optional] The name of the campaign. This name must be unique to the Amazon Advertising account to which the campaign is associated. Maximum length of the string is 128 characters.
+            | **state** (State > string): [optional] Enum: [ enabled, paused, archived ]
+            | **portfolio_id** (int) [optional] The identifier of the portfolio to which the campaign is associated.
+            | **budget** (float): [optional] The budget amount associated with the campaign.
+            | **bid_optimization** (bool) [optional] Set to `true` to allow Amazon to automatically optimize bids for placements below top of search if omitted the server will use the default value of True
+            | **bid_multiplier** (float minimum: -99 maximum: 99) [optional] A bid multiplier. Note that this field can only be set when 'bidOptimization' is set to false. Value is a percentage to two decimal places. Example: If set to -40.00 for a $5.00 bid, the resulting bid is $3.00.
+            | **end_date** (EndDate > string) [optional] The YYYYMMDD end date of the campaign. Must be greater than the value specified in the startDate field. If this property is not included in the request, the endDate value is not updated. If set to null, endDate is deleted from the draft campaign. [nullable: true] [pattern: ^\\d{8}$]
+
+        Returns
+            ApiResponse
+        """
+
+        json_version = 'application/vnd.reportdata.v' + str(version) + "+json"
+
+        headers = {
+            "Accept": json_version,
+        }
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

python_amazon_ad_api-0.5.8/ad_api/version.py

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

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: python-amazon-ad-api
-Version: 0.5.6
+Version: 0.5.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
-Author-email: info@leadtech.es
+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
@@ -12,9 +12,9 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests<2.32.0,>=2.27.1
+Requires-Dist: requests<2.33.0,>=2.27.1
 Requires-Dist: six~=1.16.0
-Requires-Dist: cachetools<5.4,>=5.0
+Requires-Dist: cachetools<5.6,>=5.0
 Requires-Dist: pycryptodome<3.21,>=3.13
 Requires-Dist: pytz<2025.0,>=2021.3
 Requires-Dist: confuse<2.1,>=1.7

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ setup.py
 ad_api/__init__.py
 ad_api/version.py
 ad_api/api/__init__.py
+ad_api/api/account.py
 ad_api/api/advertising_test_account.py
 ad_api/api/attribution.py
 ad_api/api/audiences.py
@@ -37,6 +38,7 @@ ad_api/api/sb/ad_creatives_v4.py
 ad_api/api/sb/ad_groups.py
 ad_api/api/sb/ad_groups_v4.py
 ad_api/api/sb/ads_v4.py
+ad_api/api/sb/benchmarks.py
 ad_api/api/sb/bid_recommendations.py
 ad_api/api/sb/brands.py
 ad_api/api/sb/campaigns.py

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/python_amazon_ad_api.egg-info/requires.txt

@@ -1,6 +1,6 @@
-requests<2.32.0,>=2.27.1
+requests<2.33.0,>=2.27.1
 six~=1.16.0
-cachetools<5.4,>=5.0
+cachetools<5.6,>=5.0
 pycryptodome<3.21,>=3.13
 pytz<2025.0,>=2021.3
 confuse<2.1,>=1.7

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/setup.cfg

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

{python-amazon-ad-api-0.5.6 → python_amazon_ad_api-0.5.8}/setup.py

@@ -2,11 +2,11 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='0.5.6',
+    version='0.5.8',
     install_requires=[
-        "requests>=2.27.1,<2.32.0",
+        "requests>=2.27.1,<2.33.0",
         "six~=1.16.0",
-        "cachetools>=5.0,<5.4",
+        "cachetools>=5.0,<5.6",
         "pycryptodome>=3.13,<3.21",
         "pytz>=2021.3,<2025.0",
         "confuse>=1.7,<2.1",
@@ -24,6 +24,6 @@ setup(
     url='https://github.com/denisneuf/python-amazon-ad-api',
     license='MIT',
     author='Daniel Alvaro',
-    author_email='info@leadtech.es',
+    author_email='denisneuf@hotmail.com',
     description='Python wrapper for the Amazon Advertising API',
 )

python-amazon-ad-api-0.5.6/ad_api/version.py

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