python-amazon-ad-api 1.0.7__py3-none-any.whl → 1.0.9__py3-none-any.whl

ad_api/api/sb/__init__.py

@@ -6,7 +6,6 @@ from .ad_groups import AdGroups
 from .ad_groups_v4 import AdGroupsV4
 from .ad_creatives_v4 import AdCreativesV4
 from .ads_v4 import AdsV4
-from .moderation import Moderation
 from .keywords import Keywords
 from .recommendations import Recommendations
 from .keywords_recommendations import KeywordsRecommendations
@@ -19,7 +18,6 @@ from .bid_recommendations import BidRecommendations
 from .stores import Stores
 from .media import Media
 from .reports import Reports
-from .snapshots import Snapshots
 from .benchmarks import Benchmarks
 from .themes import Themes
 
@@ -32,7 +30,6 @@ __all__ = [
     "AdGroups",
     "AdGroupsV4",
     "AdsV4",
-    "Moderation",
     "Keywords",
     "Recommendations",
     "KeywordsRecommendations",
@@ -45,7 +42,6 @@ __all__ = [
     "Stores",
     "Media",
     "Reports",
-    "Snapshots",
     "Benchmarks",
     "Themes"
 ]

ad_api/api/sb/ad_groups.py

@@ -33,6 +33,7 @@ class AdGroups(Client):
         return self._request(kwargs.pop('path'), params=kwargs)
 
     @sp_endpoint('/sb/adGroups/{}', method='GET')
+    @Utils.deprecated
     def get_ad_group(self, adGroupId, **kwargs) -> ApiResponse:
         r"""
 

ad_api/api/sb/campaigns.py

@@ -116,6 +116,7 @@ class Campaigns(Client):
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
 
     @sp_endpoint('/sb/campaigns/{}', method='GET')
+    @Utils.deprecated
     def get_campaign(self, campaignId, **kwargs) -> ApiResponse:
         """
         Gets a campaign specified by identifier.
@@ -131,6 +132,7 @@ class Campaigns(Client):
         return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)
 
     @sp_endpoint('/sb/campaigns/{}', method='DELETE')
+    @Utils.deprecated
     def delete_campaign(self, campaignId, **kwargs) -> ApiResponse:
         """
         Archives a campaign specified by identifier.

ad_api/api/sb/campaigns_v4.py

@@ -59,7 +59,6 @@ class CampaignsV4(Client):
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
     @sp_endpoint('/sb/v4/campaigns/delete', method='POST')
-    @Utils.notsupported
     def delete_campaigns(self, version: int = 4, **kwargs) -> ApiResponse:
         """
         The operation is currently not supported subject to potential change.

ad_api/api/sb/stores.py

@@ -1,4 +1,9 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
+import json
+import mimetypes
+
+import requests
+
+from ad_api.base import Client, sp_endpoint, ApiResponse
 
 
 class Stores(Client):
@@ -12,33 +17,72 @@ class Stores(Client):
         For sellers or vendors, gets an array of assets associated with the specified brand entity identifier. Vendors are not required to specify a brand entity identifier, and in this case all assets associated with the vendor are returned.
 
         Keyword Args
-            | path **brandEntityId** (string): For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the getBrands operation. For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the difference between a seller and a vendor, see the Amazon Advertising FAQ. [required]
+            | query **brandEntityId** (string): For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the getBrands operation. For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the difference between a seller and a vendor, see the Amazon Advertising FAQ. [required]
 
             | query **mediaType** (string): Specifies the media types used to filter the returned array. Currently, only the brandLogo type is supported. If not specified, all media types are returned. Available values : brandLogo, image [optional]
 
         Returns:
             | ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path')), params=kwargs)
+        return self._request(kwargs.pop('path'), params=kwargs)
 
-    @sp_endpoint('/v2/stores', method='GET')
-    def list_stores(self, **kwargs) -> ApiResponse:
+    @sp_endpoint('/stores/assets', method='POST')
+    def create_asset(self, image, brandEntityId, mediaType='brandLogo', filename=None, **kwargs) -> ApiResponse:
         """
-        List store information for all registered stores under an advertiser.
+        Creates a new image asset and stores it in the Store Assets Library.
+
+        The endpoint takes ``multipart/form-data`` with two parts, not JSON:
+
+            ``assetInfo``  A JSON string with ``brandEntityId`` and ``mediaType``.
+            ``asset``      The image bytes. PNG, JPEG or GIF, under 1MB and at
+                           least 400x400 pixels.
 
         Keyword Args
-            None
+            | path **image** (str or bytes): A file path, or the raw image bytes. [required]
+            | path **brandEntityId** (string): The Brand entity identifier. Required for sellers, optional for vendors. [required]
+            | path **mediaType** (string): Only ``brandLogo`` is supported. [optional]
+            | path **filename** (string): Name sent in ``Content-Disposition``. Taken from the path when a path is given. [optional]
 
+        Returns:
+            | ApiResponse
+
+        Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Stores
         """
