python-amazon-ad-api 1.1.7__py3-none-any.whl → 1.1.9__py3-none-any.whl

ad_api/api/sb/campaigns_v4.py

@@ -77,6 +77,34 @@ class CampaignsV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/campaigns/insights', method='POST')
+    def get_campaign_insights(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Gets insights for campaign ad groups.
+
+        Request Body [Required]
+            | **adGroups** (array): [required] One entry per ad group.
+                | **adFormat** (string): [required] Ad format of the ad group.
+                | **keywords** (array): [optional] Each entry needs
+                  ``keywordText``, ``matchType`` and ``bid``.
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        .. note::
+            This route takes ``application/vnd.sbinsights.v4+json``, not the
+            campaigns media type. With ``application/json`` it answers ``404
+            Could not find resource``, so the versioned type is what routes it.
+
+        .. note::
+            An empty body answers ``400`` naming ``adGroups``, which is the only
+            required member.
+        """
+        json_version = 'application/vnd.sbinsights.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)
+
     @sp_endpoint('/sb/v4/campaigns/list', method='POST')
     def list_campaigns(self, version: int = 4, **kwargs) -> ApiResponse:
         """

ad_api/api/sb/targeting_categories.py

@@ -67,6 +67,29 @@ class TargetingCategories(Client):
                              params=kwargs,
                              headers={'Accept': self._MEDIA, 'Content-Type': self._MEDIA})
 
