dataforseo-client 2.0.15 → 2.0.16

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

@@ -9,12 +9,20 @@ if you need to use the “+” character for your keyword, please specify it as
 if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** 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.
+    /** 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:
-https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
-    url?: string | undefined;
+2840 */
+    location_code?: number | undefined;
+    /** 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/{{low_se_name}}/languages
+example:
+en */
+    language_code?: string | undefined;
     /** parsing depth
 optional field
 number of results in SERP
@@ -24,65 +32,33 @@ 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;
 The cost can be calculated on the Pricing page. */
     depth?: number | undefined;
-    /** page crawl limit
+    /** device type
 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 page;
-Note#2: the max_crawl_pages and depth parameters complement each other;
-learn more at our help center */
-    max_crawl_pages?: number | undefined;
+can take the values:desktop, mobile
+default value: desktop */
+    device?: string | undefined;
+    /** 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 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
+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 */
     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/google/locations
-example:
-2840 */
-    location_code?: number | undefined;
-    /** 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.9 (mm)
-the maximum value for “radius”: 199999 (mm)
-example:
-53.476225,-2.243572,200 */
-    location_coordinate?: string | undefined;
     /** 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
+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/{{low_se_name}}/languages
 example:
 English */
     language_name?: string | undefined;
-    /** 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;
-    /** 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;
-    /** device type
-optional field
-can take the values:desktop, mobile
-default value: desktop */
-    device?: string | undefined;
     /** device operating system
 optional field
 if you specify desktop in the device field, choose from the following values: windows, macos
@@ -90,19 +66,12 @@ default value: windows
 if you specify mobile in the device field, choose from the following values: android, ios
 default value: android */
     os?: string | undefined;
-    /** target domain, subdomain, or webpage to get results for
+    /** user-defined task identifier
 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;
+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;
@@ -112,48 +81,44 @@ example:
 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 type
+optional field
+type of match for the match_value
+possible values: domain, with_subdomains, wildcard */
+    match_type?: string | undefined;
     /** target domain or wildcard value
-required field if stop_crawl_on_match is specified;
+optional field
 specify a target domain or wildcard value;
 Note: domain name must be specified without a request protocol;
 example: dataforseo.com */
     match_value?: string | undefined;
-    /** target match type
-required field if stop_crawl_on_match is specified;
-type of match for the match_value
-possible values: domain, with_subdomains, wildcard */
-    match_type?: string | undefined;
-    /** target matching mode
+    /** page crawl limit
 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 */
-    target_search_mode?: string | undefined;
-    /** SERP element types to check for targets
+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 page;
+Note#2: the max_crawl_pages and depth parameters complement each other;
+learn more at our help center */
+    max_crawl_pages?: number | undefined;
+    /** additional parameters of the search query
 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 */
-    find_targets_in?: string[] | undefined;
-    /** SERP element types to exclude from target search
+get the list of available parameters and additional details here */
+    search_param?: string | undefined;
+    /** remove specific parameters from URLs
 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
+using this field, you can specify up to 10 parameters to remove from URLs in the result
 example:
-'ignore_targets_in': ['paid', 'images']
-learn more about this parameter on our Help Center */
-    ignore_targets_in?: string[] | undefined;
+'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 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 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;
@@ -195,38 +160,73 @@ by default, the parameter is set to:
 3 for mobile on iOS;
 Note: to use this parameter, set calculate_rectangles to true */
     browser_screen_resolution_ratio?: number | undefined;
