python-amazon-ad-api 1.2.5__tar.gz → 1.2.7__tar.gz

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.5
+Version: 1.2.7
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -267,8 +267,8 @@ curl \
 * [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)
-* [Change History open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
-* [Creative Assets open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api//creative_assets.html)
+* [Change History](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
+* [Creative Assets](https://python-amazon-ad-api.readthedocs.io/en/latest/api/creative_assets.html)
 * [Elegibility](https://python-amazon-ad-api.readthedocs.io/en/latest/api/eligibility.html)
 * [Insights](https://python-amazon-ad-api.readthedocs.io/en/latest/api/insights.html)
 * [Localization](https://python-amazon-ad-api.readthedocs.io/en/latest/api/localization.html)

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/README.md

@@ -239,8 +239,8 @@ curl \
 * [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)
-* [Change History open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
-* [Creative Assets open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api//creative_assets.html)
+* [Change History](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
+* [Creative Assets](https://python-amazon-ad-api.readthedocs.io/en/latest/api/creative_assets.html)
 * [Elegibility](https://python-amazon-ad-api.readthedocs.io/en/latest/api/eligibility.html)
 * [Insights](https://python-amazon-ad-api.readthedocs.io/en/latest/api/insights.html)
 * [Localization](https://python-amazon-ad-api.readthedocs.io/en/latest/api/localization.html)

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/ad_api/api/creative_assets.py

@@ -1,4 +1,4 @@
-from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
 
 
 class CreativeAssets(Client):
@@ -121,3 +121,71 @@ class CreativeAssets(Client):
 
         """
         return self._request(kwargs.pop('path'), params=kwargs)
+
+    @sp_endpoint('/assets/batchRegister', method='POST')
+    def batch_register_assets(self, **kwargs) -> ApiResponse:
+        r"""
+        Registers several uploaded assets in one call.
+
+        This route is asynchronous. It answers a ``requestId`` and nothing else,
+        so the result has to be read with ``get_batch_register_status``.
+
+        Request Body (required)
+
+        - ``assetDetailsList`` (array): between 1 and 50 entries, each one shaped
+          like the body ``register_asset`` accepts:
+
+          - ``url`` (string): where the file sits, from ``upload_asset``.
+          - ``name`` (string): the name to give the asset.
+          - ``assetType`` (string): ``IMAGE``.
+          - ``assetSubTypeList`` (array): ``LOGO``, ``PRODUCT_IMAGE``,
+            ``AUTHOR_IMAGE``, ``LIFESTYLE_IMAGE`` or ``OTHER_IMAGE``.
+          - ``asinList`` (array): tags the asset with ASINs, so it can be found
+            by product later.
+          - ``associatedPrograms`` (array): up to 100 entries, one per program
+            the asset belongs to.
+          - ``otherMetadata`` (object): free key-value pairs of strings.
+          - ``tagList`` (array): tags for the asset.
+          - ``versionInfo`` (object): ``linkedAssetId`` and ``versionNotes``, to
+            register this file as a new version of an existing asset.
+          - ``skipAssetSubTypesDetection`` (boolean): keep the subtype as given
+            instead of letting the service reclassify it.
+
+        - ``batchRegistrationContext`` (object): the context applied to the whole
+          batch.
+
+        Returns
+            ApiResponse with ``requestId``, which ``get_batch_register_status``
+            takes.
+
+        """
+        headers = {
+            'Accept': 'application/vnd.assetsbatchregisterresponse.v1+json',
+            'Content-Type': 'application/vnd.assetsbatchregisterrequest.v1+json',
+        }
+        body = Utils.convert_body(kwargs.pop('body'), wrap=False)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs, headers=headers)
+
+    @sp_endpoint('/assets/batchRegister/{}', method='GET')
+    def get_batch_register_status(self, requestId, **kwargs) -> ApiResponse:
+        r"""
+        Reports whether a batch registration has finished.
+
+        The ``requestId`` comes from ``batch_register_assets``. An id the service
+        does not know answers ``400`` with
+        ``AARServiceBadRequestException ... No request exists for the requestId``,
+        not a ``404``: the route answers either way, and the message says the id
+        was not found.
+
+        Path
+
+        - ``requestId`` (string): required. The identifier the batch call
+          returned.
+
+        Returns
+            ApiResponse with the state of that batch.
+
+        """
+        headers = {'Accept': 'application/vnd.creativeassetsgetbatchregisterresponse.v3+json'}
+        return self._request(fill_query_params(kwargs.pop('path'), requestId),
+                             params=kwargs, headers=headers)

python_amazon_ad_api-1.2.7/ad_api/api/insights.py

@@ -0,0 +1,52 @@
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class Insights(Client):
+    """ """
+
+    @sp_endpoint('/insights/audiences/{}/overlappingAudiences', method='GET')
+    def get_insights(self, audienceId: str, version: int = 2, **kwargs) -> ApiResponse:
+        r"""
+        Returns the audiences that overlap with the one given, ranked by affinity.
+
+        Keyword Args
+
+        - ``version`` (int): the ``Accept`` version. **Only 2 answers**; 1 was
+          retired and replies ``415`` naming v2 as the sole supported type.
+          Defaults to 2. [optional]
+
+        Path
+
+        - ``audienceId`` (string): required. The audience to measure against.
+
+        Query
+
+        - ``adType`` (string): required in practice, ``SD`` or ``DSP``. When it
+          is left out the service assumes ``DSP`` and answers
+          ``400 Missing advertiserId parameter for DSP request``, which names the
+          wrong parameter. Send it explicitly.
+        - ``advertiserId`` (string): required for ``DSP``, ignored for ``SD``.
+        - ``audienceCategory`` (string): keep only audiences of that category,
+          such as ``"In-market"``. The contract calls it an array; a plain string
+          is what the service accepts and applies.
+        - ``maxResults`` (integer): how many overlaps to return. Default 30.
+          Works, and the count follows it.
+        - ``nextToken`` (string): token from a previous answer. Subsequent calls
+          must repeat the same parameters.
+
+        Three parameters are accepted and then ignored: ``minimumAudienceSize``,
+        ``maximumAudienceSize`` and ``minimumOverlapAffinity``. The call answers
+        ``200`` with the same count as without them, so a filter that was never
+        applied is indistinguishable from one that matched everything. Check the
+        count, not the status.
+
+        Returns
+            ApiResponse with ``requestedAudienceMetadata``, ``overlappingAudiences``,
+            ``marketplace`` and ``nextToken``. Each overlap carries
+            ``audienceMetadata`` and ``affinity``, a number where higher means a
+            closer match.
+
+        """
+        contentType = 'application/vnd.insightsaudiencesoverlap.v' + str(version) + '+json'
+        headers = {'Accept': contentType}
+        return self._request(fill_query_params(kwargs.pop('path'), audienceId), params=kwargs, headers=headers)

python_amazon_ad_api-1.2.7/ad_api/version.py

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

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.5
+Version: 1.2.7
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -267,8 +267,8 @@ curl \
 * [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)
-* [Change History open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
-* [Creative Assets open Beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api//creative_assets.html)
+* [Change History](https://python-amazon-ad-api.readthedocs.io/en/latest/api/history.html)
+* [Creative Assets](https://python-amazon-ad-api.readthedocs.io/en/latest/api/creative_assets.html)
 * [Elegibility](https://python-amazon-ad-api.readthedocs.io/en/latest/api/eligibility.html)
 * [Insights](https://python-amazon-ad-api.readthedocs.io/en/latest/api/insights.html)
 * [Localization](https://python-amazon-ad-api.readthedocs.io/en/latest/api/localization.html)

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/setup.cfg

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

{python_amazon_ad_api-1.2.5 → python_amazon_ad_api-1.2.7}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='1.2.5',
+    version='1.2.7',
     install_requires=[
         "requests>=2.27.1,<2.35.0",
         "six>=1.16,<1.18",

python_amazon_ad_api-1.2.5/ad_api/api/insights.py

@@ -1,42 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
-
-
-class Insights(Client):
-    """ """
-
-    @sp_endpoint('/insights/audiences/{}/overlappingAudiences', method='GET')
-    def get_insights(self, audienceId: str, version: int = 1, **kwargs) -> ApiResponse:
-        r"""
-        get_insights(audienceId: str, version: int = 1, **kwargs) -> ApiResponse
-
-        Retrieves the top audiences that overlap with the provided audience.
-
-        Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
-
-        path **audienceId**:string | Required. The identifier of an audience.
-
-        internal **version**:int | Optional. The version of the overlapping audiences accept 'application/vnd.insightsaudiencesoverlap.v'+str(version)+'+json'. Available values : 1, 2 Default: 1
-
-        query **adType**:string | Required. The advertising program. Available values : DSP, SD
-
-        query **advertiserId**:string | Optional. The identifier of the advertiser you'd like to retrieve overlapping audiences for. This parameter is required for the DSP adType, but is optional for the SD adType.
-
-        query **minimumAudienceSize**:number | Optional. If specified, the sizes of all returned overlapping audiences will be at least the provided size. This parameter is supported only for request to return application/vnd.insightsaudiencesoverlap.v1+json.
-
-        query **maximumAudienceSize**:number | Optional. If specified, the sizes of all returned overlapping audiences will be at most the provided size. This parameter is supported only for request to return application/vnd.insightsaudiencesoverlap.v1+json.
-
-        query **minimumOverlapAffinity**:number | Optional. If specified, the affinities of all returned overlapping audiences will be at least the provided affinity.
-
-        query **maximumOverlapAffinity**:number | Optional. If specified, the affinities of all returned overlapping audiences will be at most the provided affinity.
-
-        query **audienceCategory**:array[string] | Optional. f specified, the categories of all returned overlapping audiences will be one of the provided categories.
-
-        query **maxResults**:integer | Optional. Sets the maximum number of overlapping audiences in the response. This parameter is supported only for request to return application/vnd.insightsaudiencesoverlap.v2+json. Default value : 30
-
-        query **nextToken**:string | Optional. TToken to be used to request additional overlapping audiences. If not provided, the top 30 overlapping audiences are returned. Note: subsequent calls must be made using the same parameters as used in previous requests.
-
-        """
-
-        contentType = 'application/vnd.insightsaudiencesoverlap.v' + str(version) + '+json'
-        headers = {'Accept': contentType}
-        return self._request(fill_query_params(kwargs.pop('path'), audienceId), params=kwargs, headers=headers)

python_amazon_ad_api-1.2.5/ad_api/version.py

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