Docs
Szukaj w dokumentacji...⌘K

Słowa kluczowe

API + MCP
GET/v3/gsc/keywords

Żądania do tego punktu końcowego są bezpłatne i nie zużywają żadnych jednostek API.

Parametry zapytania

project_idinteger

Identyfikator projektu. Wymagany, gdy nie podano portfolio_id.

portfolio_idinteger

Identyfikator portfolio. Jeśli zostanie podany, agreguje dane ze wszystkich projektów w portfolio połączonych z GSC.

date_fromstring (date)Wymagane

Data początkowa okresu historycznego w formacie YYYY-MM-DD.

date_tostring (date)

Data końcowa okresu historycznego w formacie YYYY-MM-DD.

search_typestring

Typ wyników wyszukiwania, które mają zostać zwrócone (web, image, video, news).

Dozwolone wartości:webimagevideonews
Domyślne:web
countrystring

Dwuliterowy kod kraju (ISO 3166-1 alpha-2).

Dozwolone wartości:adaeafagaialamaoarasatauawazba…
devicestring

Filtrowanie według typu urządzenia (DESKTOP, MOBILE, TABLET). Jeśli nie zostanie określony, uwzględniane są wszystkie urządzenia.

Dozwolone wartości:desktopmobiletablet
limitinteger

Liczba wyników do zwrócenia.

Domyślne:1000
wherestring

Obsługiwane pola:

keyword_list_idinteger

Identyfikator istniejącej listy słów kluczowych, dla której mają być wyświetlane metryki.

keyword_listsstring

Filtr list słów kluczowych (ciąg znaków JSON). Obsługuje opcje: include (is), exclude (is_not), empty (nie znajduje się na żadnej liście) oraz not_empty (znajduje się na co najmniej jednej liście).

outputstring

Format wyjściowy.

Dozwolone wartości:jsonphpxml

Odpowiedzi

keywordsarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywordstring
keyword_list_labelsarray<string>
positionnumber (float) or null

Średnia pozycja (wartość dziesiętna, np. 4.7)

top_urlstring (url) or null
urls_countinteger