设置 Google 自然搜索 SERP 任务

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post"

payload = [
    {
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein"
    },
    {
        "language_name": "English",
        "location_name": "United States",
        "keyword": "albert einstein",
        "priority": 2,
        "tag": "some_string_123",
        "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
    },
    {
        "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
        "postback_data": "html",
        "postback_url": "https://your-server.com/postbackscript"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {language_code: 'en', location_code: 2840, keyword: 'albert einstein'},
    {
      language_name: 'English',
      location_name: 'United States',
      keyword: 'albert einstein',
      priority: 2,
      tag: 'some_string_123',
      pingback_url: 'https://your-server.com/pingscript?id=$id&tag=$tag'
    },
    {
      url: 'https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS',
      postback_data: 'html',
      postback_url: 'https://your-server.com/postbackscript'
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'language_code' => 'en',
        'location_code' => 2840,
        'keyword' => 'albert einstein'
    ],
    [
        'language_name' => 'English',
        'location_name' => 'United States',
        'keyword' => 'albert einstein',
        'priority' => 2,
        'tag' => 'some_string_123',
        'pingback_url' => 'https://your-server.com/pingscript?id=$id&tag=$tag'
    ],
    [
        'url' => 'https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS',
        'postback_data' => 'html',
        'postback_url' => 'https://your-server.com/postbackscript'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post"

	payload := strings.NewReader("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {
      "id": "<string>",
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "cost": 123,
      "result_count": 123,
      "path": [
        "<string>"
      ],
      "data": {},
      "result": {}
    }
  ]
}

POST

https://api.aisa.one

apis

dataforseo

serp

google

organic

task_post

设置 Google 自然搜索 SERP 任务

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post"

payload = [
    {
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein"
    },
    {
        "language_name": "English",
        "location_name": "United States",
        "keyword": "albert einstein",
        "priority": 2,
        "tag": "some_string_123",
        "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
    },
    {
        "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
        "postback_data": "html",
        "postback_url": "https://your-server.com/postbackscript"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {language_code: 'en', location_code: 2840, keyword: 'albert einstein'},
    {
      language_name: 'English',
      location_name: 'United States',
      keyword: 'albert einstein',
      priority: 2,
      tag: 'some_string_123',
      pingback_url: 'https://your-server.com/pingscript?id=$id&tag=$tag'
    },
    {
      url: 'https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS',
      postback_data: 'html',
      postback_url: 'https://your-server.com/postbackscript'
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'language_code' => 'en',
        'location_code' => 2840,
        'keyword' => 'albert einstein'
    ],
    [
        'language_name' => 'English',
        'location_name' => 'United States',
        'keyword' => 'albert einstein',
        'priority' => 2,
        'tag' => 'some_string_123',
        'pingback_url' => 'https://your-server.com/pingscript?id=$id&tag=$tag'
    ],
    [
        'url' => 'https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS',
        'postback_data' => 'html',
        'postback_url' => 'https://your-server.com/postbackscript'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post"

	payload := strings.NewReader("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\"\n  },\n  {\n    \"language_name\": \"English\",\n    \"location_name\": \"United States\",\n    \"keyword\": \"albert einstein\",\n    \"priority\": 2,\n    \"tag\": \"some_string_123\",\n    \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n  },\n  {\n    \"url\": \"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS\",\n    \"postback_data\": \"html\",\n    \"postback_url\": \"https://your-server.com/postbackscript\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {
      "id": "<string>",
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "cost": 123,
      "result_count": 123,
      "path": [
        "<string>"
      ],
      "data": {},
      "result": {}
    }
  ]
}

设置 Google Organic SERP 任务。标准的基于任务的端点。仅在设置任务时向您的账户收费。每次 POST 调用最多可发送 100 个任务。

示例

curl -X POST "https://api.aisa.one/apis/v1/dataforseo/serp/google/organic/task_post" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[{"keyword": "...", "location_name": "...", "location_code": "..."}]'

授权

Authorization

string

header

必填

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

请求体

application/json

keyword

string

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:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5

learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

location_code

integer

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

language_code

string

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

depth

integer | null

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.

device

string | null

device type

optional field

return results for a specific device type

can take the values:desktop, mobile

default value: desktop

load_async_ai_overview

boolean | null

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

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 values:

regular, advanced, html

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.

location_name

string

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_coordinate

string

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 (mm)

the maximum value for "radius": 199999 (mm)

example:

53.476225,-2.243572,200

language_name

string

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

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

string | null

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

stop_crawl_on_match

(object | null)[] | null

array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] 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

Show child attributes

match_type

string

target match type

required field if stop_crawl_on_match is specified

type of match for the match_value

possible values:

domain – specific domain or subdomain

with_subdomains – main domain and subdomains

wildcard – wildcard pattern

match_value

string

target domain, subdomain, or wildcard value

required field if stop_crawl_on_match is specified

specify a target domain, subdomain, or wildcard value;

Note: domain or subdomain must be specified without a request protocol;

example: "match_value": "dataforseo.com",

"match_value": "/blog/post-*"

max_crawl_pages

integer | null

page crawl limit

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

search_param

string | null

additional parameters of the search query

optional field

get the list of available parameters and additional details here

Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.

remove_from_url

string[] | null

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:

"remove_from_url": ["srsltid"]

expand_ai_overview

boolean | null

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

people_also_ask_click_depth

integer | null

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

group_organic_results

boolean | null

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;

if set to false, the related_result element will be provided as a separate organic result;

default value: true

calculate_rectangles

boolean | null

calcualte 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: you will be charged extra $0.0006 for using this parameter

browser_screen_width

integer<int64> | null

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

browser_screen_height

integer | null

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

browser_screen_resolution_ratio

integer | null

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

url

string | null

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

Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.

target_search_mode

string | null

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

find_targets_in

string[] | null

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

ignore_targets_in

string[] | null

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

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

se_domain

string | null

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.

示例:

[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]

响应

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

Show child attributes

​示例

授权

请求体

响应

示例