-    /** clicks on the corresponding element
+    /** direct URL of the search query
 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;
-    /** load asynchronous ai overview
+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 */
+    url?: string | undefined;
+    /** 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.9 (mm)
+the maximum value for 'radius': 199999 (mm)
+example:
+53.476225,-2.243572,200 */
+    location_coordinate?: string | undefined;
+    /** search engine domain
 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;
-    /** additional parameters of the search query
+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 for
 optional field
-get the list of available parameters and additional details here */
-    search_param?: string | undefined;
-    /** remove specific parameters from URLs
+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 mode
 optional field
-using this field, you can specify up to 10 parameters to remove from URLs in the result
+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 */
+    target_search_mode?: string | undefined;
+    /** 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:
-'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;
-    /** user-defined task identifier
+'find_targets_in': ['organic', 'featured_snippet']
+learn more about this parameter on our Help Center */
+    find_targets_in?: string[] | undefined;
+    /** SERP element types to exclude from target search
 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;
+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 */
+    ignore_targets_in?: string[] | undefined;
     [key: string]: any;
 }
 export declare class SerpGoogleOrganicLiveAdvancedRequestInfo implements ISerpGoogleOrganicLiveAdvancedRequestInfo {
@@ -239,12 +239,20 @@ if you need to use the “+” character for your keyword, please specify it as
 if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** 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.
+    /** 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:
-https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
-    url?: string | undefined;
+2840 */
+    location_code?: number | undefined;
+    /** 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/{{low_se_name}}/languages
+example:
+en */
+    language_code?: string | undefined;
     /** parsing depth
 optional field
 number of results in SERP
@@ -254,65 +262,33 @@ 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;
 The cost can be calculated on the Pricing page. */
     depth?: number | undefined;
-    /** page crawl limit
+    /** device type
 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 page;
-Note#2: the max_crawl_pages and depth parameters complement each other;
-learn more at our help center */
-    max_crawl_pages?: number | undefined;
+can take the values:desktop, mobile
+default value: desktop */
+    device?: string | undefined;
+    /** 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 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
+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 */
     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/google/locations
-example:
-2840 */
-    location_code?: number | undefined;
-    /** 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.9 (mm)
-the maximum value for “radius”: 199999 (mm)
-example:
-53.476225,-2.243572,200 */
-    location_coordinate?: string | undefined;
     /** 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
+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/{{low_se_name}}/languages
 example:
 English */
     language_name?: string | undefined;
-    /** 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;
-    /** 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;
-    /** device type
-optional field
-can take the values:desktop, mobile
-default value: desktop */
-    device?: string | undefined;
     /** device operating system
 optional field
 if you specify desktop in the device field, choose from the following values: windows, macos
@@ -320,19 +296,12 @@ default value: windows
 if you specify mobile in the device field, choose from the following values: android, ios
 default value: android */
     os?: string | undefined;
-    /** target domain, subdomain, or webpage to get results for
+    /** user-defined task identifier
 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;
+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;
@@ -342,48 +311,44 @@ example:
 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 type
+optional field
+type of match for the match_value
+possible values: domain, with_subdomains, wildcard */
+    match_type?: string | undefined;
     /** target domain or wildcard value
-required field if stop_crawl_on_match is specified;
+optional field
 specify a target domain or wildcard value;
 Note: domain name must be specified without a request protocol;
 example: dataforseo.com */
     match_value?: string | undefined;
-    /** target match type
-required field if stop_crawl_on_match is specified;
-type of match for the match_value
-possible values: domain, with_subdomains, wildcard */
-    match_type?: string | undefined;
-    /** target matching mode
+    /** page crawl limit
 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 */
-    target_search_mode?: string | undefined;
-    /** SERP element types to check for targets
+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 page;
+Note#2: the max_crawl_pages and depth parameters complement each other;
+learn more at our help center */
+    max_crawl_pages?: number | undefined;
+    /** additional parameters of the search query
 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 */
-    find_targets_in?: string[] | undefined;
-    /** SERP element types to exclude from target search
+get the list of available parameters and additional details here */
+    search_param?: string | undefined;
+    /** remove specific parameters from URLs
 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
+using this field, you can specify up to 10 parameters to remove from URLs in the result
 example:
-'ignore_targets_in': ['paid', 'images']
-learn more about this parameter on our Help Center */
-    ignore_targets_in?: string[] | undefined;
+'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 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 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;
@@ -425,38 +390,73 @@ by default, the parameter is set to:
 3 for mobile on iOS;
 Note: to use this parameter, set calculate_rectangles to true */
     browser_screen_resolution_ratio?: number | undefined;
-    /** clicks on the corresponding element
+    /** direct URL of the search query
 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;
-    /** load asynchronous ai overview
+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 */
+    url?: string | undefined;
+    /** 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.9 (mm)
+the maximum value for 'radius': 199999 (mm)
+example:
+53.476225,-2.243572,200 */
+    location_coordinate?: string | undefined;
+    /** search engine domain
 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;
-    /** additional parameters of the search query
+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 for
 optional field
-get the list of available parameters and additional details here */
-    search_param?: string | undefined;
-    /** remove specific parameters from URLs
+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 mode
 optional field
-using this field, you can specify up to 10 parameters to remove from URLs in the result
+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 */
+    target_search_mode?: string | undefined;
+    /** 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:
-'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;
-    /** user-defined task identifier
+'find_targets_in': ['organic', 'featured_snippet']
+learn more about this parameter on our Help Center */
+    find_targets_in?: string[] | undefined;
+    /** SERP element types to exclude from target search
 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;
+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 */
+    ignore_targets_in?: string[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpGoogleOrganicLiveAdvancedRequestInfo);
     init(data?: any): void;