-        return self._request(fill_query_params(kwargs.pop('path')), params=kwargs)
+        if isinstance(image, (str, bytes)):
+            if isinstance(image, bytes):
+                data = image
+            else:
+                filename = filename or image.split('/')[-1]
+                with open(image, 'rb') as handle:
+                    data = handle.read()
+        else:
+            data = image.read()
 
-    # It is not working the endpoint
-    @sp_endpoint('/v2/stores/{}', method='GET')
-    def get_store(self, brandEntityId, **kwargs) -> ApiResponse:
-        return self._request(fill_query_params(kwargs.pop('path'), brandEntityId), params=kwargs)
+        filename = filename or 'image'
 
-    # It is not working Cannot consume content type
-    @sp_endpoint('/stores/assets', method='POST')
-    def create_asset(self, contentDisposition, contentType, **kwargs) -> ApiResponse:
-        headers = {'Content-Disposition': contentDisposition, 'Content-Type': contentType}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+        content_type = mimetypes.guess_type(filename)[0] or 'image/png'
+        if content_type not in ('image/png', 'image/jpeg', 'image/gif'):
+            raise ValueError(f"Unsupported image type {content_type}; use PNG, JPEG or GIF.")
+
+        asset_info = {'brandEntityId': brandEntityId, 'mediaType': mediaType}
+
+        headers = self.headers.copy()
+        # requests must set Content-Type itself to add the multipart boundary
+        headers.pop('Content-Type', None)
+        headers['Accept'] = '*/*'
+        headers['Content-Disposition'] = f'attachment; filename="{filename}"'
+
+        response = requests.post(
+            self.endpoint + '/stores/assets',
+            headers=headers,
+            files={
+                'assetInfo': (None, json.dumps(asset_info), 'application/json'),
+                'asset': (filename, data, content_type),
+            },
+            params=kwargs,
+            timeout=self.timeout or 60,
+            proxies=self.proxies,
+            verify=self.verify,
+        )
+
+        return self._check_response(response)

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.0.7"
+__version__ = "1.0.9"

