このページは Cloud Translation API によって翻訳されました。

Search Analytics: query

認証が必要です

定義したフィルタとパラメータを使用して、検索トラフィックデータをクエリします。このメソッドは、定義した行キー（ディメンション）でグループ化された 0 個以上の行を返します。1 日以上の期間を定義する必要があります。

日付がディメンションの 1 つの場合、データのない日は結果リストから除外されます。データがある日付を確認するには、関心のある期間について、日付でグループ化されたフィルタなしのクエリを実行します。

結果はクリック数の降順で並べ替えられます。2 つの行のクリック数が同じ場合は、任意の方法で並べ替えられます。

このメソッドの呼び出しについては、Python サンプルをご覧ください。

この API は Search Console の内部的な制限によって制限されており、すべてのデータ行が返されるわけではありません。上位のデータ行が返されます。

使用できるデータの量の上限を確認する。

JSON POST の例:

POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

パラメータ

パラメータ名	値	説明
パスパラメータ
`siteUrl`	`string`	Search Console で定義したプロパティの URL。例: `http://www.example.com/`（URL プレフィックスプロパティの場合）または `sc-domain:example.com`（ドメインプロパティの場合）

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

スコープ
`https://www.googleapis.com/auth/webmasters.readonly`
`https://www.googleapis.com/auth/webmasters`

リクエスト本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}

プロパティ名	値	説明
`startDate`	`string`	[必須] リクエストされた期間の開始日（YYYY-MM-DD 形式）。太平洋時間（UTC - 7:00/8:00）で指定します。終了日以前でなければなりません。この値は範囲に含まれます。
`endDate`	`string`	[必須] リクエストされた期間の終了日（YYYY-MM-DD 形式、太平洋時間（UTC - 7:00/8:00））。開始日以降の日付を指定してください。この値は範囲に含まれます。
`dimensions[]`	`list`	[省略可] 結果をグループ化するディメンションを 0 個以上指定します。結果は、指定したディメンションの順序でグループ化されます。`dimensionFilterGroups[].filters[].dimension` には任意のディメンション名を使用できます。また、「date」と「hour」も使用できます。グループ化ディメンションの値が結合され、結果の行ごとに一意のキーが作成されます。ディメンションが指定されていない場合、すべての値が 1 つの行に結合されます。グループ化できるディメンションの数に上限はありませんが、同じディメンションで 2 回グループ化することはできません。例: [country, device]
`searchType`	`string`	非推奨。代わりに `type` を使用してください
`type`	`string`	[省略可] 結果を次の種類にフィルタします。「`discover`」: Discover の結果「`googleNews`」: news.google.com と Android および iOS の Google ニュースアプリの結果。Google 検索の [ニュース] タブの検索結果は含まれません。「`news`」: Google 検索の [ニュース] タブの検索結果。「`image`」: Google 検索の [画像] タブの検索結果。「`video`」: 動画検索結果「`web`」: [デフォルト] Google 検索の [すべて] タブに結果をフィルタします。Discover や Google ニュースの結果は含まれません。
`dimensionFilterGroups[]`	`list`	[省略可] ディメンションのグループ化値に適用するフィルタのグループを 0 個以上指定します。行がレスポンスで返されるには、すべてのフィルタグループが一致している必要があります。1 つのフィルタグループ内で、すべてのフィルタが一致する必要があるか、少なくとも 1 つが一致する必要があるかを指定できます。
`dimensionFilterGroups[].groupType`	`string`	このグループ内のすべてのフィルタが true を返す必要があるか（「AND」）、1 つ以上が true を返す必要があるか（まだサポートされていません）。有効な値は次のとおりです。「`and`」: フィルタグループが true になるには、グループ内のすべてのフィルタが true を返す必要があります。
`dimensionFilterGroups[].filters[]`	`list`	[省略可] 行に対してテストするフィルタ。0 個以上指定できます。各フィルタは、ディメンション名、演算子、値で構成されます。最大長は 4,096 文字です。例: country equals FRA query contains mobile use device notContains tablet
`dimensionFilterGroups[].filters[].dimension`	`string`	このフィルタが適用されるディメンション。ここに表示されているディメンションでフィルタできます（そのディメンションでグループ化していなくてもかまいません）。有効な値は次のとおりです。「`country`」: 3 文字の国コード（ISO 3166-1 alpha-3）で指定された国をフィルタします。「`device`」: 指定したデバイスタイプで結果をフィルタします。サポートされている値: DESKTOP モバイル TABLET 「`page`」: 指定した URI 文字列でフィルタします。「`query`」: 指定されたクエリ文字列でフィルタします。「`searchAppearance`」: 特定の検索結果の機能でフィルタします。使用可能な値のリストを表示するには、「searchAppearance」でグループ化されたクエリを実行します。値と説明の完全なリストは、ヘルプドキュメントでもご覧いただけます。
`dimensionFilterGroups[].filters[].operator`	`string`	[省略可] 指定した値が行のディメンション値と一致する（または一致しない）方法。有効な値は次のとおりです。「`contains`」: 行の値に式が含まれているか、式と等しい必要があります（大文字と小文字は区別されません）。「`equals`」: [デフォルト] 式は行の値と完全に一致している必要があります（ページディメンションとクエリディメンションでは大文字と小文字が区別されます）。「`notContains`」: 行の値に、式がサブ文字列として含まれていたり、完全一致（大文字と小文字を区別しない）で含まれていたりしている場合、式は使用できません。「`notEquals`」: 式は行の値と完全に一致している必要はありません（ページとクエリのディメンションでは大文字と小文字が区別されます）。「`includingRegex`」: 一致させる必要がある RE2 構文の正規表現。「`excludingRegex`」: 一致しないようにする RE2 構文の正規表現。
`dimensionFilterGroups[].filters[].expression`	`string`	演算子に応じて、フィルタが一致または除外する値。
`aggregationType`	`string`	[省略可] データの集計方法。プロパティごとに集計する場合は、同じプロパティのすべてのデータが集計されます。ページごとに集計する場合は、すべてのデータが正規 URI ごとに集計されます。ページでフィルタまたはグループ化する場合、[自動] を選択します。それ以外の場合は、データの計算方法に応じて、プロパティまたはページで集計できます。サイトとページでデータの計算方法が異なる点については、ヘルプドキュメントをご覧ください。注: ページでグループ化またはフィルタする場合、プロパティで集計することはできません。 auto 以外の値を指定した場合は、結果の集計タイプがリクエストされたタイプと一致します。無効なタイプをリクエストすると、エラーが発生します。リクエストされたタイプが無効な場合、API は集計タイプを変更しません。有効な値は次のとおりです。「`auto`」: [デフォルト] 適切な集計タイプをサービスに決定させます。「`byNewsShowcasePanel`」: ニュースショーケースパネルで値を集計します。これは、`NEWS_SHOWCASE` `searchAppearance` フィルタと `type=discover` または `type=googleNews` のいずれかと組み合わせて使用する必要があります。ページでグループ化、ページでフィルタ、または別の `searchAppearance` にフィルタする場合、`byNewsShowcasePanel` で集計することはできません。「`byPage`」: URI ごとに値を集計します。「`byProperty`」: プロパティごとに値を集計します。`type=discover` または `type=googleNews` ではサポートされていません
`rowLimit`	`integer`	[省略可。有効な範囲は 1 ～ 25,000。デフォルトは 1,000] 返される行の最大数。結果をページ分割するには、`startRow` オフセットを使用します。
`startRow`	`integer`	[省略可、デフォルトは 0] レスポンスの最初の行のゼロベースのインデックス。負でない数値を指定してください。`startRow` がクエリの結果数を超えると、レスポンスは成功レスポンスになり、行は 0 になります。
`dataState`	`string`	[省略可] 「all」（大文字と小文字を区別しない）の場合、データには最新のデータが含まれます。「final」（大文字と小文字は区別されません）またはこのパラメータを省略すると、返されるデータには確定済みのデータのみが含まれます。「hourly_all」（大文字と小文字を区別しない）の場合、データには 1 時間ごとの内訳が含まれます。これは、1 時間あたりのデータに部分データが含まれており、HOUR API ディメンションでグループ化する場合に使用する必要があることを示します。

