release version 2.1.2

Author: dfs-lvics

docs/AdsSearch.md

@@ -5,15 +5,15 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**rank_group** | **number** | 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 |[optional]|
-**rank_absolute** | **number** | absolute rank in SERP. absolute position among all the elements in SERP |[optional]|
-**advertiser_id** | **string** | unique identifier of the advertiser account |[optional]|
-**creative_id** | **string** | unique identifier of the advertisement |[optional]|
-**title** | **string** | title of the element |[optional]|
-**url** | **string** | search URL with refinement parameters |[optional]|
-**verified** | **boolean** | verified advertiser account. equals true if advertiser account is verified by Google Ads |[optional]|
-**format** | **string** | format of the advertisement. possible values: text, image, video |[optional]|
-**preview_image** | **PreviewImage** | preview image of the advertisement |[optional]|
-**preview_url** | **string** | url pointing to the ad preview |[optional]|
-**first_shown** | **string** | date and time when the ad was shown for the first time. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” |[optional]|
-**last_shown** | **string** | date and time when the ad was shown the last time. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” |[optional]|
+**rank_group** | **number** | *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` |[optional]|
+**rank_absolute** | **number** | *absolute rank in SERP*. absolute position among all the elements in SERP |[optional]|
+**advertiser_id** | **string** | *unique identifier of the advertiser account* |[optional]|
+**creative_id** | **string** | *unique identifier of the advertisement* |[optional]|
+**title** | **string** | *title of the element* |[optional]|
+**url** | **string** | *search URL with refinement parameters* |[optional]|
+**verified** | **boolean** | *verified advertiser account*. equals `true` if advertiser account is verified by Google Ads |[optional]|
+**format** | **string** | *format of the advertisement*. possible values: `text`, `image`, `video` |[optional]|
+**preview_image** | **PreviewImage** | *preview image of the advertisement* |[optional]|
+**preview_url** | **string** | *url pointing to the ad preview* |[optional]|
+**first_shown** | **string** | *date and time when the ad was shown for the first time*. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” |[optional]|
+**last_shown** | **string** | *date and time when the ad was shown the last time*. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” |[optional]|

docs/Advertiser.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**advertiser_id** | **string** | unique identifier of the advertiser account. can be used to obtain data on advertising campaigns from the Google Ads Search endpoint |[optional]|
-**location** | **string** | location of the advertiser account. country code associated with the advertiser account |[optional]|
-**verified** | **boolean** | verified advertiser account. equals true if advertiser account is verified by Google Ads |[optional]|
-**approx_ads_count** | **number** | ads count. the approximate number of ads that are run by the advertiser account across all available Google Ads platforms |[optional]|
+**advertiser_id** | **string** | *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/) |[optional]|
+**location** | **string** | *location of the advertiser account*. country code associated with the advertiser account |[optional]|
+**verified** | **boolean** | *verified advertiser account*. equals `true` if advertiser account is verified by Google Ads |[optional]|
+**approx_ads_count** | **number** | *ads count*. the approximate number of ads that are run by the advertiser account across all available Google Ads platforms |[optional]|

docs/AiModeAiOverviewShoppingElementInfo.md

@@ -12,7 +12,7 @@
 **url** | **string** | *URL in link* |[optional]|
 **domain** | **string** | *domain in link* |[optional]|
 **rating** | **RatingInfo** | *product rating*. the popularity rate based on reviews.  if there is none, the value will be `null` |[optional]|
-**price** | **PriceInfo** | *product price*. product price details on the seller's website;.  if there is none, the value will be `null` |[optional]|
+**price** | **AiModePriceInfo** | *product price*. product price details on the seller's website;.  if there is none, the value will be `null` |[optional]|
 **seller** | **string** | *product seller*. name of the product's seller as displayed in search results |[optional]|
 **snippet** | **string** | *additional information about the result* |[optional]|
 **marketplace** | **string** | *merchant account provider*. e-commerce site that hosts products or websites of individual sellers under the same merchant account. example:. `by Google` |[optional]|

docs/AiModePriceInfo.md

@@ -0,0 +1,12 @@
+# AiModePriceInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+**current** | **number** | *current price*. indicates the current price of the shopping element |[optional]|
+**regular** | **number** | *regular price*. indicates the regular price of the shopping element |[optional]|
+**max_value** | **number** | *the maximum price*. indicates the maximum price of the shopping element |[optional]|
+**currency** | **string** | *currency of the listed price*. ISO code of the currency applied to the price |[optional]|
+**is_price_range** | **boolean** | *price is provided as a range*. indicates whether a price is provided in a range |[optional]|
+**displayed_price** | **string** | *price string in the result*. raw price string as provided in the result |[optional]|

docs/AmazonApplicableVouchersItem.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**text** | **string** | text of the voucher |[optional]|
-**fixed_discount** | **number** | value of the fixed discount |[optional]|
-**fixed_discount_currency** | **string** | currency code of the fixed discount |[optional]|
-**percentage_discount** | **number** | value of the percentage discount. if the discount is fixed, the value will be null |[optional]|
-**important_details** | **string** | important details about the terms of discount vouchers |[optional]|
+**text** | **string** | *text of the voucher* |[optional]|
+**fixed_discount** | **number** | *value of the fixed discount* |[optional]|
+**fixed_discount_currency** | **string** | *currency code of the fixed discount* |[optional]|
+**percentage_discount** | **number** | *value of the percentage discount*. if the discount is fixed, the value will be `null` |[optional]|
+**important_details** | **string** | *important details about the terms of discount vouchers* |[optional]|

docs/AmazonMetricsBundleInfo.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-**amazon_serp** | **AppMetricsInfo** | ranking data from Amazon organic SERP |[optional]|
-**amazon_paid** | **AppMetricsInfo** | ranking data from Amazon paid SERP |[optional]|
+**amazon_serp** | **AppMetricsInfo** | *ranking data from Amazon organic SERP* |[optional]|
+**amazon_paid** | **AppMetricsInfo** | *ranking data from Amazon paid SERP* |[optional]|

docs/AmazonProductInfo.md

@@ -5,32 +5,32 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**rank_group** | **number** | position within a group of elements with identical type values. positions of elements with different type values are omitted from rank_group |[optional]|
-**rank_absolute** | **number** | absolute rank. absolute position among all the elements in the response array |[optional]|
-**position** | **string** | the alignment of the element in Amazon SERP. possible values:. left, right |[optional]|
-**xpath** | **string** | the XPath of the element |[optional]|
-**title** | **string** | product title |[optional]|
-**details** | **string** | product specs and other details |[optional]|
-**image_url** | **string** | the URL of the product image |[optional]|
-**author** | **string** | product brand name |[optional]|
-**data_asin** | **string** | ASIN of the product received in a POST array |[optional]|
-**parent_asin** | **string** | parent ASIN of the product |[optional]|
-**product_asins** | **string[]** | ASINs of all found product modifications |[optional]|
-**price_from** | **number** | the lower limit of the product price range. example:. 49.98 |[optional]|
-**price_to** | **number** | the upper limit of the product price range. example:. 384.99 |[optional]|
-**percentage_discount** | **string** | value of the percentage discount |[optional]|
-**currency** | **string** | currency in the ISO format. example:. USD |[optional]|
-**is_amazon_choice** | **boolean** | “Amazon’s choice” label. if the value is true, the product is marked with the “Amazon’s choice” label |[optional]|
-**rating** | **RatingElement** | product rating info |[optional]|
-**is_newer_model_available** | **boolean** | indicates whether the newer model of the product is available |[optional]|
-**is_prime_video** | **boolean** | indicates whether a product has an Amazon Prime Video label. if true, specified product is a part of Amazon Prime Video service |[optional]|
-**applicable_vouchers** | **AmazonApplicableVouchersItem[]** | array of objects containing information about applicable vouchers |[optional]|
-**newer_model** | **NewerModel** | information about the newer model of the product |[optional]|
-**categories** | **Categories[]** | contains related product categories |[optional]|
-**product_information** | **BaseMerchantAmazonProductInformationElementItem[]** | contains related product information |[optional]|
-**product_images_list** | **string[]** | contains URLs for all images of the product displayed on the left side of the main image |[optional]|
-**product_videos_list** | **string[]** | contains URLs for all videos of the product displayed on the right side of the main video |[optional]|
-**description** | **string** | contains description of the product |[optional]|
-**is_available** | **boolean** | indicates whether the product is available for ordering. if the value is true, the product can be ordered |[optional]|
-**top_local_reviews** | **AmazonReviewItem[]** | array of objects with top reviews from target location |[optional]|
-**top_global_reviews** | **AmazonReviewItem[]** | array of objects with top reviews from around the world |[optional]|
+**rank_group** | **number** | *position within a group of elements with identical `type` values*. positions of elements with different `type` values are omitted from `rank_group` |[optional]|
+**rank_absolute** | **number** | *absolute rank*. absolute position among all the elements in the response array |[optional]|
+**position** | **string** | *the alignment of the element in Amazon SERP*. possible values:. `left`, `right` |[optional]|
+**xpath** | **string** | *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* |[optional]|
+**title** | **string** | *product title* |[optional]|
+**details** | **string** | *product specs and other details* |[optional]|
+**image_url** | **string** | *the URL of the product image* |[optional]|
+**author** | **string** | *product brand name* |[optional]|
+**data_asin** | **string** | *ASIN of the product received in a POST array* |[optional]|
+**parent_asin** | **string** | *[parent ASIN](https://sellercentral.amazon.com/gp/help/external/help.html?itemID=8831&language=en-US&ref=mpbc_200779220_cont_8831&) of the product* |[optional]|
+**product_asins** | **string[]** | *ASINs of all found product modifications* |[optional]|
+**price_from** | **number** | *the lower limit of the product price range*. example:. `49.98` |[optional]|
+**price_to** | **number** | *the upper limit of the product price range*. example:. `384.99` |[optional]|
+**percentage_discount** | **string** | *value of the percentage discount* |[optional]|
+**currency** | **string** | *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format*. example:. `USD` |[optional]|
+**is_amazon_choice** | **boolean** | *'Amazon's choice' label*. if the value is `true`, the product is marked with the 'Amazon's choice' label |[optional]|
+**rating** | **RatingElement** | *product rating info* |[optional]|
+**is_newer_model_available** | **boolean** | *indicates whether the newer model of the product is available* |[optional]|
+**is_prime_video** | **boolean** | *indicates whether a product has an Amazon Prime Video label*. if `true`, specified product is a part of Amazon Prime Video service |[optional]|
+**applicable_vouchers** | **AmazonApplicableVouchersItem[]** | *array of objects containing information about applicable vouchers* |[optional]|
+**newer_model** | **NewerModel** | *information about the newer model of the product* |[optional]|
+**categories** | **Categories[]** | *contains related product categories* |[optional]|
+**product_information** | **BaseMerchantAmazonProductInformationElementItem[]** | *contains related product information* |[optional]|
+**product_images_list** | **string[]** | *contains URLs for all images of the product displayed on the left side of the main image* |[optional]|
+**product_videos_list** | **string[]** | *contains URLs for all videos of the product displayed on the right side of the main video* |[optional]|
+**description** | **string** | *contains description of the product* |[optional]|
+**is_available** | **boolean** | *indicates whether the product is [available for ordering](https://www.amazon.com/gp/help/customer/display.html?nodeId=201910280)*. if the value is `true`, the product can be ordered |[optional]|
+**top_local_reviews** | **AmazonReviewItem[]** | *array of objects with top reviews from target location* |[optional]|
+**top_global_reviews** | **AmazonReviewItem[]** | *array of objects with top reviews from around the world* |[optional]|

docs/AmazonReviewItem.md

@@ -5,18 +5,18 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**rank_group** | **number** | position within a group of elements with identical type values. positions of elements with different type values are omitted from rank_group |[optional]|
-**rank_absolute** | **number** | absolute rank among all the listed reviews. absolute position among all reviews on the list |[optional]|
-**position** | **string** | the alignment of the review in SERP. can take the following values: right |[optional]|
-**xpath** | **string** | the XPath of the element |[optional]|
-**verified** | **boolean** | indicates whether the review has the “Verified Purchase” mark |[optional]|
-**subtitle** | **string** | subtitle of the review |[optional]|
-**helpful_votes** | **string** | helpful votes count. number of users who clicked on the ‘Helpful” button under the review text |[optional]|
-**images** | **AiModeImagesElementInfo[]** | images of the product submitted by the reviewer |[optional]|
-**videos** | **VideoElement[]** | videos of the product submitted by the reviewer |[optional]|
-**user_profile** | **UserProfileInfo** | user profile of the reviewer |[optional]|
-**title** | **string** | title of the review |[optional]|
-**url** | **string** | URL to the reviewer’s profile |[optional]|
-**review_text** | **string** | content of the review |[optional]|
-**publication_date** | **string** | date and time when the review was published. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;. example:. 2019-11-15 12:57:46 +00:00 |[optional]|
-**rating** | **RatingInfo** | the rating score submitted by the reviewer |[optional]|
+**rank_group** | **number** | *position within a group of elements with identical `type` values*. positions of elements with different `type` values are omitted from `rank_group` |[optional]|
+**rank_absolute** | **number** | *absolute rank among all the listed reviews*. absolute position among all reviews on the list |[optional]|
+**position** | **string** | *the alignment of the review in SERP*. can take the following values: `right` |[optional]|
+**xpath** | **string** | *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* |[optional]|
+**verified** | **boolean** | *indicates whether the review has the 'Verified Purchase' mark* |[optional]|
+**subtitle** | **string** | *subtitle of the review* |[optional]|
+**helpful_votes** | **string** | *helpful votes count*. number of users who clicked on the 'Helpful' button under the review text |[optional]|
+**images** | **AiModeImagesElementInfo[]** | *images of the product submitted by the reviewer* |[optional]|
+**videos** | **VideoElement[]** | *videos of the product submitted by the reviewer* |[optional]|
+**user_profile** | **UserProfileInfo** | *user profile of the reviewer* |[optional]|
+**title** | **string** | *title of the review* |[optional]|
+**url** | **string** |  |[optional]|
+**review_text** | **string** | *content of the review* |[optional]|
+**publication_date** | **string** | *date and time when the review was published*. in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;. example:. `2019-11-15 12:57:46 +00:00` |[optional]|
+**rating** | **RatingInfo** | *the rating score submitted by the reviewer* |[optional]|