release version 2.1.1

Author: dfs-lvics

docs/AboutThisResultElement.md

@@ -7,7 +7,7 @@
 **type** | **string** | type of element |[optional]|
 **url** | **string** | result’s URL |[optional]|
 **source** | **string** | source of additional information about the result |[optional]|
-**source_info** | **string** | additional information about the result<br>description of the website from Wikipedia or another additional context |[optional]|
+**source_info** | **string** | additional information about the result. description of the website from Wikipedia or another additional context |[optional]|
 **source_url** | **string** | URL to full information from the 'source' |[optional]|
 **language** | **string** | the language of the result |[optional]|
 **location** | **string** | location for which the result is relevant |[optional]|

docs/AbsoluteItems.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-**geo_id** | **string** | location identifier<br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations<br>example:<br>US-NY |[optional]|
-**geo_name** | **string** | location name<br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations<br>example:<br>Andorra |[optional]|
+**geo_id** | **string** | location identifier. you can use this field for matching obtained results with location parameters specified in the request. see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations. example:. US-NY |[optional]|
+**geo_name** | **string** | location name. you can use this field for matching obtained results with location parameters specified in the request. see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations. example:. Andorra |[optional]|
 **values** | **string[]** | contains data on relative keyword popularity by country or region |[optional]|

docs/AdsSearch.md

