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

ad_api/api/sb/__init__.py

@@ -23,6 +23,7 @@ from .themes import Themes
 from .budget_rules import BudgetRules
 from .optimization_rules import OptimizationRules
 from .targeting_categories import TargetingCategories
+from .migration import Migration
 
 __all__ = [
     "Brands",
@@ -50,4 +51,5 @@ __all__ = [
     "BudgetRules",
     "OptimizationRules",
     "TargetingCategories",
+    "Migration",
 ]

ad_api/api/sb/ad_creatives_v4.py

@@ -128,6 +128,92 @@ class AdCreativesV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/ads/creatives/autoCollection', method='POST')
+    def create_auto_collection_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of an auto collection creative for an existing ad.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+                | **adId** (string): [required] Sponsored Brands ad identifier.
+                | **creative** ({}): [required]
+                    | **brandName** (string): [required]
+                    | **brandLogoAssetID** (string): [optional]
+                    | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                      ``width`` and ``height``.
+                    | **asinExclusions** (array of string): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            This route takes ``application/vnd.sbadresource.v4+json``, the same
+            media type as the ads family, not the creative one.
+        """
+        json_version = 'application/vnd.sbadresource.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/ads/creatives/manualCollection', method='POST')
+    def create_manual_collection_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of a manual collection creative for an existing ad.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad, each with ``adId``
+              and a ``creative`` block.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            Also takes ``application/vnd.sbadresource.v4+json``.
+        """
+        json_version = 'application/vnd.sbadresource.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/ads/creatives/productCollectionExtended', method='POST')
+    @Utils.deprecated
+    def create_new_version_product_collection_extended_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of an extended product collection creative.
+
+        This route is flagged deprecated in the 4.0 contract. It still answers on
+        the live service, which is why it stays available, but new integrations
+        should use ``create_auto_collection_ad_creative`` or
+        ``create_manual_collection_ad_creative``.
+
+        Request Body [Required]
+            | **adId** (string): [required] Sponsored Brands ad identifier.
+            | **creative** ({}): [required]
+                | **asins** (array of string): [required]
+                | **brandName** (string): [required]
+                | **brandLogoAssetId** (string): [required]
+                | **headline** (string): [required]
+                | **landingPage** ({}): [optional] ``type``, ``url`` or ``asins``.
+                | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                  ``width`` and ``height``.
+                | **customImages** (array): [optional] Each with ``assetId``,
+                  ``url`` and a ``crop``.
+                | **consentToTranslate** (boolean): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            Unlike its siblings this route takes a single ``adId`` and
+            ``creative``, not an ``ads`` list, and it uses
+            ``application/vnd.sbAdCreativeResource.v4+json``. An empty body names
+            both required members.
+        """
+        json_version = 'application/vnd.sbAdCreativeResource.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/ads/creatives/list', method='POST')
     def list_ad_creatives(self, version: int = 4, **kwargs) -> ApiResponse:
         """

ad_api/api/sb/ads_v4.py

@@ -165,6 +165,85 @@ class AdsV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/v4/ads/autoCollection', method='POST')
+    def create_auto_collection_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands auto collection ads.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+                | **adGroupId** (string): [required] Ad group the ad belongs to.
+                | **name** (string): [required] Ad name.
+                | **state** (string): [required] ``ENABLED``, ``PAUSED`` or
+                  ``ARCHIVED``.
+                | **creative** ({}): [required]
+                    | **brandName** (string): [required]
+                    | **brandLogoAssetID** (string): [optional]
+                    | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                      ``width`` and ``height``.
+                    | **asinExclusions** (array of string): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*, and ``application/json`` answers
+            ``404 Could not find resource``, so the versioned media type is what
+            routes the call.
+        """
+        json_version = 'application/vnd.sbadresource.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/ads/manualCollection', method='POST')
+    def create_manual_collection_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands manual collection ads.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad, each with
+              ``adGroupId``, ``name``, ``state`` and a ``creative`` block.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*
+        """
+        json_version = 'application/vnd.sbadresource.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/ads/productCollectionExtended', method='POST')
+    @Utils.deprecated
+    def create_product_collection_extended_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands extended product collection ads.
+
+        This route is flagged deprecated in the 4.0 contract, together with the
+        creative side of the same name. It still answers on the live service,
+        which is why it stays available, but new integrations should use
+        ``create_auto_collection_ads`` or ``create_manual_collection_ads``.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*
+        """
+        json_version = 'application/vnd.sbadresource.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/ads/delete', method='POST')
     def delete_ads(self, version: int = 4, **kwargs) -> ApiResponse:
         """

