python-amazon-ad-api 1.2.5__py3-none-any.whl → 1.2.7__py3-none-any.whl

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)

ad_api/api/insights.py

@@ -5,38 +5,48 @@ class Insights(Client):
     """ """
 
     @sp_endpoint('/insights/audiences/{}/overlappingAudiences', method='GET')
-    def get_insights(self, audienceId: str, version: int = 1, **kwargs) -> ApiResponse:
+    def get_insights(self, audienceId: str, version: int = 2, **kwargs) -> ApiResponse:
         r"""
-        get_insights(audienceId: str, version: int = 1, **kwargs) -> ApiResponse
+        Returns the audiences that overlap with the one given, ranked by affinity.
 
-        Retrieves the top audiences that overlap with the provided audience.
+        Keyword Args
 
-        Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
+        - ``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 identifier of an audience.
+        Path
 
-        internal **version**:int | Optional. The version of the overlapping audiences accept 'application/vnd.insightsaudiencesoverlap.v'+str(version)+'+json'. Available values : 1, 2 Default: 1
+        - ``audienceId`` (string): required. The audience to measure against.
 
-        query **adType**:string | Required. The advertising program. Available values : DSP, SD
+        Query
 
-        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.
+        - ``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.
 
-        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.
+        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.
 
-        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.
+        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)

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.2.5"
+__version__ = "1.2.7"

{python_amazon_ad_api-1.2.5.dist-info → python_amazon_ad_api-1.2.7.dist-info}/METADATA

@@ -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.dist-info → python_amazon_ad_api-1.2.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=jBmZf3HLbiQlWiolOsAA6J5-BbxXD2bqFqEqDH3lfqo,22
+ad_api/version.py,sha256=49prCLbE3fFzLfxem5rd2dr1iV4_L-bN0N4J7jxU5yA,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
@@ -7,11 +7,11 @@ ad_api/api/attribution.py,sha256=vHmXP0wDqhEqaS1q3tJyERxJ1JwntqoEb73LVXNHxR0,512
 ad_api/api/audiences.py,sha256=TQPt4avswFdCodNfQGDGxcJ2mY2LP2BfYvjxP6oJ0qY,3491
 ad_api/api/billing.py,sha256=84UhquQRAYGle7sGccP6mgsypLw_c_gJi3qe1uYLmYk,4364
 ad_api/api/brand_metrics.py,sha256=IlOlVJ2t6cL5DA49RaM3M1AW_3KFEyal08e0ZcnLdVE,6036
-ad_api/api/creative_assets.py,sha256=EzxrQbxMe5Y1b6qONJ3zi8cwoorCZAqSmHhiug6d87E,6671
+ad_api/api/creative_assets.py,sha256=u0bCnioUFpGOQO5Z_MO0ErSLcAgSZB5GWM5wm2oW6L0,9687
 ad_api/api/eligibility.py,sha256=xbHMNxpRqToQDlG8y7nhhSr55ZZIJ_ZA304rmWa7Jx0,3680
 ad_api/api/exports.py,sha256=Y59C99axCAltMgu3gbfzdnoLKjNTsJ7s1z18yzcxzls,2788
 ad_api/api/history.py,sha256=tB4XawmQNxDMolaubDUjuIHtrYXRFuhOr4WCB8OJ1t8,2568
-ad_api/api/insights.py,sha256=Z4h00erksU58yjGm5qX_sHKDAv5UuJagqCA0d3rUlJU,2932
+ad_api/api/insights.py,sha256=b0m2_khfDGskbvn4sidsUpOvV-gr2bsjUup0kSo8HV8,2398
 ad_api/api/invoices.py,sha256=EwSUVPOTxu1zYPSh0Bg6sCQ22evnUrMJBgU8ZttWN4w,1579
 ad_api/api/localization.py,sha256=HdkChAawloJ8zj5rCye9NVf7kLnQ7vW6aKsBLZ2W-gI,17158
 ad_api/api/manager_accounts.py,sha256=tnmJxOGIKTuJ3i8wciwfs931REW0aeNKQiqCpBrTZ2Y,5107
@@ -108,8 +108,8 @@ ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,438
 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.2.5.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.2.5.dist-info/METADATA,sha256=d0ANyn2SfwsIwQhEhdzfFUXzkTonM4Y94nwyDhdyCAU,21479
-python_amazon_ad_api-1.2.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.2.5.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.2.5.dist-info/RECORD,,
+python_amazon_ad_api-1.2.7.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.2.7.dist-info/METADATA,sha256=eyFJj-IHXJy_NCd7MJW1Chqqyu3iGvC_vHT8Yum1GUw,21458
+python_amazon_ad_api-1.2.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.2.7.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.2.7.dist-info/RECORD,,