@@ -5,15 +5,15 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**rank_group** | **number** | group rank in SERP<br>position within a group of elements with identical type values<br>positions of elements with different type values are omitted from rank_group |[optional]|
-**rank_absolute** | **number** | absolute rank in SERP<br>absolute position among all the elements in SERP |[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<br>equals true if advertiser account is verified by Google Ads |[optional]|
-**format** | **string** | format of the advertisement<br>possible values: text, image, video |[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<br>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<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” |[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<br>can be used to obtain data on advertising campaigns from the Google Ads Search endpoint |[optional]|
-**location** | **string** | location of the advertiser account<br>country code associated with the advertiser account |[optional]|
-**verified** | **boolean** | verified advertiser account<br>equals true if advertiser account is verified by Google Ads |[optional]|
-**approx_ads_count** | **number** | ads count<br>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 |[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/AggregatedMetricsInfoTotalInfo.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-**mentions** | **number** | total LLM mentions count<br>the number of times the target keyword or domain were mentioned in relation to this specific grouping key |[optional]|
-**ai_search_volume** | **number** | aggregated AI search volume for mentions within this grouping<br>learn more about this metric here |[optional]|
+**mentions** | **number** | *total LLM mentions count*. the number of times the target keyword or domain were mentioned in relation to this specific grouping key |[optional]|
+**ai_search_volume** | **number** | *aggregated AI search volume for mentions within this grouping*. learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions) |[optional]|

docs/AggregatedMetricsItemInfo.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-**key** | **string** | grouping identifier<br>the specific identifier for the grouping dimension |[optional]|
-**mentions** | **number** | total LLM mentions count<br>the number of times the target keyword or domain were mentioned in relation to this specific grouping key |[optional]|
-**ai_search_volume** | **number** | aggregated AI search volume for mentions within this grouping<br>learn more about this metric here |[optional]|
+**key** | **string** | *grouping identifier*. the specific identifier for the grouping dimension |[optional]|
+**mentions** | **number** | *total LLM mentions count*. the number of times the target keyword or domain were mentioned in relation to this specific grouping key |[optional]|
+**ai_search_volume** | **number** | *aggregated AI search volume for mentions within this grouping*. learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions) |[optional]|

docs/AiModeAiOverviewExpandedComponentInfo.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**title** | **string** | reference page title |[optional]|
-**text** | **string** | additional text of the element in SERP |[optional]|
-**markdown** | **string** | content of the element in markdown format |[optional]|
-**images** | **AiModeImagesElementInfo[]** | images of the componentif there are none, equals null |[optional]|
-**links** | **AiModeLinkElementInfo[]** | sitelinksthe links shown below some of Google's search resultsif there are none, equals null |[optional]|
-**references** | **AiModeAiOverviewReferenceInfo[]** | references relevant to the elementincludes references to webpages that were used to generate the ai_overview_element |[optional]|
+**title** | **string** | *reference page title* |[optional]|
+**text** | **string** | *additional text of the element in SERP* |[optional]|
+**markdown** | **string** | *content of the element in markdown format* |[optional]|
+**images** | **AiModeImagesElementInfo[]** | *images of the component*. if there are none, equals `null` |[optional]|
+**links** | **AiModeLinkElementInfo[]** | *sitelinks*. the links shown below some of Google's search results. if there are none, equals `null` |[optional]|
+**references** | **AiModeAiOverviewReferenceInfo[]** | *references relevant to the element*. includes references to webpages that were used to generate the `ai_overview_element` |[optional]|

docs/AiModeAiOverviewInfo.md

@@ -5,12 +5,12 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**rank_group** | **number** | group rank in SERPposition within a group of elements with identical type valuespositions of elements with different type values are omitted from rank_group |[optional]|
-**rank_absolute** | **number** | absolute rank in SERPabsolute position among all the elements in SERP |[optional]|
-**page** | **number** | SERP pageSERP page on which the element ranks |[optional]|
-**position** | **string** | the alignment of the element in SERPcan take the following values:left, right |[optional]|
-**xpath** | **string** | the XPath of the element |[optional]|
-**markdown** | **string** | content of the element in markdown formatthe text of the ai_overview formatted in the markdown markup language |[optional]|
-**items** | **BaseSerpApiAiModeAiOverviewElementItem[]** | elements of search results found in SERP |[optional]|
-**references** | **AiModeAiOverviewReferenceInfo[]** | additional references relevant to the itemincludes references to webpages that may have been used to generate the ai_overview |[optional]|
-**rectangle** | **AiModeRectangleInfo** | rectangle parameterscontains cartesian coordinates and pixel dimensions of the result's snippet in SERPequals null if calculate_rectangles in the POST request is not set to true |[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]|
+**page** | **number** | *SERP page*. SERP page on which the element ranks |[optional]|
+**position** | **string** | *the alignment of the element in SERP*. can take the following values:. `left`, `right` |[optional]|
+**xpath** | **string** | *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* |[optional]|
+**markdown** | **string** | *content of the element in markdown format*. the text of the `ai_overview` formatted in the [markdown markup language](https://en.wikipedia.org/wiki/Markdown) |[optional]|
+**items** | **BaseSerpApiAiModeAiOverviewElementItem[]** | *items present in the element* |[optional]|
+**references** | **AiModeAiOverviewReferenceInfo[]** | *additional references relevant to the item*. includes references to webpages that may have been used to generate the `ai_overview` |[optional]|
+**rectangle** | **AiModeRectangleInfo** | *rectangle parameters*. contains cartesian coordinates and pixel dimensions of the result's snippet in SERP. equals `null` if `calculate_rectangles` in the POST request is not set to `true` |[optional]|

docs/AiModeAiOverviewPaidElementInfo.md

@@ -0,0 +1,15 @@
+# AiModeAiOverviewPaidElementInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+**type** | **string** | type of element |[optional]|
+**title** | **string** | *title of the element in SERP* |[optional]|
+**url** | **string** | *reference page URL* |[optional]|
+**domain** | **string** | *domain name of the reference* |[optional]|
+**ad_aclk** | **string** | *unique ad click referral parameter*. using this parameter you can get a URL of the advertisement in [Google Shopping Sellers Ad URL](https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/) |[optional]|
+**website_name** | **string** | *displayed name of the advertiser's website* |[optional]|
+**breadcrumb** | **string** | *breadcrumb path displayed in the ad* |[optional]|
+**snippet** | **string** | *description text of the ad* |[optional]|
+**images** | **AiModeImagesElementInfo[]** | *images present in the ad*. if there are none, equals `null` |[optional]|

docs/AiModeAiOverviewReferenceInfo.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 **type** | **string** | type of element |[optional]|
-**position** | **string** | the alignment of the element in SERP<br>can take the following values:<br>left, right |[optional]|
+**position** | **string** | the alignment of the element in SERP. can take the following values:. left, right |[optional]|
 **source** | **string** | reference source name or title |[optional]|
 **domain** | **string** | domain name of the reference |[optional]|
 **url** | **string** | link URL |[optional]|