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

ad_api/api/history.py

@@ -5,26 +5,49 @@ class History(Client):
     """ """
 
     @sp_endpoint('/history', method='POST')
-    def get_history(self, **kwargs) -> ApiResponse:
+    def get_history(self, version: str = "1.0", **kwargs) -> ApiResponse:
         r"""
-
-        get_history(body: (dict, str, file)) -> ApiResponse
-
-        Returns history of changes for provided event sources that match the filters and time ranges specified. Only events that belong to the authenticated Advertiser can be queried. All times will be in UTC Epoch format. This API accepts identifiers in either the alphamumeric format (default), or the numeric format. If numeric IDs are supplied, then numeric IDs will be returned otherwise, alphanumeric IDs are returned.
-
-        body: | REQUIRED {'description': 'A HistoryQuery}'
-
-            | **from_date** | **int** | Max 90 days of history.
-            | **to_date** | **int** |
-            | **event_types**
-                | HistoryEventType
-            | **next_token** | **str** | token from previous response to get next set of data. | [optional]
-            | **page_offset** | **int** | Mutually exclusive with 'nextToken'. Max results with pageOffset is 10000. Use nextToken instead for more results. | [optional]
-            | **count** | **int** | Requested number of results. Default 100. Minimum 50. Maximum 200. | [optional]
-            | **sort**
-                | HistorySortParameter
-            | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+        Returns the changes made to campaigns, ad groups, ads and the rest of the
+        entity tree, within a time range. Only events belonging to the
+        authenticated advertiser come back.
+
+        Keyword Args
+
+        - ``version`` (string): the ``Accept`` version, ``"1.0"`` by default.
+          Pass ``"1.1"`` to query the ``THEME`` event type, which the service
+          refuses at 1.0. The other six types work at either. [optional]
+
+        Request Body (required)
+
+        - ``fromDate`` (integer): epoch in **milliseconds**, not seconds.
+        - ``toDate`` (integer): epoch in milliseconds.
+        - ``eventTypes`` (object): one or more of ``AD``, ``AD_GROUP``,
+          ``CAMPAIGN``, ``KEYWORD``, ``NEGATIVE_KEYWORD``, ``PRODUCT_TARGETING``
+          and ``THEME``. Each carries an object, usually ``{}`` or
+          ``{"filters": [...]}``.
+        - ``count`` (integer): page size. Default 100, minimum 50, maximum 200.
+        - ``nextToken`` (string): token from a previous answer. Mutually
+          exclusive with ``pageOffset``.
+        - ``pageOffset`` (integer): alternative to ``nextToken``, up to 10000.
+        - ``sort`` (object): ``{"direction": "ASC"|"DESC", "key": "DATE"}``.
+
+        The field names are camelCase and the service rejects anything else: a
+        body written with ``from_date`` answers ``400`` naming ``fromDate`` as a
+        required field. The dates are counted back from the moment of the
+        request, so a window computed once and reused drifts out of range: the
+        service measures 90 days from its own clock, and a few seconds of drift
+        past the edge answers ``400 fromDate is more than 90 days ago``.
+
+        This route throttles. Seven calls within twelve seconds answered ``429``.
+
+        Returns
+            ApiResponse with ``events``, ``pageSize``, ``pageOffset``,
+            ``maxPageNumber`` and ``totalRecords``. An empty ``events`` with
+            ``totalRecords`` at ``0`` means the account saw no change in the
+            window, not that the call failed.
 
         """
+        accept = 'application/vnd.historyresponse.v' + version + '+json'
+        headers = {'Accept': accept}
         body = Utils.convert_body(kwargs.pop('body'), wrap=False)
-        return self._request(kwargs.pop('path'), data=body, params=kwargs)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs, headers=headers)

ad_api/api/portfolios_v3.py

@@ -79,8 +79,8 @@ class PortfoliosV3(Client):
 
         Returns
             ApiResponse with ``success`` and ``error`` lists, each item keyed by
