python-amazon-ad-api 1.0.4__tar.gz → 1.0.6__tar.gz

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.0.4
+Version: 1.0.6
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -309,22 +309,16 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Targets](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/targets.html#ad_api.api.v1.Targets.Targets.query_targets)
 
 
-### [Modules Available Sponsored Products 2.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v2.html)
+### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)
 
-Warning: [PLANNED DEPRECATION 6/30/2023]
-There is a new version 3 of Sponsored Product API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/sponsored-products/v3-migration-guide).
-
-
-### [Modules Available Sponsored Products 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v3.html)
-
-Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method instead.
+Warning: the campaign, ad group and product ad operations are deprecated in favour of the v1 endpoints. In product targeting only the four CRUD operations are deprecated; its helper endpoints remain supported. Keywords, negative keywords and negative product targeting have no v1 equivalent yet and stay supported.
 
 
 * [ThemeBased Bid Recommendation](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/bid_recommendations_v3.html)
 * [Keyword Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/ranked_keywords_recommendations.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/keywords_v3.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/negative_keywords_v3.html)
-* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting.html)
+* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting_v3.html)
 * [Campaign Optimization](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/campaign_optimization_rules.html)
 * [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/budget_rules.html)
 * [Product Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_ads_v3.html)
@@ -383,10 +377,6 @@ Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method ins
 * [Forecasts](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/forecast.html)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/recommendations.html)
 
-### [Modules Available DSP](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp.html)
-
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp/reports.html)
-
 ### Amazon Ads API v1 - basic example
 
 ```python

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/README.md

@@ -281,22 +281,16 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Targets](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/targets.html#ad_api.api.v1.Targets.Targets.query_targets)
 
 
-### [Modules Available Sponsored Products 2.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v2.html)
+### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)
 
-Warning: [PLANNED DEPRECATION 6/30/2023]
-There is a new version 3 of Sponsored Product API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/sponsored-products/v3-migration-guide).
-
-
-### [Modules Available Sponsored Products 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v3.html)
-
-Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method instead.
+Warning: the campaign, ad group and product ad operations are deprecated in favour of the v1 endpoints. In product targeting only the four CRUD operations are deprecated; its helper endpoints remain supported. Keywords, negative keywords and negative product targeting have no v1 equivalent yet and stay supported.
 
 
 * [ThemeBased Bid Recommendation](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/bid_recommendations_v3.html)
 * [Keyword Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/ranked_keywords_recommendations.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/keywords_v3.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/negative_keywords_v3.html)
-* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting.html)
+* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting_v3.html)
 * [Campaign Optimization](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/campaign_optimization_rules.html)
 * [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/budget_rules.html)
 * [Product Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_ads_v3.html)
@@ -355,10 +349,6 @@ Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method ins
 * [Forecasts](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/forecast.html)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/recommendations.html)
 
-### [Modules Available DSP](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp.html)
-
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp/reports.html)
-
 ### Amazon Ads API v1 - basic example
 
 ```python

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/ad_api/api/sp/__init__.py

@@ -1,25 +1,13 @@
-from .campaigns import Campaigns
 from .campaigns_v3 import CampaignsV3
-from .ad_groups import AdGroups
 from .ad_groups_v3 import AdGroupsV3
 from .keywords_v3 import KeywordsV3
 from .negative_keywords_v3 import NegativeKeywordsV3
 from .negative_product_targeting_v3 import NegativeTargetsV3
-from .product_ads import ProductAds
 from .product_ads_v3 import ProductAdsV3
-from .bid_recommendations import BidRecommendations
 from .bid_recommendations_v3 import BidRecommendationsV3
-from .keywords import Keywords
-from .negative_keywords import NegativeKeywords
-from .campaign_negative_keywords import CampaignNegativeKeywords
 from .campaign_negative_keywords_v3 import CampaignNegativeKeywordsV3
-from .campaign_negative_targets import CampaignNegativeTargets
 from .product_targeting_v3 import TargetsV3
