Tool ID:
dataforseo_serp_google_ai_mode_live_advancedRun this action
Use the TypeScript SDK for one call. Usectx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'dataforseo_serp_google_ai_mode_live_advanced',
{
"keyword": "software companies hiring engineers"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute dataforseo_serp_google_ai_mode_live_advanced --input '{
"keyword": "software companies hiring engineers"
}' --json
Example response
The SDK returns this shape atresult.toolResponse.raw. The example values illustrate the response.
{
"version": "example",
"status_code": 123,
"status_message": "example",
"time": "example",
"tasks_count": 123,
"tasks_error": 123,
"tasks": [
{}
]
}
deepline describe dataforseo_serp_google_ai_mode_live_advanced --json for the latest machine-readable contract.
Input reference
Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.keyword | string | Yes | — | 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” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
payload.location_code | integer | No | — | 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 Note: check Google Search Help for the list of countries where AI Mode is currently available |
payload.language_code | string | No | — | 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 |
payload.device | string | No | — | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
payload.location_name | string | No | — | 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 for the list of countries where AI Mode is currently available |
payload.language_name | string | No | — | 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 . |
payload.os | string | No | — | 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 |
payload.tag | string | No | — | 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 |
payload.calculate_rectangles | boolean | No | — | calculate 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>> by default, the parameter is set to false Note: if set to true , the charge per task will be multiplied by 2 |
payload.browser_screen_width | integer | No | — | 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 |
payload.browser_screen_height | integer | No | — | 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 |
payload.browser_screen_resolution_ratio | integer | No | — | 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 |
payload.location_coordinate | string | No | — | 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,zoom” format if “zoom” is not specified, 9z will be applied as a default value the maximum number of decimal digits for “latitude” and “longitude” : 7 the minimum value for “zoom” : 4z the maximum value for “zoom” : 18z example: See the live schema for the complete constraint. |
Output reference
Top-level response envelope for dataforseo_serp_google_ai_mode_live_advanced.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.version | string | Yes | — | the current version of the API |
result.status_code | integer | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
result.status_message | string | Yes | — | general informational message you can find the full list of general informational messages here |
result.time | string | Yes | — | execution time, seconds |
result.tasks_count | integer | Yes | — | the number of tasks in the tasks array |
result.tasks_error | integer | Yes | — | the number of tasks in the tasks array returned with an error |
result.tasks | array | Yes | — | array of tasks |
Deepline cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.06per pricing unit.