Skip to main content
POST
设置 Google 数据集信息任务
设置 Google Dataset Info 任务。返回请求中指定数据集的详细信息。仅设置任务时才会向您的账户收费。

示例

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
dataset_id
string

ID of the dataset

required field

you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result

example:

L2cvMTFqbl85ZHN6MQ==

language_code
string | null

search engine language code

optional field

if you use this field, you don't need to specify language_name

possible value:

en

priority
integer | null

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.

device
string | null

device type

optional field

return results for a specific device type

possible value: desktop

pingback_url
string | null

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

postback_url
string | null

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_data
string

postback_url datatype

required field if you specify postback_url

corresponds to the datatype that will be sent to your server

possible value: advanced

language_name
string | null

full name of search engine language

optional field

if you use this field, you don't need to specify language_code

possible value:

English

os
string | null

device operating system

optional field

choose from the following values: windows, macos

default value: windows

tag
string | null

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

示例:

响应

object | null

Successful operation

version
string | null

API 的当前版本

status_code
integer | null

general status code you can find the full list of the response codes here

status_message
string | null

general informational message you can find the full list of general informational messages here

time
string | null

total execution time, seconds

cost
number<double> | null

任务总成本(美元)

tasks_count
integer<int64> | null

tasks 数组中的任务数量

tasks_error
integer<int64> | null

返回错误的 tasks 数组中的任务数量

tasks
(object | null)[] | null

array of tasks