python-amazon-ad-api 1.2.8__py3-none-any.whl → 1.3.0__py3-none-any.whl

ad_api/api/__init__.py

@@ -3,6 +3,7 @@ from .profiles import Profiles
 from .manager_accounts import ManagerAccounts
 from .invoices import Invoices
 from .billing import Billing
+from .account_budgets import AccountBudgets
 from .eligibility import Eligibility
 from .metadata import Metadata
 from .history import History
@@ -38,6 +39,7 @@ __all__ = [
     "ManagerAccounts",
     "Invoices",
     "Billing",
+    "AccountBudgets",
     "Eligibility",
     "Metadata",
     "History",
@@ -45,6 +47,7 @@ __all__ = [
     "Localization",
     "Audiences",
     "Portfolios",
+    "PortfoliosV3",
     "Insights",
     "Attribution",
     "BrandMetrics",

ad_api/api/account_budgets.py

@@ -0,0 +1,53 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class AccountBudgets(Client):
+    """ """
+
+    @sp_endpoint('/accountBudgets/featureFlags', method='GET')
+    def get_feature_flags(self, **kwargs) -> ApiResponse:
+        r"""
+        Reports whether the account has opted out of automatic budget increases.
+
+        Returns
+            ApiResponse with a ``featureFlags`` object holding one member,
+            ``isOptedOutForAverageDailyBudgetIncrease``. At ``true`` the account
+            has opted out, and the service will not raise a campaign's daily
+            budget on its own; at ``false`` it may.
+
+        """
+        headers = {'Accept': 'application/vnd.accountBudgetFeatureFlags.v1+json'}
+        return self._request(kwargs.pop('path'), params=kwargs, headers=headers)
+
+    @sp_endpoint('/accountBudgets/featureFlags', method='POST')
+    def update_feature_flags(self, **kwargs) -> ApiResponse:
+        r"""
+        Changes whether the account opts out of automatic budget increases.
+
+        Request Body (required)
+
+        - ``featureFlags`` (object): required. A ``FeatureFlags`` object holding
+          ``isOptedOutForAverageDailyBudgetIncrease``. Set it to ``true`` to stop
+          the service raising daily budgets on its own, ``false`` to allow it.
+
+        .. warning::
+
+            This changes how the account is charged. With the flag at ``false``
+            the service may raise a campaign's daily budget without another call
+            from you, and spend follows the budget. Not exercised here: the
+            setting belongs to the account holder.
+
+        Returns
+            ApiResponse with ``code`` and ``details``, not with the flags read
+            back. ``code`` is ``OK``, ``ENTRY_NOT_FOUND`` or
+            ``INVALID_PARAMETER_VALUE``, so a ``200`` carrying something other
+            than ``OK`` means the change did not land. Read the flags again with
+            ``get_feature_flags`` to confirm.
+
+        """
+        headers = {
+            'Accept': 'application/vnd.accountBudgetFeatureFlags.v1+json',
+            'Content-Type': 'application/vnd.accountBudgetFeatureFlags.v1+json',
+        }
+        body = Utils.convert_body(kwargs.pop('body'), False)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs, headers=headers)

ad_api/api/recommendations.py

@@ -13,7 +13,7 @@ class Recommendations(Client):
             | ListRecommendationsRequest {
             | **maxResults** (integer) default: 500 minimum: 1 maximum: 500
             | **nextToken** (string) Token to retrieve the next page of results.
-            | **filters**\* (array) minItems: 1 maxItems: 10 [
+            | **filters** (array) minItems: 1 maxItems: 10 [
             |   ListRecommendationsFilter {
             |       **include** (boolean): Flag to specify if the filter should be included or excluded. default: true
             |       **field**\* FilterField (string): Field to filter by. Enum: ['RECOMMENDATION_ID', 'AD_PRODUCT', 'RECOMMENDATION_TYPE', 'STATUS', 'GROUPING_TYPE', 'CAMPAIGN_ID']
@@ -24,8 +24,27 @@ class Recommendations(Client):
             |       }
             |   ]
             | }
+
+        The values ``STATUS`` accepts are not the states of a campaign. They are
+        the stages a recommendation passes through, and the service names them in
+        its rejection message: ``PUBLISHED``, ``APPLY_IN_PROGRESS``,
+        ``APPLY_SUCCESS``, ``APPLY_FAILED`` and ``REJECTED``. ``ENABLED`` and
+        ``ACTIVE`` are refused.
+
+        ``filters`` behaves oddly. An empty list answers
+        ``400 Member must have length greater than or equal to 1``, yet leaving
+        the member out altogether answers ``200`` with the account's
+        recommendations. So it is required when present, and optional in
+        practice.
+
+        A body is required: without one the call fails before reaching the
+        service, with ``KeyError: 'body'``.
+
         Returns
-            ApiResponse
+            ApiResponse with ``recommendations``, ``totalResults`` and
+            ``nextToken``. The list is empty for an account that has none, which
+            is a fact about the account rather than a failed call.
+
         """
         schema_version = 'application/vnd.listRecommendationsRequest.v' + str(version) + '+json'
         headers = {"Accept": schema_version, "Content-Type": schema_version}
@@ -42,6 +61,15 @@ class Recommendations(Client):
             |       (string) Recommendation identifier.
             |   ]
             | }
+
+        .. warning::
+
+            This changes campaigns. Applying a recommendation edits real bidding
+            and budgets on the account, and there is no undo richer than
+            changing them back by hand.
+
+            Not exercised: no recommendation existed on the account to apply.
+
         Returns
             ApiResponse
         """
@@ -79,6 +107,15 @@ class Recommendations(Client):
             |       }
             |   }
             | }