-from .suggested_keywords import SuggestedKeywords
-from .product_targeting import Targets
-from .negative_product_targeting import NegativeTargets
-from .reports import Reports
-from .snapshots import Snapshots
+from .campaign_negative_targets import CampaignNegativeTargets
 from .budget_rules import BudgetRules
 from .budget_initial_recommendation import InitialBudgetRecommendation
 from .campaings_optimization import CampaignOptimization
@@ -32,27 +20,16 @@ from .campaigns_budget_usage import CampaignsBudgetUsage
 from .schedule_based_bid_optimization import ScheduleBasedBidOptimizationRules
 
 __all__ = [
-    "Campaigns",
     "CampaignsV3",
-    "AdGroups",
     "AdGroupsV3",
-    "ProductAds",
-    "ProductAdsV3",
-    "BidRecommendations",
-    "Keywords",
     "KeywordsV3",
-    "NegativeKeywords",
     "NegativeKeywordsV3",
-    "CampaignNegativeKeywords",
+    "NegativeTargetsV3",
+    "ProductAdsV3",
+    "BidRecommendationsV3",
     "CampaignNegativeKeywordsV3",
-    "CampaignNegativeTargets",
-    "SuggestedKeywords",
-    "Targets",
     "TargetsV3",
-    "NegativeTargets",
-    "NegativeTargetsV3",
-    "Reports",
-    "Snapshots",
+    "CampaignNegativeTargets",
     "BudgetRules",
     "InitialBudgetRecommendation",
     "CampaignOptimization",
@@ -63,5 +40,4 @@ __all__ = [
     "ProductRecommendations",
     "CampaignsBudgetUsage",
     "ScheduleBasedBidOptimizationRules",
-    "BidRecommendationsV3",
 ]

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/ad_api/api/sp/campaign_negative_targets.py

@@ -87,7 +87,7 @@ class CampaignNegativeTargets(Client):
         Returns
             ApiResponse
         """
-        json_version = 'application/vnd.spNegativeTargetingClause.v' + str(version) + "+json"
+        json_version = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + "+json"
         headers = {"Accept": json_version, "Content-Type": json_version}
 
         prefer_value = 'return=representation'

python_amazon_ad_api-1.0.6/ad_api/version.py

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

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.0.4
+Version: 1.0.6
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -309,22 +309,16 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Targets](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/targets.html#ad_api.api.v1.Targets.Targets.query_targets)
 
 
-### [Modules Available Sponsored Products 2.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v2.html)
+### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)
 
-Warning: [PLANNED DEPRECATION 6/30/2023]
-There is a new version 3 of Sponsored Product API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/sponsored-products/v3-migration-guide).
-
-
-### [Modules Available Sponsored Products 3.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sp_v3.html)
-
-Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method instead.
+Warning: the campaign, ad group and product ad operations are deprecated in favour of the v1 endpoints. In product targeting only the four CRUD operations are deprecated; its helper endpoints remain supported. Keywords, negative keywords and negative product targeting have no v1 equivalent yet and stay supported.
 
 
 * [ThemeBased Bid Recommendation](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/bid_recommendations_v3.html)
 * [Keyword Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/ranked_keywords_recommendations.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/keywords_v3.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/negative_keywords_v3.html)
-* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting.html)
+* [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_targeting_v3.html)
 * [Campaign Optimization](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/campaign_optimization_rules.html)
 * [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/budget_rules.html)
 * [Product Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sp/product_ads_v3.html)
@@ -383,10 +377,6 @@ Warning: `list_campaigns` is deprecated. Use the v1 `query_campaigns` method ins
 * [Forecasts](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/forecast.html)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sd/recommendations.html)
 
-### [Modules Available DSP](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp.html)
-
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/dsp/reports.html)
-
 ### Amazon Ads API v1 - basic example
 
 ```python

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -29,11 +29,6 @@ ad_api/api/reports.py
 ad_api/api/stores.py
 ad_api/api/stream.py
 ad_api/api/validation_configurations.py
-ad_api/api/dsp/__init__.py
-ad_api/api/dsp/access_token_client.py
-ad_api/api/dsp/client.py
-ad_api/api/dsp/credential_provider.py
-ad_api/api/dsp/reports.py
 ad_api/api/sb/__init__.py
 ad_api/api/sb/ad_creatives_v4.py
 ad_api/api/sb/ad_groups.py
@@ -76,38 +71,26 @@ ad_api/api/sd/reports.py
 ad_api/api/sd/snapshots.py
 ad_api/api/sd/targeting_recommendations.py
 ad_api/api/sp/__init__.py
-ad_api/api/sp/ad_groups.py
 ad_api/api/sp/ad_groups_v3.py
-ad_api/api/sp/bid_recommendations.py
 ad_api/api/sp/bid_recommendations_v3.py
 ad_api/api/sp/budget_initial_recommendation.py
 ad_api/api/sp/budget_recommendations.py
 ad_api/api/sp/budget_rules.py
 ad_api/api/sp/budget_rules_recommendations.py
 ad_api/api/sp/campaign_consolidated_recommendations.py
-ad_api/api/sp/campaign_negative_keywords.py
 ad_api/api/sp/campaign_negative_keywords_v3.py
 ad_api/api/sp/campaign_negative_targets.py
-ad_api/api/sp/campaigns.py
 ad_api/api/sp/campaigns_budget_usage.py
 ad_api/api/sp/campaigns_v3.py
 ad_api/api/sp/campaings_optimization.py
-ad_api/api/sp/keywords.py
 ad_api/api/sp/keywords_v3.py
-ad_api/api/sp/negative_keywords.py
 ad_api/api/sp/negative_keywords_v3.py
-ad_api/api/sp/negative_product_targeting.py
 ad_api/api/sp/negative_product_targeting_v3.py
-ad_api/api/sp/product_ads.py
 ad_api/api/sp/product_ads_v3.py
 ad_api/api/sp/product_recommendations.py
-ad_api/api/sp/product_targeting.py
 ad_api/api/sp/product_targeting_v3.py
 ad_api/api/sp/ranked_keywords_recommendations.py
-ad_api/api/sp/reports.py
 ad_api/api/sp/schedule_based_bid_optimization.py
-ad_api/api/sp/snapshots.py
-ad_api/api/sp/suggested_keywords.py
 ad_api/api/v1/__init__.py
 ad_api/api/v1/ad_groups.py
 ad_api/api/v1/ads.py

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/setup.cfg

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

{python_amazon_ad_api-1.0.4 → python_amazon_ad_api-1.0.6}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='1.0.4',
+    version='1.0.6',
     install_requires=[
         "requests>=2.27.1,<2.35.0",
         "six>=1.16,<1.18",
@@ -19,7 +19,6 @@ setup(
         'ad_api.api.sp',
         'ad_api.api.sb',
         'ad_api.api.sd',
-        'ad_api.api.dsp',
         'ad_api.api.v1',
     ],
     url='https://github.com/denisneuf/python-amazon-ad-api',

python_amazon_ad_api-1.0.4/ad_api/api/dsp/__init__.py

@@ -1,11 +0,0 @@
-from .reports import Reports
-from .client import DspClient
-from .access_token_client import DspAccessTokenClient
-from .credential_provider import DspCredentialProvider
-
-__all__ = [
-    "Reports",
-    "DspClient",
-    "DspAccessTokenClient",
-    "DspCredentialProvider",
-]

python_amazon_ad_api-1.0.4/ad_api/api/dsp/access_token_client.py

@@ -1,6 +0,0 @@
-from ad_api.api.dsp.credential_provider import DspCredentialProvider
-from ad_api.auth.access_token_client import AccessTokenClient
-
-
-class DspAccessTokenClient(AccessTokenClient):
-    credential_provider_class = DspCredentialProvider

python_amazon_ad_api-1.0.4/ad_api/api/dsp/client.py

@@ -1,13 +0,0 @@
-from typing import Dict
-from ad_api.base import Client
-
-
-class DspClient(Client):
-    @property
-    def headers(self) -> Dict[str, str]:
-        return {
-            'User-Agent': self.user_agent,
-            'Amazon-Advertising-API-ClientId': self.credentials['client_id'],
-            'Authorization': f'Bearer {self.auth.access_token}',
-            'Content-Type': 'application/json',
-        }

python_amazon_ad_api-1.0.4/ad_api/api/dsp/credential_provider.py

@@ -1,15 +0,0 @@
-from ad_api.base.config import BaseConfig
-from ad_api.base.credential_provider import CredentialProvider
-
-
-class DspCredentialProvider(CredentialProvider):
-    config_class = BaseConfig
-
-    def from_env(self):
-        account_data = dict(
-            refresh_token=self._get_env('AD_API_REFRESH_TOKEN'),
-            client_id=self._get_env('AD_API_CLIENT_ID'),
-            client_secret=self._get_env('AD_API_CLIENT_SECRET'),
-        )
-        self.credentials = self.config_class(**account_data)
-        return len(self.credentials.check_config()) == 0

python_amazon_ad_api-1.0.4/ad_api/api/dsp/reports.py

@@ -1,71 +0,0 @@
-from ad_api.api.dsp.client import DspClient as Client
-from ad_api.base import sp_endpoint, fill_query_params, ApiResponse, Utils
-
-
-class Reports(Client):
-    """Amazon DSP Reports
-
-    Documentation: https://advertising.amazon.com/API/docs/en-us/dsp-reports-beta-3p/#/Reports
-
-    Amazon DSP is a demand-side platform (DSP) that enables advertisers to programmatically buy display, video, and audio ads both on and off Amazon. Using Amazon's DSP, you can reach audiences across the web on both Amazon sites and apps as well as through our publishing partners and third-party exchanges. Amazon DSP is available to both advertisers who sell products on Amazon and those who do not.
-    """
-
-    @sp_endpoint('/accounts/{}/dsp/reports', method='POST')
-    def post_report(self, dspAccountId, accept='application/vnd.dspcreatereports.v3+json', **kwargs) -> ApiResponse:
-        r"""
-        Request reports with performance metrics for DSP campaigns.
-
-        Request creation of a report that includes metrics about your Amazon DSP campaigns. Specify the type of report and the metrics you'd like to include. Note that the value specified for the dimensions field affects the metrics included in the report. See the dimensions field description for more information.
-
-        Keyword Args
-            | path **dspAccountId** (string): Account Identifier you use to access the DSP. This is your DSP Entity ID if you have access to all DSP advertisers within that entity, or your DSP Advertiser ID if you only have access to a specific advertiser ID. [required]
-
-        Request body
-            | **advertiserIds** (list > string): [optional] List of advertisers specified by identifier to include in the report. This should not be present if accountId is advertiser.
-            | **endDate** (string): [required] Date in yyyy-MM-dd format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The endDate can be up to 90 days older from today.
-            | **format** (string): [optional] Enum: The report file format. [JSON]
-            | **orderIds** (list > string): [optional] List of orders specified by identifier to include in the report.
-            | **metrics** (list > string): [optional] Specify a list of metrics field names to include in the report. For example: ["impressions", "clickThroughs", "CTR", "eCPC", "totalCost", "eCPM"]. If no metric field names are specified, only the default fields and selected DIMENSION fields are included by default. Specifying default fields returns an error.
-            | **type** (string): [optional] Enum: The report type. [CAMPAIGN]
-            | **startDate** (string): [required] Date in yyyy-MM-dd format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The startDate can be up to 90 days older from today.
-            | **dimensions** (list > string): [optional] List of dimensions to include in the report. Specify one or many comma-delimited strings of dimensions. For example: ["ORDER", "LINE_ITEM", "CREATIVE"]. Adding a dimension in this array determines the aggregation level of the report data and also adds the fields for that dimension in the report. If the list is null or empty, the aggregation of the report data is at ORDER level. The allowed values can be used together in this array as an allowed value in which case the report aggregation will be at the lowest aggregation level and the report will contain the fields for all the dimensions included in the report.
-            | **timeUnit** (string): [optional] Enum: Adding timeUnit determines the aggregation level (SUMMARY or DAILY) of the report data. If the timeUnit is null or empty, the aggregation of the report data is at the SUMMARY level and aggregated at the time period specified. DAILY timeUnit is not supported for AUDIENCE report type. The report will contain the fields based on timeUnit. [SUMMARY]
-
-        Returns:
-            ApiResponse
-        """
-        path = fill_query_params(kwargs.pop('path'), dspAccountId)
-        return self._request(path, data=Utils.convert_body(kwargs.pop('body'), False), headers={'Accept': accept}, params=kwargs)
-
-    @sp_endpoint('/accounts/{}/dsp/reports/{}', method='GET')
-    def get_report(self, dspAccountId, reportId, accept='application/vnd.dspgetreports.v3+json', **kwargs) -> ApiResponse:
-        r"""
-        Gets a previously requested report specified by identifier.
-
-        Keyword Args
-            | path **dspAccountId** (string): Account Identifier for DSP. Please input DSP entity ID if you want to retrieve reports for a group of advertisers, or input DSP advertiser ID if you want to retrieve reports for a single advertiser. [required]
-            | path **reportId** (string): The identifier of the requested report. [required]
-
-        Returns:
-            ApiResponse
-        """
-        path = fill_query_params(kwargs.pop('path'), dspAccountId, reportId)
-        return self._request(path, headers={'Accept': accept}, params=kwargs)
-
-    def download_report(self, **kwargs) -> ApiResponse:
-        r"""
-        Downloads the report previously get report specified by location (this is not part of the official Amazon Advertising API, is a helper method to download the report). Take in mind that a direct download of location returned in get_report will return 401 - Unauthorized.
-
-        kwarg parameter **file** if not provided will take the default amazon name from path download (add a path with slash / if you want a specific folder, do not add extension as the return will provide the right extension based on format choosed if needed)
-
-        kwarg parameter **format** if not provided a format will return a url to download the report (this url has a expiration time)
-
-        Keyword Args
-            | **url** (string): The location obatined from get_report [required]
-            | **file** (string): The path to save the file if mode is download json, zip or gzip. [optional]
-            | **format** (string): The mode to download the report: data (list), raw, url, json, zip, gzip. Default (url) [optional]
-
-        Returns:
-            ApiResponse
-        """
-        return self._download(self, params=kwargs, headers={'User-Agent': self.user_agent})

python_amazon_ad_api-1.0.4/ad_api/api/sp/ad_groups.py

@@ -1,158 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
-
-
-class AdGroups(Client):
-    @sp_endpoint('/v2/sp/adGroups', method='POST')
-    @Utils.deprecated
-    def create_ad_groups(self, **kwargs) -> ApiResponse:
-        r"""
-        create_ad_groups(self, \*\*kwargs) -> ApiResponse
-
-        Creates one or more ad groups.
-
-        body: | REQUIRED {'description': 'An array of ad groups.}'
-
-            | '**name**': *string*, {'description': 'A name for the ad group'}
-            | '**campaignId**': *number*, {'description': 'An existing campaign to which the ad group is associated'}
-            | '**defaultBid**': *number($float)*, {'description': 'A bid value for use when no bid is specified for keywords in the ad group', 'minimum': '0.02'}
-            | '**state**': *string*, {'description': 'A name for the ad group', 'Enum': '[ enabled, paused, archived ]'}
-
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups', method='PUT')
-    @Utils.deprecated
-    def edit_ad_groups(self, **kwargs) -> ApiResponse:
-        r"""
-        edit_ad_group(self, \*\*kwargs) -> ApiResponse
-
-        Updates one or more ad groups.
-
-        body: | REQUIRED {'description': 'An array of ad groups.}'
-
-            | '**adGroupId**': *number*, {'description': 'The identifier of the ad group.'}
-            | '**name**': *string*, {'description': 'The name of the ad group.'}
-            | '**defaultBid**': *number($float)*, {'description': 'The bid value used when no bid is specified for keywords in the ad group.', 'minimum': '0.02'}
-            | '**state**': *string*, {'description': 'The current resource state', 'Enum': '[ enabled, paused, archived ]'}
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups', method='GET')
-    @Utils.deprecated
-    def list_ad_groups(self, **kwargs) -> ApiResponse:
-        r"""
-        list_ad_groups(self, \*\*kwargs) -> ApiResponse
-
-        Gets an array of AdGroup objects for a requested set of Sponsored Display ad groups. Note that the AdGroup object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the ad group operations that return the AdGroupResponseEx object.
-
-            query **startIndex**:*integer* | Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.
-
-            query **count**:*integer* | Optional. Sets the number of AdGroup objects in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first ten ad groups set startIndex=0 and count=10. To return the next ten ad groups, set startIndex=10 and count=10, and so on. Defaults to max page size.
-
-            query **stateFilter**:*string* | Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived Default value : enabled, paused, archived
-
-            query **campaignIdFilter**:*string* | Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the specified comma-delimited list.
-
-            query **adGroupIdFilter**:*string* | Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.
-
-            query **name**:*string* | Optional. The returned array includes only ad groups with the specified name.
-
-
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(kwargs.pop('path'), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups/{}', method='GET')
-    @Utils.deprecated
-    def get_ad_group(self, adGroupId, **kwargs) -> ApiResponse:
-        r"""
-
-        get_ad_group(self, adGroupId, \*\*kwargs) -> ApiResponse
-
-        Gets an ad group specified by identifier.
-
-            path **adGroupId**:*number* | Required. The identifier of an existing ad group.
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), adGroupId), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups/{}', method='DELETE')
-    @Utils.deprecated
-    def delete_ad_group(self, adGroupId, **kwargs) -> ApiResponse:
-        r"""
-
-        delete_ad_group(self, adGroupId, \*\*kwargs) -> ApiResponse
-
-        Sets the ad group status to archived. Archived entities cannot be made active again. See developer notes for more information.
-
-            path **adGroupId**:*number* | Required. The identifier of an existing ad group.
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), adGroupId), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups/extended', method='GET')
-    @Utils.deprecated
-    def list_ad_groups_extended(self, **kwargs) -> ApiResponse:
-        r"""
-        list_ad_groups_extended(self, \*\*kwargs) -> ApiResponse
-
-        Gets an array of AdGroup objects for a requested set of Sponsored Display ad groups. Note that the AdGroup object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the ad group operations that return the AdGroupResponseEx object.
-
-            query: **startIndex**:*integer* | Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.
-
-            query **count**:*integer* | Optional. Sets the number of AdGroup objects in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first ten ad groups set startIndex=0 and count=10. To return the next ten ad groups, set startIndex=10 and count=10, and so on. Defaults to max page size.
-
-            query **stateFilter**:*string* | Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived Default value : enabled, paused, archived
-
-            query **campaignIdFilter**:*string* | Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the specified comma-delimited list.
-
-            query **adGroupIdFilter**:*string* | Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.
-
-            query **name**:*string* | Optional. The returned array includes only ad groups with the specified name.
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(kwargs.pop('path'), params=kwargs)
-
-    @sp_endpoint('/v2/sp/adGroups/extended/{}', method='GET')
-    @Utils.deprecated
-    def get_ad_group_extended(self, adGroupId, **kwargs) -> ApiResponse:
-        r"""
-
-        get_ad_group_extended(self, adGroupId, \*\*kwargs) -> ApiResponse
-
-        Gets an ad group that has extended data fields.
-
-            path **adGroupId**:*number* | Required. The identifier of an existing ad group.
-
-        Returns:
-
-            ApiResponse
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), adGroupId), params=kwargs)