python-amazon-ad-api 1.1.2__tar.gz → 1.1.4__tar.gz

{python_amazon_ad_api-1.1.2 → python_amazon_ad_api-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.2
+Version: 1.1.4
 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.2 → python_amazon_ad_api-1.1.4}/ad_api/api/sb/__init__.py

@@ -20,6 +20,8 @@ from .media import Media
 from .reports import Reports
 from .benchmarks import Benchmarks
 from .themes import Themes
+from .budget_rules import BudgetRules
+from .optimization_rules import OptimizationRules
 
 __all__ = [
     "Brands",
@@ -43,5 +45,7 @@ __all__ = [
     "Media",
     "Reports",
     "Benchmarks",
-    "Themes"
+    "Themes",
+    "BudgetRules",
+    "OptimizationRules",
 ]

python_amazon_ad_api-1.1.4/ad_api/api/sb/budget_rules.py

@@ -0,0 +1,235 @@
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
+
+
+class BudgetRules(Client):
+    """Sponsored Brands budget rules.
+
+    Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/4-0/openapi
+
+    Read routes were probed against the live service; the write routes are built
+    from the contract and not exercised, because they change campaign budgets.
+
+    .. note::
+        ``budget_recommendations`` only answers with the versioned media type.
+        Sending ``application/json`` makes the router answer ``404 Could not find
+        resource``, as if the route did not exist. Amazon routes on media type.
+
+    .. note::
+        An unknown ``budgetRuleId`` answers ``400 InvalidParameterValue`` with
+        ``errorCode 240002``, not a 404. The identifier is validated before it is
+        looked up.
+    """
+
+    _MEDIA_JSON = 'application/json'
+    _MEDIA_USAGE = 'application/vnd.sbcampaignbudgetusage.v1+json'
+    _MEDIA_RECS = 'application/vnd.sbbudgetrecommendation.v4+json'
+
+    @sp_endpoint('/sb/budgetRules', method='GET')
+    def list_budget_rules(self, pageSize, **kwargs) -> ApiResponse:
+        """
+        Gets the budget rules of the advertiser.
+
+        Keyword Args
+            | query **pageSize** (number): [required] Results per page.
+            | query **nextToken** (string): Pagination token. [optional]
+
+        Returns:
+            | ApiResponse, with the rules under ``budgetRulesForAdvertiserResponse``
+              and a ``nextToken``.
+        """
+        return self._request(kwargs.pop('path'), params=kwargs,
+                             headers={'Accept': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/budgetRules/{}', method='GET')
+    def get_budget_rule(self, budgetRuleId, **kwargs) -> ApiResponse:
+        """
+        Gets one budget rule by identifier.
+
+        Keyword Args
+            | path **budgetRuleId** (string): [required]
+        """
+        return self._request(fill_query_params(kwargs.pop('path'), budgetRuleId),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/budgetRules/{}/campaigns', method='GET')
+    def list_rule_campaigns(self, budgetRuleId, pageSize, **kwargs) -> ApiResponse:
+        """
+        Gets the campaigns associated with a budget rule.
+
+        Keyword Args
+            | path **budgetRuleId** (string): [required]
+            | query **pageSize** (number): [required]
+            | query **nextToken** (string): [optional]
+        """
+        return self._request(fill_query_params(kwargs.pop('path'), budgetRuleId),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/campaigns/{}/budgetRules', method='GET')
+    def list_campaign_rules(self, campaignId, **kwargs) -> ApiResponse:
+        """
+        Gets the budget rules associated with a campaign.
+
+        Keyword Args
+            | path **campaignId** (number): [required]
+
+        Returns:
+            | ApiResponse, with the rules under ``associatedRules``.
+        """
+        return self._request(fill_query_params(kwargs.pop('path'), campaignId),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/budgetRules', method='POST')
+    def create_budget_rules(self, budgetRulesDetails, **kwargs) -> ApiResponse:
+        """
+        Creates budget rules.
+
+        Request Body [Required]
+            | **budgetRulesDetails** (array): One entry per rule.
+                | **name** (string): Rule name.
+                | **ruleType** (string): ``SCHEDULE`` or ``PERFORMANCE``.
+                | **budgetIncreaseBy** ({}): ``type`` (``PERCENT``) and ``value``.
+                | **performanceMeasureCondition** ({}): ``metricName`` (``IS``,
+                  ``NTB`` or ``ROAS``), ``comparisonOperator`` (``GREATER_THAN``,
+                  ``LESS_THAN``, ``LESS_THAN_OR_EQUAL_TO``,
+                  ``GREATER_THAN_OR_EQUAL_TO``) and ``threshold``.
+                | **duration** ({}): ``eventTypeRuleDuration`` with ``eventId``, or
+                  ``dateRangeTypeRuleDuration`` with ``startDate``.
+                | **recurrence** ({}): ``type`` (``DAILY`` or ``WEEKLY``),
+                  ``daysOfWeek`` and ``intraDaySchedule``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: creates budget rules on the account.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'budgetRulesDetails': budgetRulesDetails}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON,
+                                                     'Content-Type': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/budgetRules', method='PUT')
+    def update_budget_rules(self, budgetRulesDetails, **kwargs) -> ApiResponse:
+        """
+        Updates budget rules.
+
+        Request Body [Required]
+            | **budgetRulesDetails** (array): Each entry needs ``ruleId`` and may
+              carry ``ruleState`` (``ACTIVE`` or ``PAUSED``) and ``ruleDetails``
+              with the same shape used on creation.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: updates live budget rules.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'budgetRulesDetails': budgetRulesDetails}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON,
+                                                     'Content-Type': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/campaigns/{}/budgetRules', method='POST')
+    def associate_budget_rules(self, campaignId, budgetRuleIds, **kwargs) -> ApiResponse:
+        """
+        Associates budget rules with a campaign.
+
+        Keyword Args
+            | path **campaignId** (number): [required]
+
+        Request Body [Required]
+            | **budgetRuleIds** (array of string): [required]
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: changes which rules apply to a live campaign.
+        """
+        return self._request(fill_query_params(kwargs.pop('path'), campaignId),
+                             data=Utils.convert_body({'budgetRuleIds': budgetRuleIds}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON,
+                                                     'Content-Type': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/campaigns/{}/budgetRules/{}', method='DELETE')
+    def disassociate_budget_rule(self, campaignId, budgetRuleId, **kwargs) -> ApiResponse:
+        """
+        Disassociates one budget rule from a campaign.
+
+        Keyword Args
+            | path **campaignId** (number): [required]
+            | path **budgetRuleId** (string): [required]
+
+        Returns:
+            | ApiResponse, status ``200``.
+
+        .. note::
+            Not probed: changes which rules apply to a live campaign.
+        """
+        path = fill_query_params(kwargs.pop('path'), campaignId)
+        return self._request(fill_query_params(path, budgetRuleId),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON})
+
+    @sp_endpoint('/sb/campaigns/budget/usage', method='POST')
+    def get_budget_usage(self, campaignIds, **kwargs) -> ApiResponse:
+        """
+        Gets budget usage for campaigns.
+
+        Request Body [Required]
+            | **campaignIds** (array of string): [required]
+
+        Returns:
+            | ApiResponse, with per-campaign entries under ``success`` and failures
+              under ``error``. Each success entry carries ``budget``,
+              ``budgetUsagePercent``, ``campaignId``, ``index`` and
+              ``usageUpdatedTimestamp``.
+
+        Example::
+
+            {"success": [{"budget": 10.0, "budgetUsagePercent": 0.0,
+                          "campaignId": "95988386496299", "index": 0,
+                          "usageUpdatedTimestamp": "2026-10-25T00:00:00Z"}],
+             "error": []}
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'campaignIds': campaignIds}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_USAGE,
+                                                     'Content-Type': self._MEDIA_USAGE})
+
+    @sp_endpoint('/sb/campaigns/budgetRecommendations', method='POST')
+    def get_budget_recommendations(self, campaignIds, **kwargs) -> ApiResponse:
+        """
+        Gets budget recommendations for campaigns.
+
+        Request Body [Required]
+            | **campaignIds** (array of string): [required]
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. warning::
+            This route only answers with its versioned media type. With
+            ``application/json`` the service answers ``404 Could not find
+            resource``, which reads like a missing route but is only the wrong
+            media type.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'campaignIds': campaignIds}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RECS,
+                                                     'Content-Type': self._MEDIA_RECS})
+
+    @sp_endpoint('/sb/campaigns/budgetRules/recommendations', method='POST')
+    def get_budget_rules_recommendation(self, **kwargs) -> ApiResponse:
+        """
+        Gets budget rule recommendations.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            Declared in the 3.0 contract, not in 4.0. Not probed.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(kwargs.pop('body', {}), False),
+                             params=kwargs, headers={'Accept': self._MEDIA_JSON,
+                                                     'Content-Type': self._MEDIA_JSON})

python_amazon_ad_api-1.1.4/ad_api/api/sb/optimization_rules.py

@@ -0,0 +1,153 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class OptimizationRules(Client):
+    """Sponsored Brands optimization rules.
+
+    Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/4-0/openapi
+
+    Every route in this family takes a versioned media type on the way in, and the
+    service routes on it:
+
+    .. warning::
+        With ``application/json`` the router answers ``404 Could not find
+        resource`` on every route here, which reads like a missing route but is
+        only the wrong media type. Verified on ``list`` and ``recommendations``.
+
+    The two read routes were probed against a live account; the four write routes
+    are built from the contract and not exercised.
+    """
+
+    _MEDIA_RULES = 'application/vnd.sbruleoptimization.v4+json'
+    _MEDIA_RECS = 'application/vnd.sboptimizationrecommendationresource.v4+json'
+
+    @sp_endpoint('/sb/rules/optimization/list', method='POST')
+    def list_optimization_rules(self, **kwargs) -> ApiResponse:
+        """
+        Lists optimization rules.
+
+        Request Body [Optional]
+            | **entityFilter** ({}): ``entityType`` and ``entityId``.
+            | **optimizationRuleIdFilter** ({}): ``include``, a list of rule ids.
+            | **maxResults** (number): Page size.
+            | **nextToken** (string): Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with ``optimizationRules`` and ``totalCount``.
+
+        Example::
+
+            {"optimizationRules": [], "totalCount": 0}
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(kwargs.pop('body', {}), False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/recommendations/optimization', method='POST')
+    def get_optimization_recommendation(self, costControlMetric, landingPages, **kwargs) -> ApiResponse:
+        """
+        Gets an optimization rule recommendation.
+
+        Request Body [Required]
+            | **costControlMetric** ({}): [required] Cost control metric.
+            | **landingPages** (array): [required] Each entry carries ``pageType``
+              and either ``asins`` or ``url``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            An empty body answers ``400`` with both members named:
+            *"Value null at 'costControlMetric' failed to satisfy constraint"*.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'costControlMetric': costControlMetric,
+                                                      'landingPages': landingPages}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RECS,
+                                                     'Content-Type': self._MEDIA_RECS})
+
+    @sp_endpoint('/sb/rules/optimization', method='POST')
+    def create_optimization_rules(self, optimizationRules, **kwargs) -> ApiResponse:
+        """
+        Creates optimization rules.
+
+        Request Body [Required]
+            | **optimizationRules** (array): [required]
+                | **entityType** (string): Type of the entity the rule applies to.
+                | **entityId** (string): Identifier of that entity.
+                | **conditions** (array): Each entry needs ``attributeName`` and
+                  ``criteria`` with ``comparisonOperator`` and ``value``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: creates optimization rules on the account.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'optimizationRules': optimizationRules}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization', method='PUT')
+    def update_optimization_rules(self, optimizationRules, **kwargs) -> ApiResponse:
+        """
+        Updates optimization rules.
+
+        Request Body [Required]
+            | **optimizationRules** (array): [required] Each entry needs
+              ``optimizationRuleId`` and ``conditions``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: updates live optimization rules.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'optimizationRules': optimizationRules}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization/associate', method='POST')
+    def associate_optimization_rules(self, optimizationRuleAssociations, **kwargs) -> ApiResponse:
+        """
+        Associates optimization rules with entities.
+
+        Request Body [Required]
+            | **optimizationRuleAssociations** (array): [required] Each entry needs
+              ``entityId``, ``entityType`` and ``optimizationRuleId``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: changes which rules apply to live campaigns.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(
+                                 {'optimizationRuleAssociations': optimizationRuleAssociations}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization/disassociate', method='POST')
+    def disassociate_optimization_rules(self, optimizationRuleDisassociations, **kwargs) -> ApiResponse:
+        """
+        Disassociates optimization rules from entities.
+
+        Request Body [Required]
+            | **optimizationRuleDisassociations** (array): [required] Each entry
+              needs ``entityId``, ``entityType`` and ``optimizationRuleId``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: changes which rules apply to live campaigns.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(
+                                 {'optimizationRuleDisassociations': optimizationRuleDisassociations}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})

python_amazon_ad_api-1.1.4/ad_api/version.py

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

{python_amazon_ad_api-1.1.2 → python_amazon_ad_api-1.1.4}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.2
+Version: 1.1.4
 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.2 → python_amazon_ad_api-1.1.4}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ ad_api/api/sb/ads_v4.py
 ad_api/api/sb/benchmarks.py
 ad_api/api/sb/bid_recommendations.py
 ad_api/api/sb/brands.py
+ad_api/api/sb/budget_rules.py
 ad_api/api/sb/campaigns.py
 ad_api/api/sb/campaigns_v4.py
 ad_api/api/sb/forecast.py
@@ -46,6 +47,7 @@ ad_api/api/sb/landing_page_asins.py
 ad_api/api/sb/media.py
 ad_api/api/sb/negative_keywords.py
 ad_api/api/sb/negative_product_targeting.py
+ad_api/api/sb/optimization_rules.py
 ad_api/api/sb/product_targeting.py
 ad_api/api/sb/recommendations.py
 ad_api/api/sb/reports.py

{python_amazon_ad_api-1.1.2 → python_amazon_ad_api-1.1.4}/setup.cfg

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

{python_amazon_ad_api-1.1.2 → python_amazon_ad_api-1.1.4}/setup.py

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

python_amazon_ad_api-1.1.2/ad_api/version.py

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