レスポンス

結果は、リクエストで指定されたディメンションに従ってグループ化されます。同じディメンション値セットを持つすべての値は、1 つの行にグループ化されます。たとえば、国ディメンションでグループ化すると、「usa」のすべての結果がグループ化され、「mdv」のすべての結果がグループ化されます。国とデバイスでグループ化した場合は、「米国、タブレット」のすべての結果がグループ化され、「米国、モバイル」のすべての結果がグループ化されます。クリック数やインプレッション数などの計算方法とその意味については、検索アナリティクスレポートのドキュメントをご覧ください。

結果はクリック数で降順に並べ替えられます。日付でグループ化した場合は、日付で昇順に並べ替えられます（古い順）。2 つの行が同等の場合、並べ替え順序は任意です。

返される値の最大数については、リクエストの rowLimit プロパティをご覧ください。

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}

プロパティ名	値	説明
`rows[]`	`list`	クエリで指定された順序でキー値別にグループ化された行のリスト。
`rows[].keys[]`	`list`	リクエスト内のディメンションに従ってグループ化された、その行のディメンション値のリスト（リクエストで指定された順序）。
`rows[].clicks`	`double`	行のクリック数をクリックします。
`rows[].impressions`	`double`	行のインプレッション数。
`rows[].ctr`	`double`	行のクリック率（CTR）。値の範囲は 0 ～ 1.0 です（両端を含みます）。
`rows[].position`	`double`	検索結果での平均掲載順位。
`responseAggregationType`	`string`	結果の集計方法。サイトとページでデータの計算方法が異なる理由については、ヘルプドキュメントをご覧ください。有効な値は次のとおりです。「`auto`」「`byPage`」: 結果はページごとに集計されています。「`byProperty`」: 結果はプロパティごとに集計されています。

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。