ad_api/api/sb/migration.py

@@ -0,0 +1,154 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class Migration(Client):
+    """Sponsored Brands legacy campaign migration from 3.0 to 4.0.
+
+    Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/4-0/openapi
+
+    Two media types live in this family, both versioned and both required:
+
+    ========================================  ==========================================================
+    Route                                      Media type
+    ========================================  ==========================================================
+    ``/sb/v4/legacyCampaigns/*``               ``vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4``
+    ``/sb/v4/migrations/list``                 ``vnd.sbAdMigration.v4``
+    ========================================  ==========================================================
+
+    .. warning::
+        ``list_migrations`` answers ``404 Could not find resource`` when sent
+        ``application/json``, the same behaviour already recorded for forecasts,
+        budget recommendations and optimization rules. Amazon routes on media
+        type; a wrong one reads exactly like a missing route.
+
+    .. note::
+        ``migration_job_status`` and ``migration_job_results`` answer ``500
+        INTERNAL_ERROR`` for a job identifier that does not exist, instead of a
+        400 or a 404. The routes are live; the service trips over an unknown id.
+    """
+
+    _MEDIA_LEGACY = ('application/vnd.SponsoredBrands.'
+                     'SponsoredBrandsMigrationApi.v4+json')
+    _MEDIA_ADMIG = 'application/vnd.sbAdMigration.v4+json'
+
+    @sp_endpoint('/sb/v4/legacyCampaigns/migrationJob', method='POST')
+    def start_migration_job(self, campaignIds, enableThemeTargeting, **kwargs) -> ApiResponse:
+        """
+        Starts a migration job for 3.0 campaigns.
+
+        Request Body [Required]
+            | **campaignIds** (array of string): [required] Campaigns to migrate.
+            | **enableThemeTargeting** (boolean): [required] Carry theme targets
+              into the new campaigns.
+            | **isStagedMigration** (boolean): [optional]
+            | **newCampaignState** (string): [optional] State for the migrated
+              campaigns.
+            | **brandEntityId** (string): [optional]
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        .. warning::
+            **This changes the account.** It starts a real migration of 3.0
+            campaigns into 4.0, which is not something a probe or a retry should
+            trigger by accident. Because of that it was never exercised here: the
+            shape comes from the contract only.
+
+        .. note::
+            Do not treat a timeout as a failed migration. The job may be running;
+            check ``migration_job_status`` before trying again.
+        """
+        body = {'campaignIds': campaignIds, 'enableThemeTargeting': enableThemeTargeting}
+        for key in ('isStagedMigration', 'newCampaignState', 'brandEntityId'):
+            if key in kwargs:
+                body[key] = kwargs.pop(key)
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(body, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_LEGACY,
+                                                     'Content-Type': self._MEDIA_LEGACY})
+
+    @sp_endpoint('/sb/v4/legacyCampaigns/migrationJob/status', method='POST')
+    def migration_job_status(self, jobId, **kwargs) -> ApiResponse:
+        """
+        Gets the status of a migration job.
+
+        Request Body [Required]
+            | **jobId** (string): [required]
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        .. note::
+            An unknown ``jobId`` answers ``500 INTERNAL_ERROR`` rather than a
+            business error. Not a sign that the route is missing.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'jobId': jobId}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_LEGACY,
+                                                     'Content-Type': self._MEDIA_LEGACY})
+
+    @sp_endpoint('/sb/v4/legacyCampaigns/migrationJob/results', method='POST')
+    def migration_job_results(self, jobId, **kwargs) -> ApiResponse:
+        """
+        Lists the per-campaign results of a migration job.
+
+        Request Body [Required]
+            | **jobId** (string): [required]
+            | **nextToken** (string): [optional]
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        .. note::
+            An unknown ``jobId`` answers ``500 INTERNAL_ERROR``, as with the
+            status route.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'jobId': jobId}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_LEGACY,
+                                                     'Content-Type': self._MEDIA_LEGACY})
+
+    @sp_endpoint('/sb/v4/legacyCampaigns/overallMigrationResults', method='POST')
+    def overall_migration_results(self, **kwargs) -> ApiResponse:
+        """
+        Lists every campaign migration result for the advertiser.
+
+        Request Body [Optional]
+            | **nextToken** (string): [optional]
+
+        Returns:
+            | ApiResponse, ``200``. With nothing migrated yet the service answers
+            an empty object rather than a list, so do not assume a ``migrations``
+            key is always present.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(kwargs.pop('body', {}), False),
+                             params=kwargs, headers={'Accept': self._MEDIA_LEGACY,
+                                                     'Content-Type': self._MEDIA_LEGACY})
+
+    @sp_endpoint('/sb/v4/migrations/list', method='POST')
+    def list_migrations(self, **kwargs) -> ApiResponse:
+        """
+        Lists ad migrations.
+
+        Request Body [Optional]
+            | **adGroupIdFilter** ({}): ``include``, a list of ad group ids.
+            | **adIdFilter** ({}): ``include``, a list of ad ids.
+            | **campaignIdFilter** ({}): ``include``, a list of campaign ids.
+            | **adStateFilter** ({}): ``include`` with ``ENABLED``, ``PAUSED``
+              or ``ARCHIVED``.
+            | **migrationStatusFilter** ({}): ``include`` with ``ACCEPTED``,
+              ``ELIGIBLE``, ``MIGRATED`` or ``MIGRATION_FAILED``.
+            | **maxResults** (number): Page size.
+            | **nextToken** (string): Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with ``migrations`` and ``totalCount``.
+
+        Example::
+
+            {"migrations": [], "totalCount": 0}
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(kwargs.pop('body', {}), False),
+                             params=kwargs, headers={'Accept': self._MEDIA_ADMIG,
+                                                     'Content-Type': self._MEDIA_ADMIG})