-            the ``index`` it held in the body. Answers ``207``, a multi-status,
-            not ``200``.
+            the ``index`` it held in the body. The contract answers ``207``, a
+            multi-status, not ``200``.
 
         """
         schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
@@ -118,8 +118,8 @@ class PortfoliosV3(Client):
 
         Returns
             ApiResponse with ``success`` and ``error`` lists, each item keyed by
-            the ``index`` it held in the body. Answers ``207``, a multi-status,
-            not ``200``.
+            the ``index`` it held in the body. The contract answers ``207``, a
+            multi-status, not ``200``.
 
         """
         schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
@@ -143,8 +143,14 @@ class PortfoliosV3(Client):
         Returns
             ApiResponse split into ``success`` and ``error``. A successful entry
             carries ``portfolioId``, ``index``, ``budget``,
-            ``budgetUsagePercent`` and ``usageUpdatedTimestamp``. Answers
-            ``207``, a multi-status, not ``200``.
+            ``budgetUsagePercent`` and ``usageUpdatedTimestamp``. The contract
+            answers ``207``, a multi-status, not ``200``.
+
+        A portfolio set to ``NO_CAP`` answers ``9999999999.0`` here rather than
+        an absent figure, and ``budgetUsagePercent`` reads ``0.0`` against it.
+        The same portfolio carries no ``amount`` at all in ``list_portfolios``.
+        Treat that number as no ceiling, not as money, or a sum over the account
+        comes out in the billions.
 
         """
         schema_version = 'application/vnd.portfoliobudgetusage.v' + str(version) + '+json'

ad_api/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.3
+Version: 1.2.5
 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.2.3.dist-info → python_amazon_ad_api-1.2.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=C-D_WWrVkBDmQmApLcm0sWNh2CgIrwWfc8_sB5vvU-Q,22
+ad_api/version.py,sha256=jBmZf3HLbiQlWiolOsAA6J5-BbxXD2bqFqEqDH3lfqo,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
@@ -10,14 +10,14 @@ ad_api/api/brand_metrics.py,sha256=IlOlVJ2t6cL5DA49RaM3M1AW_3KFEyal08e0ZcnLdVE,6
 ad_api/api/creative_assets.py,sha256=EzxrQbxMe5Y1b6qONJ3zi8cwoorCZAqSmHhiug6d87E,6671
 ad_api/api/eligibility.py,sha256=xbHMNxpRqToQDlG8y7nhhSr55ZZIJ_ZA304rmWa7Jx0,3680
 ad_api/api/exports.py,sha256=Y59C99axCAltMgu3gbfzdnoLKjNTsJ7s1z18yzcxzls,2788
-ad_api/api/history.py,sha256=KmpUodvxTQPSeJ1kyOSm_uHnfaR23Y6SUvB3gYn5uh4,1727
+ad_api/api/history.py,sha256=tB4XawmQNxDMolaubDUjuIHtrYXRFuhOr4WCB8OJ1t8,2568
 ad_api/api/insights.py,sha256=Z4h00erksU58yjGm5qX_sHKDAv5UuJagqCA0d3rUlJU,2932
 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
 ad_api/api/metadata.py,sha256=vWPbDGvEB72421fjSu4KrNkTdrIijHTPV8k36hceSbA,2406
 ad_api/api/portfolios.py,sha256=Oe3LS2HsjMJSq1Id8cwOWrH2AiPMcBb7oTkFHjudnTI,7103
-ad_api/api/portfolios_v3.py,sha256=eoVCO0UzJZ9L2nGKkEh8nq-V8wANJsXb4bdM2asuk1A,6447
+ad_api/api/portfolios_v3.py,sha256=qqIzXmhnb3g2QmTENsgzOayhvOObgI-rD7PTfftgDQg,6842
 ad_api/api/profiles.py,sha256=mMSCUd5HdR_nFBDFngLY94tIfMCA4yGnjHz-PSMe0rE,7200
 ad_api/api/recommendations.py,sha256=aVDnnX8GEhdOVSKypIs8lyUJCiFxo9ujMYVXqzHTvBc,4633
 ad_api/api/reports.py,sha256=gNmDHLULD2uaJgsMpIbCX9kabwhMXRr9WfZBtHUdsOY,6043
@@ -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.3.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.2.3.dist-info/METADATA,sha256=On7nRch4tuPN_bwIc7Zz4kSZR0lRbtX1mVJqqR181yU,21479
-python_amazon_ad_api-1.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.2.3.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.2.3.dist-info/RECORD,,
+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,,