Historia słów kluczowych

API + MCP

GET/v3/gsc/keyword-history

Żą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.

history_groupingstring

Przedział czasu używany do grupowania danych historycznych.

Dozwolone wartości:dailyweeklymonthly

Domyślne:monthly

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

keywordsstring

Lista słów kluczowych rozdzielonych przecinkami, dla których mają zostać pobrane dane historyczne.

wherestring

Obsługiwane pola:

Dostępne pola:

Filtr jest ciągiem znaków JSON, który reprezentuje wyrażenie logiczne. Powinien mieć następującą strukturę:

<bool_filter> ::= { "and" : <bool_filter>+ }
              |   { "or" : <bool_filter>+ }
              |   { "not" : <bool_filter> }
              |   <expr>

<expr> ::= {
             "field" : <dimension|metric>,
             ? "is": <condition>,
           }

<condition> ::= [ "eq", <value> ]
            |   [ "neq", <value> ]
            |   [ "gt", <value> ]
            |   [ "gte", <value> ]
            |   [ "lt", <value> ]
            |   [ "lte", <value> ]
            |   [ "substring", <value> ]
            |   [ "isubstring", <value> ]
            |   [ "phrase_match", <value> ]
            |   [ "iphrase_match", <value> ]
            |   [ "prefix", <value> ]
            |   [ "suffix", <value> ]

outputstring

Format wyjściowy.

Dozwolone wartości:jsoncsvxmlphp

Odpowiedzi

metricsarray<object>

clicksinteger

ctrnumber (float)

datestring (date-time)

impressionsinteger

keywordstring

positionnumber (float)

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