キーワード
API + MCPGET/v3/gsc/keywords
このエンドポイントへのリクエストは無料で、APIユニットを消費しません。
クエリパラメータ
keyword_listsstring
キーワードリストのフィルター(JSON文字列)。include(is)、exclude(is_not)、empty(どのリストにも含まれない)、not_empty(いずれかのリストに含まれる)をサポートします。
keyword_list_idinteger
指標を表示する既存のキーワードリストのID。
wherestring
対応フィールド:
- keyword
- top_url
- url
- clicks
- impressions
- ctr
- position
フィルターはブール式を表すJSON文字列で、以下の構造に従う必要があります:
<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> ]
limitinteger
返す結果数です。
デフォルト:1000
devicestring
デバイスタイプ(DESKTOP、MOBILE、TABLET)で絞り込みます。指定しない場合は、すべてのデバイスが対象になります。
許可される値:desktopmobiletablet
countrystring
2文字の国コード(ISO 3166-1 alpha-2)。
許可される値:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring
返却する検索結果の種類(web、image、video、news)。
許可される値:webimagevideonews
デフォルト:web
date_tostring
履歴期間の終了日(YYYY-MM-DD形式)。
date_fromstring必須
履歴期間の開始日(YYYY-MM-DD形式)。
portfolio_idinteger
ポートフォリオ ID。指定すると、ポートフォリオ内の GSC 接続済みプロジェクト全体のデータを集計します。
project_idinteger
プロジェクト ID。portfolio_id が指定されていない場合は必須です。
outputstring
出力形式。
許可される値:jsoncsvxmlphp
応答
keywordsarray<object>
keywordstring
urls_countinteger
top_urlstring or null
clicksinteger or null
impressionsinteger or null
ctrnumber or null
positionnumber or null
平均掲載順位(小数、例:4.7)
keyword_list_labelsarray<string>
errorstring
errorstring
errorstring
errorstring
errorstring