dataforseo-client 2.1.9 → 2.1.11

package/dist/cjs/models/SearchResults.js

@@ -16,13 +16,10 @@ class SearchResults {
                 if (data.hasOwnProperty(property))
                     this[property] = data[property];
             }
-            this.description = data["description"];
-            this.breadcrumb = data["breadcrumb"];
-            this.rank = data["rank"];
             this.title = data["title"];
-            this.domain = data["domain"];
             this.url = data["url"];
-            this.publication_date = data["publication_date"];
+            this.date = data["date"];
+            this.snippet = data["snippet"];
         }
     }
     static fromJS(data) {
@@ -33,13 +30,10 @@ class SearchResults {
     }
     toJSON(data) {
         data = typeof data === 'object' ? data : {};
-        data["description"] = this.description;
-        data["breadcrumb"] = this.breadcrumb;
-        data["rank"] = this.rank;
         data["title"] = this.title;
-        data["domain"] = this.domain;
         data["url"] = this.url;
-        data["publication_date"] = this.publication_date;
+        data["date"] = this.date;
+        data["snippet"] = this.snippet;
         return data;
     }
 }

package/dist/cjs/models/SearchResults.js.map

@@ -1 +1 @@
-{"version":3,"file":"SearchResults.js","sourceRoot":"","sources":["../../../src/models/SearchResults.ts"],"names":[],"mappings":";;;AA2BA,MAAa,aAAa;IAwCtB,YAAY,IAAqB;QAEjC,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA1FD,sCA0FC"}
+{"version":3,"file":"SearchResults.js","sourceRoot":"","sources":["../../../src/models/SearchResults.ts"],"names":[],"mappings":";;;AAkBA,MAAa,aAAa;IAyBtB,YAAY,IAAqB;QAEjC,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AArED,sCAqEC"}

package/dist/cjs/models/SerpGoogleAiModeLiveAdvancedRequestInfo.d.ts