+
+        .. warning::
+
+            This edits a recommendation before it is applied. Read one first with
+            ``list_recommendations`` for the shape it expects, since the fields
+            change with ``recommendationType``.
+
+            Not exercised, for the same reason as ``apply_recommendations``.
+
         Returns
             ApiResponse
 

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.2.8"
+__version__ = "1.3.0"

{python_amazon_ad_api-1.2.8.dist-info → python_amazon_ad_api-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.8
+Version: 1.3.0
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -266,6 +266,7 @@ curl \
 * [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [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)
+* [Account Budgets](https://python-amazon-ad-api.readthedocs.io/en/latest/api/account_budgets.html)
 * [Audiences](https://python-amazon-ad-api.readthedocs.io/en/latest/api/audiences.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)
@@ -274,7 +275,7 @@ curl \
 * [Localization](https://python-amazon-ad-api.readthedocs.io/en/latest/api/localization.html)
 * [Product Selector](https://python-amazon-ad-api.readthedocs.io/en/latest/api/metadata.html)
 * [Validation Configurations](https://python-amazon-ad-api.readthedocs.io/en/latest/api/validation_configurations.html)
-* [Tactical recommendations beta](https://python-amazon-ad-api.readthedocs.io/en/latest/api/recommendations.html)
+* [Tactical recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/api/recommendations.html)
 * [Exports](https://advertising.amazon.com/API/docs/en-us/exports)
 
 

{python_amazon_ad_api-1.2.8.dist-info → python_amazon_ad_api-1.3.0.dist-info}/RECORD

@@ -1,7 +1,8 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=CfVXm0wwlKPW0khOcwhWw61TpgtZiLijCePsAIOK3aU,22
-ad_api/api/__init__.py,sha256=E9c0ZyK4vplMlKKEBF8CV5u7P4uSkTMSQsAuSQu5bfY,1514
+ad_api/version.py,sha256=F5mW07pSyGrqDNY2Ehr-UpDzpBtN-FsYU0QGZWf6PJE,22
+ad_api/api/__init__.py,sha256=TLMefdmuyrj3-vtxGlzX4Sl-lHmE3Rs6daYgw3zwO0c,1600
 ad_api/api/account.py,sha256=CmOvCfHoPWaeTUJvtB0pNoNulZVSz4oMMCKIpVTpHos,2931
+ad_api/api/account_budgets.py,sha256=jFce5eLWAFK3ydjnYR7_Sv7B0-gHTG5bMTx_TcHyy1A,2319
 ad_api/api/advertising_test_account.py,sha256=btOVbdk2tBDmyKSJaQbcIFyzNG8KFJVUmTe4p9xMhpU,1507
 ad_api/api/attribution.py,sha256=vHmXP0wDqhEqaS1q3tJyERxJ1JwntqoEb73LVXNHxR0,5121
 ad_api/api/audiences.py,sha256=TQPt4avswFdCodNfQGDGxcJ2mY2LP2BfYvjxP6oJ0qY,3491
@@ -19,7 +20,7 @@ ad_api/api/metadata.py,sha256=vWPbDGvEB72421fjSu4KrNkTdrIijHTPV8k36hceSbA,2406
 ad_api/api/portfolios.py,sha256=Oe3LS2HsjMJSq1Id8cwOWrH2AiPMcBb7oTkFHjudnTI,7103
 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/recommendations.py,sha256=_r4LsJkRTkiuOvzS7wrtR2ZmxA7gGe-T4jRDAqM6pRo,6198
 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
@@ -108,8 +109,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.8.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.2.8.dist-info/METADATA,sha256=Gu3pJw5dG36SOI5utdAevmjKaG-xqxVPW_tr_dhNuBI,21458
-python_amazon_ad_api-1.2.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.2.8.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.2.8.dist-info/RECORD,,
+python_amazon_ad_api-1.3.0.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.3.0.dist-info/METADATA,sha256=rN92CtI2QXdshEfkqjmzsNCIN7wVnJFGHXLBuPdVw50,21553
+python_amazon_ad_api-1.3.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.3.0.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.3.0.dist-info/RECORD,,