release version 2.1.2

Author: dfs-lvics

dataforseo_client/api_client.py

@@ -62,7 +62,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'python-client/2.1.1'
+        self.user_agent = 'python-client/2.1.2'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

dataforseo_client/models/ads_search.py

@@ -17,18 +17,18 @@ class AdsSearch(BaseModel):
     AdsSearch
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    rank_group: Optional[StrictInt] = Field(default=None, description=r"group rank in SERP. position within a group of elements with identical type values. positions of elements with different type values are omitted from rank_group")
-    rank_absolute: Optional[StrictInt] = Field(default=None, description=r"absolute rank in SERP. absolute position among all the elements in SERP")
-    advertiser_id: Optional[StrictStr] = Field(default=None, description=r"unique identifier of the advertiser account")
-    creative_id: Optional[StrictStr] = Field(default=None, description=r"unique identifier of the advertisement")
-    title: Optional[StrictStr] = Field(default=None, description=r"title of the element")
-    url: Optional[StrictStr] = Field(default=None, description=r"search URL with refinement parameters")
-    verified: Optional[StrictBool] = Field(default=None, description=r"verified advertiser account. equals true if advertiser account is verified by Google Ads")
-    format: Optional[StrictStr] = Field(default=None, description=r"format of the advertisement. possible values: text, image, video")
-    preview_image: Optional[PreviewImage] = Field(default=None, description=r"preview image of the advertisement")
-    preview_url: Optional[StrictStr] = Field(default=None, description=r"url pointing to the ad preview")
-    first_shown: Optional[StrictStr] = Field(default=None, description=r"date and time when the ad was shown for the first time. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”")
-    last_shown: Optional[StrictStr] = Field(default=None, description=r"date and time when the ad was shown the last time. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”")
+    rank_group: Optional[StrictInt] = Field(default=None, description=r"*group rank in SERP*. position within a group of elements with identical `type` values. positions of elements with different `type` values are omitted from `rank_group`")
+    rank_absolute: Optional[StrictInt] = Field(default=None, description=r"*absolute rank in SERP*. absolute position among all the elements in SERP")
+    advertiser_id: Optional[StrictStr] = Field(default=None, description=r"*unique identifier of the advertiser account*")
+    creative_id: Optional[StrictStr] = Field(default=None, description=r"*unique identifier of the advertisement*")
+    title: Optional[StrictStr] = Field(default=None, description=r"*title of the element*")
+    url: Optional[StrictStr] = Field(default=None, description=r"*search URL with refinement parameters*")
+    verified: Optional[StrictBool] = Field(default=None, description=r"*verified advertiser account*. equals `true` if advertiser account is verified by Google Ads")
+    format: Optional[StrictStr] = Field(default=None, description=r"*format of the advertisement*. possible values: `text`, `image`, `video`")
+    preview_image: Optional[PreviewImage] = Field(default=None, description=r"*preview image of the advertisement*")
+    preview_url: Optional[StrictStr] = Field(default=None, description=r"*url pointing to the ad preview*")
+    first_shown: Optional[StrictStr] = Field(default=None, description=r"*date and time when the ad was shown for the first time*. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”")
+    last_shown: Optional[StrictStr] = Field(default=None, description=r"*date and time when the ad was shown the last time*. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”")
     __properties: ClassVar[List[str]] = [
         "type", 
         "rank_group", 

dataforseo_client/models/advertiser.py

@@ -16,10 +16,10 @@ class Advertiser(BaseModel):
     Advertiser
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    advertiser_id: Optional[StrictStr] = Field(default=None, description=r"unique identifier of the advertiser account. can be used to obtain data on advertising campaigns from the Google Ads Search endpoint")
-    location: Optional[StrictStr] = Field(default=None, description=r"location of the advertiser account. country code associated with the advertiser account")
-    verified: Optional[StrictBool] = Field(default=None, description=r"verified advertiser account. equals true if advertiser account is verified by Google Ads")
-    approx_ads_count: Optional[StrictInt] = Field(default=None, description=r"ads count. the approximate number of ads that are run by the advertiser account across all available Google Ads platforms")
+    advertiser_id: Optional[StrictStr] = Field(default=None, description=r"*unique identifier of the advertiser account*. can be used to obtain data on advertising campaigns from the [Google Ads Search endpoint](/v3/serp/google/ads_search/task_post/)")
+    location: Optional[StrictStr] = Field(default=None, description=r"*location of the advertiser account*. country code associated with the advertiser account")
+    verified: Optional[StrictBool] = Field(default=None, description=r"*verified advertiser account*. equals `true` if advertiser account is verified by Google Ads")
+    approx_ads_count: Optional[StrictInt] = Field(default=None, description=r"*ads count*. the approximate number of ads that are run by the advertiser account across all available Google Ads platforms")
     __properties: ClassVar[List[str]] = [
         "type", 
         "advertiser_id", 

dataforseo_client/models/ai_mode_ai_overview_shopping_element_info.py

@@ -9,7 +9,7 @@
 from typing_extensions import Self
 
 from dataforseo_client.models.rating_info import RatingInfo
-from dataforseo_client.models.price_info import PriceInfo
+from dataforseo_client.models.ai_mode_price_info import AiModePriceInfo
 
 
 
@@ -25,7 +25,7 @@ class AiModeAiOverviewShoppingElementInfo(BaseModel):
     url: Optional[StrictStr] = Field(default=None, description=r"*URL in link*")
     domain: Optional[StrictStr] = Field(default=None, description=r"*domain in link*")
     rating: Optional[RatingInfo] = Field(default=None, description=r"*product rating*. the popularity rate based on reviews.  if there is none, the value will be `null`")
-    price: Optional[PriceInfo] = Field(default=None, description=r"*product price*. product price details on the seller's website;.  if there is none, the value will be `null`")
+    price: Optional[AiModePriceInfo] = Field(default=None, description=r"*product price*. product price details on the seller's website;.  if there is none, the value will be `null`")
     seller: Optional[StrictStr] = Field(default=None, description=r"*product seller*. name of the product's seller as displayed in search results")
     snippet: Optional[StrictStr] = Field(default=None, description=r"*additional information about the result*")
     marketplace: Optional[StrictStr] = Field(default=None, description=r"*merchant account provider*. e-commerce site that hosts products or websites of individual sellers under the same merchant account. example:. `by Google`")
@@ -106,7 +106,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "url": obj.get("url"),
             "domain": obj.get("domain"),
             "rating": RatingInfo.from_dict(obj["rating"]) if obj.get("rating") is not None else None,
-            "price": PriceInfo.from_dict(obj["price"]) if obj.get("price") is not None else None,
+            "price": AiModePriceInfo.from_dict(obj["price"]) if obj.get("price") is not None else None,
             "seller": obj.get("seller"),
             "snippet": obj.get("snippet"),
             "marketplace": obj.get("marketplace"),

dataforseo_client/models/ai_mode_price_info.py

@@ -15,12 +15,12 @@ class AiModePriceInfo(BaseModel):
     """
     AiModePriceInfo
     """ # noqa: E501
-    current: Optional[StrictInt] = Field(default=None, description=r"current priceindicates the current price of the shopping element")
-    regular: Optional[StrictFloat] = Field(default=None, description=r"regular priceindicates the regular price of the shopping element")
-    max_value: Optional[StrictFloat] = Field(default=None, description=r"the maximum priceindicates the maximum price of the shopping element")
-    currency: Optional[StrictStr] = Field(default=None, description=r"currency of the listed priceISO code of the currency applied to the price")
-    is_price_range: Optional[StrictBool] = Field(default=None, description=r"price is provided as a rangeindicates whether a price is provided in a range")
-    displayed_price: Optional[StrictStr] = Field(default=None, description=r"price string in the resultraw price string as provided in the result")
+    current: Optional[StrictInt] = Field(default=None, description=r"*current price*. indicates the current price of the shopping element")
+    regular: Optional[StrictFloat] = Field(default=None, description=r"*regular price*. indicates the regular price of the shopping element")
+    max_value: Optional[StrictFloat] = Field(default=None, description=r"*the maximum price*. indicates the maximum price of the shopping element")
+    currency: Optional[StrictStr] = Field(default=None, description=r"*currency of the listed price*. ISO code of the currency applied to the price")
+    is_price_range: Optional[StrictBool] = Field(default=None, description=r"*price is provided as a range*. indicates whether a price is provided in a range")
+    displayed_price: Optional[StrictStr] = Field(default=None, description=r"*price string in the result*. raw price string as provided in the result")
     __properties: ClassVar[List[str]] = [
         "current", 
         "regular", 

dataforseo_client/models/amazon_applicable_vouchers_item.py

@@ -16,11 +16,11 @@ class AmazonApplicableVouchersItem(BaseModel):
     AmazonApplicableVouchersItem
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    text: Optional[StrictStr] = Field(default=None, description=r"text of the voucher")
-    fixed_discount: Optional[StrictFloat] = Field(default=None, description=r"value of the fixed discount")
-    fixed_discount_currency: Optional[StrictStr] = Field(default=None, description=r"currency code of the fixed discount")
-    percentage_discount: Optional[StrictFloat] = Field(default=None, description=r"value of the percentage discount. if the discount is fixed, the value will be null")
-    important_details: Optional[StrictStr] = Field(default=None, description=r"important details about the terms of discount vouchers")
+    text: Optional[StrictStr] = Field(default=None, description=r"*text of the voucher*")
+    fixed_discount: Optional[StrictFloat] = Field(default=None, description=r"*value of the fixed discount*")
+    fixed_discount_currency: Optional[StrictStr] = Field(default=None, description=r"*currency code of the fixed discount*")
+    percentage_discount: Optional[StrictFloat] = Field(default=None, description=r"*value of the percentage discount*. if the discount is fixed, the value will be `null`")
+    important_details: Optional[StrictStr] = Field(default=None, description=r"*important details about the terms of discount vouchers*")
     __properties: ClassVar[List[str]] = [
         "type", 
         "text", 

dataforseo_client/models/amazon_metrics_bundle_info.py

@@ -16,8 +16,8 @@ class AmazonMetricsBundleInfo(BaseModel):
     """
     AmazonMetricsBundleInfo
     """ # noqa: E501
-    amazon_serp: Optional[AppMetricsInfo] = Field(default=None, description=r"ranking data from Amazon organic SERP")
-    amazon_paid: Optional[AppMetricsInfo] = Field(default=None, description=r"ranking data from Amazon paid SERP")
+    amazon_serp: Optional[AppMetricsInfo] = Field(default=None, description=r"*ranking data from Amazon organic SERP*")
+    amazon_paid: Optional[AppMetricsInfo] = Field(default=None, description=r"*ranking data from Amazon paid SERP*")
     __properties: ClassVar[List[str]] = [
         "amazon_serp", 
         "amazon_paid",