@@ -9,7 +9,7 @@ export interface ISerpGoogleAiModeLiveAdvancedRequestInfo {
     device?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` **Note:** check [Google Search Help](https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#) for the list of countries where AI Mode is currently available */
     location_name?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
     /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;
@@ -38,7 +38,7 @@ export declare class SerpGoogleAiModeLiveAdvancedRequestInfo implements ISerpGoo
     device?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` **Note:** check [Google Search Help](https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#) for the list of countries where AI Mode is currently available */
     location_name?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
     /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;

package/dist/cjs/models/SerpGoogleAiModeLiveHtmlRequestInfo.d.ts

@@ -1,15 +1,15 @@
 export interface ISerpGoogleAiModeLiveHtmlRequestInfo {
     /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the '%' character for your `keyword`, please specify it as '%25'; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; */
     keyword?: string | undefined;
-    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `London,England,United Kingdom` */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** *search engine location code* **required field if you don't specify** `location_name`_or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `2840`n */
+    /** *search engine location code* **required field if you don't specify** `location_name`_or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `2840` */
     location_code?: number | undefined;
     /** *GPS coordinates of a location* **required field if you don't specify** `location_name`_or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude,radius'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 the minimum value for *'radius'*: 199.9 (mm) the maximum value for *'radius'*: 199999 (mm) example: `53.476225,-2.243572,200`n */
     location_coordinate?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
-    /** *search engine language code* required field if you don't specify `language_name`; if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code`_by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`n */
+    /** *search engine language code* required field if you don't specify `language_name`; if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code`_by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_code?: string | undefined;
     /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
@@ -22,15 +22,15 @@ export interface ISerpGoogleAiModeLiveHtmlRequestInfo {
 export declare class SerpGoogleAiModeLiveHtmlRequestInfo implements ISerpGoogleAiModeLiveHtmlRequestInfo {
     /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the '%' character for your `keyword`, please specify it as '%25'; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; */
     keyword?: string | undefined;
-    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `London,England,United Kingdom` */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** *search engine location code* **required field if you don't specify** `location_name`_or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `2840`n */
+    /** *search engine location code* **required field if you don't specify** `location_name`_or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `2840` */
     location_code?: number | undefined;
     /** *GPS coordinates of a location* **required field if you don't specify** `location_name`_or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude,radius'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 the minimum value for *'radius'*: 199.9 (mm) the maximum value for *'radius'*: 199999 (mm) example: `53.476225,-2.243572,200`n */
     location_coordinate?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
-    /** *search engine language code* required field if you don't specify `language_name`; if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code`_by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`n */
+    /** *search engine language code* required field if you don't specify `language_name`; if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code`_by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_code?: string | undefined;
     /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;

package/dist/cjs/models/SerpGoogleAiModeTaskPostRequestInfo.d.ts

@@ -17,7 +17,7 @@ export interface ISerpGoogleAiModeTaskPostRequestInfo {
     postback_data?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` **Note:** check [Google Search Help](https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#) for the list of countries where AI Mode is currently available */
     location_name?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
     /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;
@@ -54,7 +54,7 @@ export declare class SerpGoogleAiModeTaskPostRequestInfo implements ISerpGoogleA
     postback_data?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` **Note:** check [Google Search Help](https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#) for the list of countries where AI Mode is currently available */
     location_name?: string | undefined;
-    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages`; */
+    /** *full name of search engine language* required field if you don't specify `language_code`; if you use this field, you don't need to specify `language_code`; you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/ai_mode/languages` */
     language_name?: string | undefined;
     /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;

package/dist/cjs/models/SerpGoogleMapsLiveAdvancedRequestInfo.d.ts

@@ -7,7 +7,7 @@ export interface ISerpGoogleMapsLiveAdvancedRequestInfo {
     language_code?: string | undefined;
     /** *parsing depth* optional field number of results in SERP default value: `100` max value: `700` **Your account will be billed per each SERP containing up to 100 results;** Setting depth above 100 may result in additional charges [if the search engine returns more than 100 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-maps-serp-api) page. */
     depth?: number | undefined;
-    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` **note:** for `mobile` device, only 20 results are returned for every SERP */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
@@ -40,7 +40,7 @@ export declare class SerpGoogleMapsLiveAdvancedRequestInfo implements ISerpGoogl
     language_code?: string | undefined;
     /** *parsing depth* optional field number of results in SERP default value: `100` max value: `700` **Your account will be billed per each SERP containing up to 100 results;** Setting depth above 100 may result in additional charges [if the search engine returns more than 100 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-maps-serp-api) page. */
     depth?: number | undefined;
-    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` **note:** for `mobile` device, only 20 results are returned for every SERP */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
     /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;

package/dist/cjs/models/SerpGoogleMapsTaskPostRequestInfo.d.ts

@@ -9,7 +9,7 @@ export interface ISerpGoogleMapsTaskPostRequestInfo {
     depth?: number | undefined;
     /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-maps-serp-api) page. */
     priority?: number | undefined;
-    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` **note:** for `mobile` device, only 20 results are returned for every SERP */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
     /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;
@@ -50,7 +50,7 @@ export declare class SerpGoogleMapsTaskPostRequestInfo implements ISerpGoogleMap
     depth?: number | undefined;
     /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-maps-serp-api) page. */
     priority?: number | undefined;
-    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` **note:** for `mobile` device, only 20 results are returned for every SERP */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
     /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;

package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedRequestInfo.d.ts

@@ -1,123 +1,123 @@
 import { SerpApiStopCrawlOnMatchInfo } from "./SerpApiStopCrawlOnMatchInfo";
 export interface ISerpGoogleOrganicLiveAdvancedRequestInfo {
-    /** keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; if this field contains such parameters as *‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’*, **the charge per task will be multiplied by 5** learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:2840 */
+    /** *search engine location code* **required field if you don't specify** `location_name` or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `2840` */
     location_code?: number | undefined;
-    /** search engine language codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:en */
+    /** *search engine language code* optional field if you specify `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/languages`**example:**`en` */
     language_code?: string | undefined;
-    /** parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page. */
+    /** *parsing depth* optional field number of results in SERP **default value: `10`** max value: `200` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges [if the search engine returns more than 10 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-organic-serp-api) page. */
     depth?: number | undefined;
-    /** device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
-    /** load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains 'asynchronous_ai_overview': false, all extra charges will be returned to your account balance */
+    /** *load asynchronous ai overview* optional field set to `true` to obtain `ai_overview` items is SERPs even if they are loaded asynchronously; if set to `false`, you will only obtain `ai_overview` items from cache; default value: `false` **Note:** you will be charged extra $0.002 for using this parameter; if the element is absent or contains `'asynchronous_ai_overview': false`, all extra charges will be returned to your account balance */
     load_async_ai_overview?: boolean | undefined;
-    /** full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:London,England,United Kingdom */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:English */
+    /** *full name of search engine language* optional field if you specify `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/languages` example: `English` */
     language_name?: string | undefined;
-    /** device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android */
+    /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     /** array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: 'stop_crawl_on_match':[{'match_value':'dataforseo.com','match_type':'with_subdomains'}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets */
     stop_crawl_on_match?: SerpApiStopCrawlOnMatchInfo[] | undefined;
-    /** target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard –  wildcard pattern */
+    /** *target match type* **required field if `stop_crawl_on_match` is specified** type of match for the `match_value` possible values: `domain` – specific domain or subdomain `with_subdomains` – main domain and subdomains `wildcard` –  wildcard pattern */
     match_type?: string | undefined;
-    /** target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: 'match_value': 'dataforseo.com','match_value': '/blog/post-*' */
+    /** *target domain, subdomain, or wildcard value* **required field if `stop_crawl_on_match` is specified** specify a target domain, subdomain, or wildcard value; **Note:** domain or subdomain must be specified without a request protocol; example: `'match_value': 'dataforseo.com'`, `'match_value': '/blog/post-*'` */
     match_value?: string | undefined;
-    /** page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center */
+    /** *page crawl limit* optional field number of search results pages to crawl max value: `100` **Note:** you will be charged for each page crawled (10 organic results per page); learn more about pricing on our [Pricing](https://dataforseo.com/pricing/serp/google-organic-serp-api) page; **Note#2:** the `max_crawl_pages` and `depth` parameters complement each other; learn more at [our help center](https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work) */
     max_crawl_pages?: number | undefined;
-    /** additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype. */
+    /** *additional parameters of the search query* optional field [get the list of available parameters and additional details here](https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them) **Note:** the following search engine parameters are not supported and will be automatically unset if specified: `lr`, `cr`, `as_qdr`, `as_sitesearch`, `as_occt`, `as_filetype`. */
     search_param?: string | undefined;
-    /** remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:'remove_from_url': ['srsltid']Note: if the target field is specified, the specified URL parameters will be removed before the search */
+    /** *remove specific parameters from URLs* optional field using this field, you can specify up to 10 parameters to remove from URLs in the result example: `'remove_from_url': ['srsltid']` **Note:** if the `target` field is specified, the specified URL parameters will be removed before the search */
     remove_from_url?: string[] | undefined;
-    /** clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4 */
+    /** *clicks on the corresponding element* optional field specify the click depth on the `people_also_ask` element to get additional `people_also_ask_element` items; **Note** your account will be billed $0.00015 extra for each click; if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance possible values: from `1` to `4` */
     people_also_ask_click_depth?: number | undefined;
-    /** display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true */
+    /** *display related results* optional field if set to `true`, the `related_result` element in the response will be provided as a snippet of its parent organic result; if set to `false`, the `related_result` element will be provided as a separate organic result; default value: `true` */
     group_organic_results?: boolean | undefined;
-    /** calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter */
+    /** *calcualte pixel rankings for SERP elements in advanced results* optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; [Visit Help Center to learn more>>](https://dataforseo.com/help-center/pixel-ranking-in-serp-api) by default, the parameter is set to `false`; **Note:** you will be charged extra $0.002 for using this parameter */
     calculate_rectangles?: boolean | undefined;
-    /** browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen width* optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1920` for `desktop`; `360` for `mobile` on `android`; `375` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_width?: number | undefined;
-    /** browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen height* optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1080` for `desktop`; `640` for `mobile` on `android`; `812` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_height?: number | undefined;
-    /** browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen resolution ratio* optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: `0.5-3`; by default, the parameter is set to: `1` for `desktop`; `3` for `mobile` on `android`; `3` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_resolution_ratio?: number | undefined;
-    /** direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype. */
+    /** *direct URL of the search query* optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: `https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS` **Note:** the following search engine parameters are not supported and will be automatically unset if specified in the URL: `lr`, `cr`, `as_qdr`, `as_sitesearch`, `as_occt`, `as_filetype`. */
     url?: string | undefined;
-    /** GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the 'latitude,longitude,radius' formatthe maximum number of decimal digits for 'latitude' and 'longitude': 7the minimum value for 'radius': 199 (mm)the maximum value for 'radius': 199999 (mm)example:53.476225,-2.243572,200 */
+    /** *GPS coordinates of a location* optional field if you specify `location_name` or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude,radius'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 the minimum value for *'radius'*: 199 (mm) the maximum value for *'radius'*: 199999 (mm) example: `53.476225,-2.243572,200` */
     location_coordinate?: string | undefined;
-    /** search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc. */
+    /** *search engine domain* optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: *google.co.uk*, ``*google.com.au*, ``*google.de*, etc. */
     se_domain?: string | undefined;
-    /** target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string */
+    /** *target domain, subdomain, or webpage to get results for* optional field a domain or a subdomain should be specified without `https://` and `www.` note that the results of `target`-specific tasks will only include SERP elements that contain a `url` string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: **`example.com`** - returns results for the website's home page with URLs, such as `https://example.com`, or `https://www.example.com/`, or `https://example.com/`; **`example.com*`** - returns results for the domain, including all its pages; **`*example.com*`** - returns results for the entire domain, including all its pages and subdomains; **`*example.com`** - returns results for the home page regardless of the subdomain, such as `https://en.example.com`; **`example.com/example-page`** - returns results for the exact URL; **`example.com/example-page*`** - returns results for all domain's URLs that start with the specified string */
     target?: string | undefined;
-    /** target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center */
+    /** *target matching mode* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled defines how the crawl should stop when multiple targets are specified in `stop_crawl_on_match` possible values: `all`, `any` `all` – the crawl stops only when all specified targets are found `any` – the crawl stops when any single target is found default value: `any` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     target_search_mode?: string | undefined;
-    /** SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:'find_targets_in': ['organic', 'featured_snippet']learn more about this parameter on our Help Center */
+    /** *SERP element types to check for targets* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled specifies which SERP element types should be checked for target matches if not specified, all first-level elements with `url` and `domain` fields are checked for targets possible values: `organic`, `paid`, `local_pack`, `featured_snippet`, `events`, `google_flights`, `images`, `jobs`, `knowledge_graph`, `local_service`, `map`, `scholarly_articles`, `third_party_reviews`, `twitter` **Note:** cannot contain the same element types as `ignore_targets_in` example: `'find_targets_in': ['organic', 'featured_snippet']` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     find_targets_in?: string[] | undefined;
-    /** SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:'ignore_targets_in': ['paid', 'images']learn more about this parameter on our Help Center */
+    /** *SERP element types to exclude from target search* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled specifies which SERP element types should be excluded when searching for target matches possible values: `organic`, `paid`, `local_pack`, `featured_snippet`, `events`, `google_flights`, `images`, `jobs`, `knowledge_graph`, `local_service`, `map`, `scholarly_articles`, `third_party_reviews`, `twitter` **Note:** cannot contain the same element types as `find_targets_in` example: `'ignore_targets_in': ['paid', 'images']` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     ignore_targets_in?: string[] | undefined;
     [key: string]: any;
 }
 export declare class SerpGoogleOrganicLiveAdvancedRequestInfo implements ISerpGoogleOrganicLiveAdvancedRequestInfo {
-    /** keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; if this field contains such parameters as *‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’*, **the charge per task will be multiplied by 5** learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:2840 */
+    /** *search engine location code* **required field if you don't specify** `location_name` or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `2840` */
     location_code?: number | undefined;
-    /** search engine language codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:en */
+    /** *search engine language code* optional field if you specify `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/languages`**example:**`en` */
     language_code?: string | undefined;
-    /** parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page. */
+    /** *parsing depth* optional field number of results in SERP **default value: `10`** max value: `200` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges [if the search engine returns more than 10 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/google-organic-serp-api) page. */
     depth?: number | undefined;
-    /** device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
-    /** load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains 'asynchronous_ai_overview': false, all extra charges will be returned to your account balance */
+    /** *load asynchronous ai overview* optional field set to `true` to obtain `ai_overview` items is SERPs even if they are loaded asynchronously; if set to `false`, you will only obtain `ai_overview` items from cache; default value: `false` **Note:** you will be charged extra $0.002 for using this parameter; if the element is absent or contains `'asynchronous_ai_overview': false`, all extra charges will be returned to your account balance */
     load_async_ai_overview?: boolean | undefined;
-    /** full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:London,England,United Kingdom */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:English */
+    /** *full name of search engine language* optional field if you specify `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/google/languages` example: `English` */
     language_name?: string | undefined;
-    /** device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android */
+    /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: string | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     /** array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: 'stop_crawl_on_match':[{'match_value':'dataforseo.com','match_type':'with_subdomains'}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets */
     stop_crawl_on_match?: SerpApiStopCrawlOnMatchInfo[] | undefined;
-    /** target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard –  wildcard pattern */
+    /** *target match type* **required field if `stop_crawl_on_match` is specified** type of match for the `match_value` possible values: `domain` – specific domain or subdomain `with_subdomains` – main domain and subdomains `wildcard` –  wildcard pattern */
     match_type?: string | undefined;
-    /** target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: 'match_value': 'dataforseo.com','match_value': '/blog/post-*' */
+    /** *target domain, subdomain, or wildcard value* **required field if `stop_crawl_on_match` is specified** specify a target domain, subdomain, or wildcard value; **Note:** domain or subdomain must be specified without a request protocol; example: `'match_value': 'dataforseo.com'`, `'match_value': '/blog/post-*'` */
     match_value?: string | undefined;
-    /** page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center */
+    /** *page crawl limit* optional field number of search results pages to crawl max value: `100` **Note:** you will be charged for each page crawled (10 organic results per page); learn more about pricing on our [Pricing](https://dataforseo.com/pricing/serp/google-organic-serp-api) page; **Note#2:** the `max_crawl_pages` and `depth` parameters complement each other; learn more at [our help center](https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work) */
     max_crawl_pages?: number | undefined;
-    /** additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype. */
+    /** *additional parameters of the search query* optional field [get the list of available parameters and additional details here](https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them) **Note:** the following search engine parameters are not supported and will be automatically unset if specified: `lr`, `cr`, `as_qdr`, `as_sitesearch`, `as_occt`, `as_filetype`. */
     search_param?: string | undefined;
-    /** remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:'remove_from_url': ['srsltid']Note: if the target field is specified, the specified URL parameters will be removed before the search */
+    /** *remove specific parameters from URLs* optional field using this field, you can specify up to 10 parameters to remove from URLs in the result example: `'remove_from_url': ['srsltid']` **Note:** if the `target` field is specified, the specified URL parameters will be removed before the search */
     remove_from_url?: string[] | undefined;
-    /** clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4 */
+    /** *clicks on the corresponding element* optional field specify the click depth on the `people_also_ask` element to get additional `people_also_ask_element` items; **Note** your account will be billed $0.00015 extra for each click; if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance possible values: from `1` to `4` */
     people_also_ask_click_depth?: number | undefined;
-    /** display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true */
+    /** *display related results* optional field if set to `true`, the `related_result` element in the response will be provided as a snippet of its parent organic result; if set to `false`, the `related_result` element will be provided as a separate organic result; default value: `true` */
     group_organic_results?: boolean | undefined;
-    /** calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter */
+    /** *calcualte pixel rankings for SERP elements in advanced results* optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; [Visit Help Center to learn more>>](https://dataforseo.com/help-center/pixel-ranking-in-serp-api) by default, the parameter is set to `false`; **Note:** you will be charged extra $0.002 for using this parameter */
     calculate_rectangles?: boolean | undefined;
-    /** browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen width* optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1920` for `desktop`; `360` for `mobile` on `android`; `375` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_width?: number | undefined;
-    /** browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen height* optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1080` for `desktop`; `640` for `mobile` on `android`; `812` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_height?: number | undefined;
-    /** browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen resolution ratio* optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: `0.5-3`; by default, the parameter is set to: `1` for `desktop`; `3` for `mobile` on `android`; `3` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_resolution_ratio?: number | undefined;
-    /** direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype. */
+    /** *direct URL of the search query* optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: `https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS` **Note:** the following search engine parameters are not supported and will be automatically unset if specified in the URL: `lr`, `cr`, `as_qdr`, `as_sitesearch`, `as_occt`, `as_filetype`. */
     url?: string | undefined;
-    /** GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the 'latitude,longitude,radius' formatthe maximum number of decimal digits for 'latitude' and 'longitude': 7the minimum value for 'radius': 199 (mm)the maximum value for 'radius': 199999 (mm)example:53.476225,-2.243572,200 */
+    /** *GPS coordinates of a location* optional field if you specify `location_name` or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude,radius'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 the minimum value for *'radius'*: 199 (mm) the maximum value for *'radius'*: 199999 (mm) example: `53.476225,-2.243572,200` */
     location_coordinate?: string | undefined;
-    /** search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc. */
+    /** *search engine domain* optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: *google.co.uk*, ``*google.com.au*, ``*google.de*, etc. */
     se_domain?: string | undefined;
-    /** target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string */
+    /** *target domain, subdomain, or webpage to get results for* optional field a domain or a subdomain should be specified without `https://` and `www.` note that the results of `target`-specific tasks will only include SERP elements that contain a `url` string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: **`example.com`** - returns results for the website's home page with URLs, such as `https://example.com`, or `https://www.example.com/`, or `https://example.com/`; **`example.com*`** - returns results for the domain, including all its pages; **`*example.com*`** - returns results for the entire domain, including all its pages and subdomains; **`*example.com`** - returns results for the home page regardless of the subdomain, such as `https://en.example.com`; **`example.com/example-page`** - returns results for the exact URL; **`example.com/example-page*`** - returns results for all domain's URLs that start with the specified string */
     target?: string | undefined;
-    /** target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center */
+    /** *target matching mode* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled defines how the crawl should stop when multiple targets are specified in `stop_crawl_on_match` possible values: `all`, `any` `all` – the crawl stops only when all specified targets are found `any` – the crawl stops when any single target is found default value: `any` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     target_search_mode?: string | undefined;
-    /** SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:'find_targets_in': ['organic', 'featured_snippet']learn more about this parameter on our Help Center */
+    /** *SERP element types to check for targets* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled specifies which SERP element types should be checked for target matches if not specified, all first-level elements with `url` and `domain` fields are checked for targets possible values: `organic`, `paid`, `local_pack`, `featured_snippet`, `events`, `google_flights`, `images`, `jobs`, `knowledge_graph`, `local_service`, `map`, `scholarly_articles`, `third_party_reviews`, `twitter` **Note:** cannot contain the same element types as `ignore_targets_in` example: `'find_targets_in': ['organic', 'featured_snippet']` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     find_targets_in?: string[] | undefined;
-    /** SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:'ignore_targets_in': ['paid', 'images']learn more about this parameter on our Help Center */
+    /** *SERP element types to exclude from target search* optional field to enable this parameter, `stop_crawl_on_match` must also be enabled specifies which SERP element types should be excluded when searching for target matches possible values: `organic`, `paid`, `local_pack`, `featured_snippet`, `events`, `google_flights`, `images`, `jobs`, `knowledge_graph`, `local_service`, `map`, `scholarly_articles`, `third_party_reviews`, `twitter` **Note:** cannot contain the same element types as `find_targets_in` example: `'ignore_targets_in': ['paid', 'images']` learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api) */
     ignore_targets_in?: string[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpGoogleOrganicLiveAdvancedRequestInfo);

package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { SerpGoogleOrganicLiveAdvancedTaskInfo } from "./SerpGoogleOrganicLiveAdvancedTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface ISerpGoogleOrganicLiveAdvancedResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: SerpGoogleOrganicLiveAdvancedTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class SerpGoogleOrganicLiveAdvancedResponseInfo extends BaseResponseInfo implements ISerpGoogleOrganicLiveAdvancedResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: SerpGoogleOrganicLiveAdvancedTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpGoogleOrganicLiveAdvancedResponseInfo);