dataforseo-client 2.0.15 → 2.0.17

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

@@ -10,12 +10,70 @@ if this field contains such parameters as ‘allinanchor:’, ‘allintext:’,
 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error
 learn 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
+    /** 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 */
+    location_code?: number | 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/{{low_se_name}}/languages
+example:
+en */
+    language_code?: string | undefined;
+    /** parsing depth
 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.
+number of results in SERP
+default value: 10
+max value: 700
+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;
+    /** device type
+optional field
+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.0006 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;
+    /** 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:
-https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
-    url?: string | undefined;
+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 */
+    pingback_url?: string | undefined;
+    /** return URL for sending task results
+optional field
+once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you 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/postbackscript?id=$id
+http://your-server.com/postbackscript?id=$id&tag=$tag
+Note: special characters in postback_url will be urlencoded;
+i.a., the # character will be encoded into %23
+learn more on our Help Center */
+    postback_url?: string | undefined;
+    /** postback_url datatype
+required field if you specify postback_url
+corresponds to the datatype that will be sent to your server
+possible values:
+regular, advanced, html */
+    postback_data?: string | undefined;
     /** task priority
 optional field
 can take the following values:
@@ -24,15 +82,43 @@ can take the following values:
 You will be additionally charged for the tasks with high execution priority.
 The cost can be calculated on the Pricing page. */
     priority?: number | undefined;
-    /** parsing depth
+    /** 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 */
+    location_name?: string | 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 */
+    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/{{low_se_name}}/languages
+example:
+English */
+    language_name?: string | undefined;
+    /** user-defined task identifier
 optional field
-number of results in SERP
-default value: 10
-max value: 700
-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;
+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;
+    /** 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;
     /** array of targets to stop crawling
 optional field
 if specified, the response will contain SERP results up to and including the specified match_value;
@@ -42,48 +128,17 @@ 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 domain or wildcard value
-required field if stop_crawl_on_match is specified;
-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;
+optional field
 type of match for the match_value
 possible values: domain, with_subdomains, wildcard */
     match_type?: string | undefined;
-    /** 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 */
-    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:
-'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
+    /** target domain or wildcard value
 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 */
-    ignore_targets_in?: string[] | undefined;
+specify a target domain or wildcard value;
+Note: domain name must be specified without a request protocol;
+example: dataforseo.com */
+    match_value?: string | undefined;
     /** page crawl limit
 optional field
 number of search results pages to crawl
@@ -93,63 +148,29 @@ 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;
-    /** 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/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 */
-    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/languages
-example:
-English */
-    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/languages
-example:
-en */
-    language_code?: string | undefined;
-    /** search engine domain
+    /** additional parameters of the search query
 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
+get the list of available parameters and additional details here */
+    search_param?: string | undefined;
+    /** 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:
-google.co.uk, google.com.au, google.de, etc. */
-    se_domain?: string | undefined;
-    /** device type
+'remove_from_url': ['srsltid'] */
+    remove_from_url?: string[] | undefined;
+    /** expand ai overview
 optional field
-can take the values:desktop, mobile
-default value: desktop */
-    device?: string | undefined;
-    /** device operating system
+set to true to expand the ai_overview item;
+default value: false;
+Note: this parameter applies only to HTML task results */
+    expand_ai_overview?: boolean | undefined;
+    /** clicks on the corresponding element
 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;
+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 regardless of task priority;
+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;
@@ -190,13 +211,91 @@ 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 regardless of task priority;
-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;
+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;
+    /** 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 */
+    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:
+'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
+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;
+    /** 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;
+    [key: string]: any;
+}
+export declare class SerpGoogleOrganicTaskPostRequestInfo implements ISerpGoogleOrganicTaskPostRequestInfo {
+    /** 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:’, ‘define:’, ‘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 error
+learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    keyword?: 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 */
+    location_code?: number | 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/{{low_se_name}}/languages
+example:
+en */
+    language_code?: string | undefined;
+    /** parsing depth
+optional field
+number of results in SERP
+default value: 10
+max value: 700
+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;
+    /** device type
+optional field
+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;
@@ -205,28 +304,17 @@ default value: false
 Note: you will be charged extra $0.0006 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;
-    /** expand ai overview
-optional field
-set to true to expand the ai_overview item;
-default value: false;
-Note: this parameter applies only to HTML task results */
-    expand_ai_overview?: boolean | undefined;
-    /** additional parameters of the search query
-optional field
-get the list of available parameters and additional details here */
-    search_param?: string | undefined;
-    /** remove specific parameters from URLs
+    /** notification URL of a completed task
 optional field
-using this field, you can specify up to 10 parameters to remove from URLs in the result
+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:
-'remove_from_url': ['srsltid'] */
-    remove_from_url?: string[] | undefined;
-    /** 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;
+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 */
+    pingback_url?: string | undefined;
     /** return URL for sending task results
 optional field
 once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
@@ -244,36 +332,6 @@ corresponds to the datatype that will be sent to your server
 possible values:
 regular, advanced, html */
     postback_data?: 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 */
