Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_serp_google_ads_search_live_advanced:{}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
payload.location_code | integer | No | search engine location code optional field 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/ads_search/locations example: 2840 Note: if you don’t specify location_name , location_code , or location_coordinate , the ads will be searched across all the available locations | |
payload.depth | integer | No | parsing depth optional field number of results in SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results ; The cost can be calculated on the Pricing page. | |
payload.target | string | No | domain name required field if advertiser_ids is not specified domain name associated with an advertiser account | |
payload.advertiser_ids | array | No | advertiser identifiers required field if target is not specified you can specify the maximum of 25 values in this array; advertiser_ids values for this parameter can be found in the Google Ads Advertisers endpoint; | |
payload.priority | integer | No | 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 page. | |
payload.location_name | string | No | full name of search engine location optional field 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/ads_search/locations example: London,England,United Kingdom Note: if you don’t specify location_name , location_code , or location_coordinate , the ads will be searched across all the available locations | |
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.location_coordinate | string | No | GPS coordinates of a location optional field if you use this field, you don’t need to specify location_name or location_code example: 52.6178549,-155.352142 Note: if you don’t specify location_name , location_code , or location_coordinate , the ads will be searched across all the available locations | |
payload.platform | string | No | advertising platform optional field possible values: all , google_play , google_maps , google_search , google_shopping , youtube default value: all | |
payload.format | string | No | ad format optional field possible values: all , text , image , video | |
payload.date_from | string | No | starting date of the time range optional field required field if date_to is specified; date format: “yyyy-mm-dd” minimum value: 2018-05-31 maximum value: today’s date example: “2020-01-01” | |
payload.date_to | string | No | ending date of the time range optional field required field if date_from is specified; date format: “yyyy-mm-dd” minimum value: 2018-05-31 maximum value: today’s date example: “2020-01-01” |
Output Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute dataforseo_serp_google_ads_search_live_advanced --payload '{}' --json
CLI flags
| Flag | Description |
|---|---|
--json | Print machine-readable output. |
--wait | Wait for terminal provider status when supported. |
--debug | Enable wait mode with additional status/log output. |
--wait-timeout SECONDS | Max seconds to wait in wait mode. |
--poll-interval SECONDS | Polling interval in seconds during wait mode. |
--timeout SECONDS | Request timeout in seconds. |
--connect-timeout SECONDS | Connection timeout in seconds. |
Cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.03per pricing unit. - Billing mode:
post_deduct.