{python_amazon_ad_api-1.0.7.dist-info → python_amazon_ad_api-1.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.0.7
+Version: 1.0.9
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -337,8 +337,10 @@ Warning: the campaign, ad group and product ad operations are deprecated in favo
 
 ### [Modules Available Sponsored Brands 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sb_v3.html)
 
-* [Campaigns](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns.html)
-* [Ad Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups.html)
+> Campaigns and Ad Groups are deprecated in v3: Amazon answers `403 Endpoint has been deprecated` and points to the v4 API. Use the 4.0 section below for those two.
+
+* [Campaigns (deprecated)](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns.html)
+* [Ad Groups (deprecated)](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_keywords.html)
 * [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/product_targeting.html)

{python_amazon_ad_api-1.0.7.dist-info → python_amazon_ad_api-1.0.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=BW7SWRpHoxuOQZ67pS20yog2LWYl-nK7-BEFBNrHGgA,22
+ad_api/version.py,sha256=q2ACMkQx0Hm5xKo2YKJFBE7rTruciTSIN6AvWWL9nB8,22
 ad_api/api/__init__.py,sha256=E9c0ZyK4vplMlKKEBF8CV5u7P4uSkTMSQsAuSQu5bfY,1514
 ad_api/api/account.py,sha256=CmOvCfHoPWaeTUJvtB0pNoNulZVSz4oMMCKIpVTpHos,2931
 ad_api/api/advertising_test_account.py,sha256=btOVbdk2tBDmyKSJaQbcIFyzNG8KFJVUmTe4p9xMhpU,1507
@@ -24,29 +24,27 @@ ad_api/api/reports.py,sha256=gNmDHLULD2uaJgsMpIbCX9kabwhMXRr9WfZBtHUdsOY,6043
 ad_api/api/stores.py,sha256=7W3RJKZyZOQ3nHzInvK9FDhWTXCH6Xe9a6dCBatEZ-o,2484
 ad_api/api/stream.py,sha256=JpnF8SKniOAHiEnEq1RPrh6tNy-Q2-8GPBTmnlxEXqQ,2989
 ad_api/api/validation_configurations.py,sha256=V3o06uWGwvA_Ly1x2lAiCk35Wo7DC_k8AtHgMdpm6wU,3830
-ad_api/api/sb/__init__.py,sha256=jfU2t4144El09YYXugAge5aSS0f6yhNW0R36tI26JLg,1377
+ad_api/api/sb/__init__.py,sha256=Lb7biv_idmsN6SkObBhQS4hZs3rdeQr0ytSvcl2tfSo,1274
 ad_api/api/sb/ad_creatives_v4.py,sha256=VwBDMnYdf10wtP6bVnTQjOLp7ZzJYueU_q_xN6Yxie4,10490
-ad_api/api/sb/ad_groups.py,sha256=gcCEbkrnndx5WD4gv5ph0MBJxFqTOQIQUXRlOsn0NO0,2860
+ad_api/api/sb/ad_groups.py,sha256=W06Fk0CCsuEYen1Bd8obR6aHpOMhk6tGWNWApecw59c,2882
 ad_api/api/sb/ad_groups_v4.py,sha256=f6KpOrJ2RsCa4aznP8vdGbXp0HGsCmLOvC9yXX2pESc,3669
 ad_api/api/sb/ads_v4.py,sha256=EOn-ts0cPqCwt5vdGq6rkDHyYPoT6vbDP8UQE-TFjmE,7931
 ad_api/api/sb/benchmarks.py,sha256=eeWv2rrRf4ttK-oI1EEEiui_rl_sxJk9yXcu6sDSfhg,3645
 ad_api/api/sb/bid_recommendations.py,sha256=x1VEF7AqIV0HMlNiHc21qdmYhWQckNm8RjZvVPhXy8A,2026
 ad_api/api/sb/brands.py,sha256=lOtI-K_OnEGQu-S8vfH86WGe34Ex7cws20Akr624xZc,1149
-ad_api/api/sb/campaigns.py,sha256=l3HYx4sQ0D0ulSrR1cp5pa3frqiVbomBHfHAiWJWIS0,13630
-ad_api/api/sb/campaigns_v4.py,sha256=X8fnZ_I3syzFWwnXNhUizx_7mrO9sj7Zzm2p_HZiU-M,7314
+ad_api/api/sb/campaigns.py,sha256=41yRnrgvx4-9Zra7Zdqtzr2Ptq__YD-mHOWbACaEQOk,13674
+ad_api/api/sb/campaigns_v4.py,sha256=_SfEQhHCS90UaSxOq35mm7NAr2BVpqJ4gzAbauVCZiA,7290
 ad_api/api/sb/forecast.py,sha256=hFOYQi4qlvsIkTRiqiexiI4XRv1tWmdnvQZk9Sl641A,334
 ad_api/api/sb/keywords.py,sha256=P1dGqcLia349O0CwpBRURlIzgRc0cbFotkAGTSrErt4,7634
 ad_api/api/sb/keywords_recommendations.py,sha256=B8d_nR4T6ZFSfUqG75ZuL8eaL7Sy7cYSn-cWW8uDFf0,354
 ad_api/api/sb/landing_page_asins.py,sha256=GY4COVSw034XwDT9VMJT71YcrZ92ZrYJg6dY-5ieg3E,1028
 ad_api/api/sb/media.py,sha256=wHa91d9qQb-bvBS5vaeNqlaAJ60iITedj-Hr9yR5aaw,1634
-ad_api/api/sb/moderation.py,sha256=MFwtmx4fFEDiVqmH2XuXcb7sLYbfQTU4AWAX8RGR5Tw,745
 ad_api/api/sb/negative_keywords.py,sha256=oCirwkq2e0jvhCbkNgY1GPy7p9DuIqFG-oNoh53-yGc,6677
 ad_api/api/sb/negative_product_targeting.py,sha256=AZV6-Wunf8Q61CItckkM2mbLiWgPEbA9cbmpmMXfGiM,4798
 ad_api/api/sb/product_targeting.py,sha256=o6aB3hIh9jKvi_uTXFi--1hpnPFuXzQ-U9N7VUP_Bz4,5362
 ad_api/api/sb/recommendations.py,sha256=Ck4DLAKLTqwodmQJfih9MUD1sujG6LDjRlSoefKmOC4,356
 ad_api/api/sb/reports.py,sha256=KzQiCI17E-_-KjbuPbz2X0cgpC_aqKRMb5WuUYc6mTM,3534
-ad_api/api/sb/snapshots.py,sha256=5k9Ldk3IMZGgzBIuajy8k4J2WZAL7ZXOu20hg14pJHg,2362
-ad_api/api/sb/stores.py,sha256=t8NzC3wOFVg_k2qCj6r62GS41uihEJuGuHTqppAy5B8,2659
+ad_api/api/sb/stores.py,sha256=4LuRnP-Jx9GcvpO86vnmJumauV0V-zpc5_b4x2U_iSY,4284
 ad_api/api/sb/targeting_recommendations.py,sha256=_7NxD5kC-Od11QOuLT03qpLVxEOIZgy-BtzniWK4CI8,2862
 ad_api/api/sb/themes.py,sha256=rjxdGcllaqLOUMoTKKgBVSH5iKuxMdF0w-dHq0X3-yU,4618
 ad_api/api/sd/__init__.py,sha256=RulShFVpowt2L_ZMcifFVgVrQEg5Uf9_SlVRydUnTF4,911
@@ -106,8 +104,8 @@ ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,438
 ad_api/base/helpers.py,sha256=naUkDLK466x_OBCPXxMlzRc2nPC6iQ6H_vyUji0MJJ0,2282
 ad_api/base/marketplaces.py,sha256=44lvCcluXNpqTprWQ80e3weSQmQbJoWL-WDSOWVbCyQ,4657
 ad_api/base/utils.py,sha256=_qnCBOvyJTLgaZjJzUWTi38GGLHkQszXELs79133Rb4,5618
-python_amazon_ad_api-1.0.7.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.0.7.dist-info/METADATA,sha256=kY_5Mgwnutj-01W0WqY2paX9C4rgzPJnUF9qKVacr1s,20294
-python_amazon_ad_api-1.0.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.0.7.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.0.7.dist-info/RECORD,,
+python_amazon_ad_api-1.0.9.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.0.9.dist-info/METADATA,sha256=p32-3tHaR3AOfdlkB1LauUgIsoZt0tlbsynmCPAmk3s,20486
+python_amazon_ad_api-1.0.9.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.0.9.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.0.9.dist-info/RECORD,,

ad_api/api/sb/moderation.py

@@ -1,18 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
-
-
-class Moderation(Client):
-    """
-    Use this interface to request and retrieve store information. This can be used for Sponsored Brands campaign creation, to pull the store URL information, and for asset registration for Stores.
-    """
-
-    @sp_endpoint('/sb/moderation/campaigns/{}', method='GET')
-    def get_moderation(self, campaignId, **kwargs) -> ApiResponse:
-        """
-        Gets the moderation result for a campaign specified by identifier.
-
-        Keyword Args
-            | path **campaignId** (integer): The campaign identifier. [required]
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)

ad_api/api/sb/snapshots.py

@@ -1,47 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
-
-
-class Snapshots(Client):
-    """
-    Use the Amazon Advertising API for Sponsored Products for campaign, ad group, keyword, negative keyword, and product ad management operations. For more information about Sponsored Products, see the Sponsored Products Support Center. For onboarding information, see the account setup topic.
-    """
-
-    @sp_endpoint('/v2/hsa/{}/snapshot', method='POST')
-    @Utils.deprecated
-    def post_snapshot(self, recordType, **kwargs) -> ApiResponse:
-        """
-
-        Returns:
-            ApiResponse
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), recordType), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
-
-    @sp_endpoint('/v2/hsa/snapshots/{}', method='GET')
-    @Utils.deprecated
-    def get_snapshot(self, snapshotId, **kwargs) -> ApiResponse:
-        r"""
-        Gets the status of a requested snapshot.
-
-        Returns:
-            ApiResponse
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), snapshotId), params=kwargs)
-
-    @Utils.deprecated
-    def download_snapshot(self, **kwargs) -> ApiResponse:
-        r"""
-        Downloads the snapshot previously get report specified by location (this is not part of the official Amazon Advertising API, is a helper method to download the snapshot). Take in mind that a direct download of location returned in get_snapshot will return 401 - Unauthorized.
-
-        kwarg parameter **file** if not provided will take the default amazon name from path download (add a path with slash / if you want a specific folder, do not add extension as the return will provide the right extension based on format choosed if needed)
-
-        kwarg parameter **format** if not provided a format will return a url to download the snapshot (this url has a expiration time)
-
-        Keyword Args
-            | **url** (string): The location obatined from get_snapshot [required]
-            | **file** (string): The path to save the file if mode is download json, zip or gzip. [optional]
-            | **format** (string): The mode to download the snapshot: data (list), raw, url, json, zip, gzip. Default (url) [optional]
-
-        Returns:
-            ApiResponse
-        """
-        return self._download(self, params=kwargs)