Docs
ドキュメントを検索...⌘K

ページ

API + MCP
GET/v3/gsc/pages

このエンドポイントへのリクエストは無料で、APIユニットを消費しません。

クエリパラメータ

project_idinteger

プロジェクトID。portfolio_id が指定されていない場合は必須です。

portfolio_idinteger

ポートフォリオID。指定すると、ポートフォリオ内のGSCに接続されているすべてのプロジェクトのデータを集計します。

date_fromstring (date)必須

履歴期間の開始日（YYYY-MM-DD形式）。

date_tostring (date)

履歴期間の終了日（YYYY-MM-DD形式）。

search_typestring

返される検索結果の種類（web、image、video、news）。

許可される値:webimagevideonews
デフォルト:web
countrystring

2文字の国コード（ISO 3166-1 alpha-2）。

許可される値:adaeafagaialamaoarasatauawazba…
devicestring

デバイスの種類（DESKTOP、MOBILE、TABLET）でフィルタリングします。指定しない場合は、すべてのデバイスが対象になります。

許可される値:desktopmobiletablet
limitinteger

返す結果数です。

デフォルト:1000
wherestring

サポートされているフィールド：

利用可能なフィールド:
  • 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> ]
outputstring

出力形式。

許可される値:jsoncsvxmlphp

応答

pagesarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywords_countinteger
pagestring (url)
positionnumber (float) or null

平均掲載順位（小数、例：4.7）

top_keywordstring or null
traffic_valuenumber (float) or null

米ドル建ての推定トラフィック値