-    pingback_url?: string | undefined;
-    [key: string]: any;
-}
-export declare class SerpGoogleOrganicTaskPostRequestInfo implements ISerpGoogleOrganicTaskPostRequestInfo {
-    /** 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:’, ‘define:’, ‘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 error
-learn 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.
-example:
-https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
-    url?: string | undefined;
     /** task priority
 optional field
 can take the following values:
@@ -282,15 +340,43 @@ can take the following values:
 You will be additionally charged for the tasks with high execution priority.
 The cost can be calculated on the Pricing page. */
     priority?: number | undefined;
-    /** parsing depth
+    /** 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 */
+    location_name?: string | 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 */
+    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/{{low_se_name}}/languages
+example:
+English */
+    language_name?: string | undefined;
+    /** user-defined task identifier
 optional field
-number of results in SERP
-default value: 10
-max value: 700
-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;
+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;
+    /** 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;
     /** array of targets to stop crawling
 optional field
 if specified, the response will contain SERP results up to and including the specified match_value;
@@ -300,48 +386,17 @@ 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 domain or wildcard value
-required field if stop_crawl_on_match is specified;
-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;
+optional field
 type of match for the match_value
 possible values: domain, with_subdomains, wildcard */
     match_type?: string | undefined;
-    /** 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 */
-    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:
-'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
+    /** target domain or wildcard value
 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 */
-    ignore_targets_in?: string[] | undefined;
+specify a target domain or wildcard value;
+Note: domain name must be specified without a request protocol;
+example: dataforseo.com */
+    match_value?: string | undefined;
     /** page crawl limit
 optional field
 number of search results pages to crawl
@@ -351,63 +406,29 @@ 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;
-    /** 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/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 */
-    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/languages
-example:
-English */
-    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/languages
-example:
-en */
-    language_code?: string | undefined;
-    /** search engine domain
+    /** additional parameters of the search query
 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
+get the list of available parameters and additional details here */
+    search_param?: string | undefined;
+    /** 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:
-google.co.uk, google.com.au, google.de, etc. */
-    se_domain?: string | undefined;
-    /** device type
+'remove_from_url': ['srsltid'] */
+    remove_from_url?: string[] | undefined;
+    /** expand ai overview
 optional field
-can take the values:desktop, mobile
-default value: desktop */
-    device?: string | undefined;
-    /** device operating system
+set to true to expand the ai_overview item;
+default value: false;
+Note: this parameter applies only to HTML task results */
+    expand_ai_overview?: boolean | undefined;
+    /** clicks on the corresponding element
 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;
+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 regardless of task priority;
+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;
@@ -448,71 +469,50 @@ 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
-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 regardless of task priority;
-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
-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.0006 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;
-    /** expand ai overview
+    /** direct URL of the search query
 optional field
-set to true to expand the ai_overview item;
-default value: false;
-Note: this parameter applies only to HTML task results */
-    expand_ai_overview?: boolean | undefined;
-    /** additional parameters of the search query
+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;
+    /** target matching mode
 optional field
-get the list of available parameters and additional details here */
-    search_param?: string | undefined;
-    /** remove specific parameters from URLs
+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
-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
+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'] */
-    remove_from_url?: string[] | undefined;
-    /** 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;
-    /** return URL for sending task results
+'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
-once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you 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
+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:
-http://your-server.com/postbackscript?id=$id
-http://your-server.com/postbackscript?id=$id&tag=$tag
-Note: special characters in postback_url will be urlencoded;
-i.a., the # character will be encoded into %23
-learn more on our Help Center */
-    postback_url?: string | undefined;
-    /** postback_url datatype
-required field if you specify postback_url
-corresponds to the datatype that will be sent to your server
-possible values:
-regular, advanced, html */
-    postback_data?: string | undefined;
-    /** notification URL of a completed task
+'ignore_targets_in': ['paid', 'images']
+learn more about this parameter on our Help Center */
+    ignore_targets_in?: string[] | undefined;
+    /** search engine domain
 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.
+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:
-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 */
-    pingback_url?: string | undefined;
+google.co.uk, google.com.au, google.de, etc. */
+    se_domain?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpGoogleOrganicTaskPostRequestInfo);
     init(data?: any): void;