+    @sp_endpoint('/sb/negativeTargets/brands/recommendations', method='GET')
+    def list_negative_brand_recommendations(self, **kwargs) -> ApiResponse:
+        """
+        Gets brand recommendations for negative targeting.
+
+        Keyword Args
+            | query **nextToken** (string): [optional] Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with brands under ``brands``, each carrying
+              ``brandRefinementId`` and ``name``.
+
+        Example::
+
+            {"brands": [{"brandRefinementId": "19897490031", "name": "YEYIAN"}]}
+
+        .. note::
+            Lives here because it shares this class media type. It is the one
+            route in this class that is not about the category tree.
+        """
+        return self._request(kwargs.pop('path'), params=kwargs,
+                             headers={'Accept': self._MEDIA, 'Content-Type': self._MEDIA})
+
     @sp_endpoint('/sb/targets/products/count', method='POST')
     def get_product_count(self, category, **kwargs) -> ApiResponse:
         """

ad_api/base/helpers.py

@@ -1,3 +1,4 @@
+import functools
 from io import BytesIO
 from typing import TypeVar
 
@@ -17,6 +18,7 @@ T = TypeVar("T")
 
 def sp_endpoint(path, method="GET"):
     def decorator(function: T) -> T:
+        @functools.wraps(function)
         def wrapper(*args, **kwargs):
             kwargs.update({"path": path, "method": method})
             return function(*args, **kwargs)

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.1.7"
+__version__ = "1.1.9"

{python_amazon_ad_api-1.1.7.dist-info → python_amazon_ad_api-1.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.7
+Version: 1.1.9
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -343,24 +343,35 @@ Warning: the campaign, ad group and product ad operations are deprecated in favo
 * [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)
+* [Keywords Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords_recommendations.html)
 * [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/product_targeting.html)
 * [Negative Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_product_targeting.html)
 * [Targeting Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_recommendations.html)
 * [Bid Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/bid_recommendations.html)
+* [Benchmarks](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/benchmarks.html)
 * [Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/stores.html)
 * [Landing Page Asins](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/landing_page_asins.html)
 * [Media](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/media.html)
 * [Brands](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/brands.html)
-* [Moderation](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/moderation.html)
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
-* [Snapshots](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/snapshots.html)
 * [Themes](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/themes.html)
+* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
 
 ### [Modules Available Sponsored Brands 4.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sb_v4.html)
 
+> The 4.0 contract is fully covered: every operation is implemented except the campaign moderation route, which the service answers with a router `404`, and the report download, which resolves through the shared `_download` helper.
+
 * [Campaigns](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns_v4.html)
 * [Ad Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups_v4.html)
-* [Ads Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ad Creatives](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_creatives_v4.html)
+* [Forecast](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/forecast.html)
+* [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/recommendations.html)
+* [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/budget_rules.html)
+* [Optimization Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/optimization_rules.html)
+* [Targeting Categories](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_categories.html)
+* [Migration](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/migration.html)
+
+> Most 4.0 routes take a versioned media type and the service routes on it. With `application/json` they answer `404 Could not find resource`, which reads like a missing route but is only the wrong media type. This affects forecasts, budget recommendations, optimization rules, migrations, insights, negative brand recommendations and the collection creatives.
 
 ### [Modules Available Sponsored Display](https://python-amazon-ad-api.readthedocs.io/en/latest/sd.html)
 

{python_amazon_ad_api-1.1.7.dist-info → python_amazon_ad_api-1.1.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=p2qAfdU7zHOShJi2f1FW-_7Tbm0-KCPE7CI7284QiHg,22
+ad_api/version.py,sha256=lnHAM_YSOt5TvtAm4ZVs32T0TpsCQ5kOOznnQlur1YE,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
@@ -34,7 +34,7 @@ ad_api/api/sb/bid_recommendations.py,sha256=ssO9XwYC9wK2GFaLtcsC-D3cZhDpCclcu1r0
 ad_api/api/sb/brands.py,sha256=XIMDzV0tJoPiOcY0KoCKcyIwYLPMlJ-zkB2SeRVMF4Q,1376
 ad_api/api/sb/budget_rules.py,sha256=8hyJ4yD-myR4atYmTm8KsTSB5ZNfASGe2fxgwRv4SRs,10029
 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/campaigns_v4.py,sha256=F50vFI2qyIKssEhPFCu4NXnq9trSIGywVNA5uVpp6rc,8504
 ad_api/api/sb/forecast.py,sha256=qf2ivhGX3_dv_uMGP9cmrt_x3S7QLg-P_5nCI8bAr00,3967
 ad_api/api/sb/keywords.py,sha256=P1dGqcLia349O0CwpBRURlIzgRc0cbFotkAGTSrErt4,7634
 ad_api/api/sb/keywords_recommendations.py,sha256=oA4FRBwDtk52SZK0RgWvjNQ7K2GX0G2zSoisJGiEYDw,629
@@ -48,7 +48,7 @@ ad_api/api/sb/product_targeting.py,sha256=o6aB3hIh9jKvi_uTXFi--1hpnPFuXzQ-U9N7VU
 ad_api/api/sb/recommendations.py,sha256=_21L8tZPuArmJ30XyR1SKQHQH_yswvF0IMqwD9sLhgY,347
 ad_api/api/sb/reports.py,sha256=icw5DpRrqfj0idEo0NN1GPDpIWQun2h_c2Uwc7CpNUA,3801
 ad_api/api/sb/stores.py,sha256=sLdA6Lp37VR-ldu_sTUZIqc8MbMzysPhNOh05VaKBcA,4371
-ad_api/api/sb/targeting_categories.py,sha256=mTU3hMEW_orG_D2mlTqUX14DEDPn9A11vH-wntECklk,4212
+ad_api/api/sb/targeting_categories.py,sha256=QqOB2vTiS5c8u9qvbjRpeKJdGBkMWfgwWSoF3h-Eg4c,5114
 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
@@ -105,11 +105,11 @@ ad_api/base/client.py,sha256=rOTH5zd513qmeNiJbwT42kEXvZseeh03UUp-krBW_W4,10322
 ad_api/base/config.py,sha256=VbykwPyR_CDIMFCZQs_GSqc5qKcYpp0l6B9luV-abu4,606
 ad_api/base/credential_provider.py,sha256=upgcgm2GGb0AkzDlKVAtKtbirqZAFp3EM6DkBzvAXsI,5566
 ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,4383
-ad_api/base/helpers.py,sha256=naUkDLK466x_OBCPXxMlzRc2nPC6iQ6H_vyUji0MJJ0,2282
+ad_api/base/helpers.py,sha256=UK7Q13vZ0mNdF54xzfzoGDn2O_cd2yPrK2X4rOzC41c,2334
 ad_api/base/marketplaces.py,sha256=44lvCcluXNpqTprWQ80e3weSQmQbJoWL-WDSOWVbCyQ,4657
 ad_api/base/utils.py,sha256=_qnCBOvyJTLgaZjJzUWTi38GGLHkQszXELs79133Rb4,5618
-python_amazon_ad_api-1.1.7.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.1.7.dist-info/METADATA,sha256=ySlzzw2eMqLcY38Pk2d32nnEH-zGKjcnpoB-PQ5fz2E,20486
-python_amazon_ad_api-1.1.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.1.7.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.1.7.dist-info/RECORD,,
+python_amazon_ad_api-1.1.9.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.1.9.dist-info/METADATA,sha256=3q_mes0kMmFRFV8eOrOBxDmWYui2SNDT1CH3ZzRD0kg,21778
+python_amazon_ad_api-1.1.9.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.1.9.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.1.9.dist-info/RECORD,,