ad_api/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.5
+Version: 1.1.7
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro

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

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=KlgaVSJ1AQxCDJZgh4wFk-gpem-k9PfebW8U3hiKJD4,22
+ad_api/version.py,sha256=p2qAfdU7zHOShJi2f1FW-_7Tbm0-KCPE7CI7284QiHg,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,11 +24,11 @@ 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=O5D20u5EZdftFRLJLaVmkaLo_Ucs0f52ZEL5b1gkfW0,1488
-ad_api/api/sb/ad_creatives_v4.py,sha256=86sF2lhSc3AC6d4P5TXyEnJMBjn9HvsJe4bbCQbSWK0,10508
+ad_api/api/sb/__init__.py,sha256=APbCAkWM1gzYuhpEUU98XDIKJKJx1NXALjLBXA9zdBU,1538
+ad_api/api/sb/ad_creatives_v4.py,sha256=zQzTivDkGzX3I5ZfCWIlzRUGWfTRsXJZCKQrKMaMDpc,14512
 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/ads_v4.py,sha256=s31OYVO6nyyKRgQAvMc4YtCcHhCo-Anx-r2kq22rPG8,11373
 ad_api/api/sb/benchmarks.py,sha256=eeWv2rrRf4ttK-oI1EEEiui_rl_sxJk9yXcu6sDSfhg,3645
 ad_api/api/sb/bid_recommendations.py,sha256=ssO9XwYC9wK2GFaLtcsC-D3cZhDpCclcu1r01LTkZAw,2297
 ad_api/api/sb/brands.py,sha256=XIMDzV0tJoPiOcY0KoCKcyIwYLPMlJ-zkB2SeRVMF4Q,1376
@@ -40,6 +40,7 @@ ad_api/api/sb/keywords.py,sha256=P1dGqcLia349O0CwpBRURlIzgRc0cbFotkAGTSrErt4,763
 ad_api/api/sb/keywords_recommendations.py,sha256=oA4FRBwDtk52SZK0RgWvjNQ7K2GX0G2zSoisJGiEYDw,629
 ad_api/api/sb/landing_page_asins.py,sha256=j3qi2-KccuEzGLZrl6EfZBSikW2R4B4l7TixpkAnTq8,1259
 ad_api/api/sb/media.py,sha256=5LTeM4AHSDKw_58aTB2nEZhIYdWkztH0syBXaovS1rs,2529
+ad_api/api/sb/migration.py,sha256=2Pse2ixv73ZzqKhoCq6hAHzilAXwP8iphuIzTIOWIUE,7091
 ad_api/api/sb/negative_keywords.py,sha256=ww3IRbawidDHAaYIkX5SsH2OZKJj4UnCylqqFeq3OoY,6918
 ad_api/api/sb/negative_product_targeting.py,sha256=QbK1EhhzmnNOzGtbkrAZ4HS5OqiLU3nZBmsl1scd2D0,5085
 ad_api/api/sb/optimization_rules.py,sha256=aj9tZwKdaOzjnAN-8FHb49aiejNZKCCCcR8fjffH4k0,6802
@@ -107,8 +108,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.1.5.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.1.5.dist-info/METADATA,sha256=Bv5SRj3TNj5OvxigNtRz_LataskuZX8W2VsBcKGrz_U,20486
-python_amazon_ad_api-1.1.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.1.5.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.1.5.dist-info/RECORD,,
+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,,