Google Search Console コネクタ リファレンス
ベータ版
This feature is in Beta.To use it, a ワークスペース admin must turn on Lakeflow Connect for Google Search Console from the Previews page.See Manage Databricks previews.
Lakeflow Connectのマネージド Google Search Console コネクタは、default スキーマ内の 15 個のソーステーブル(サイトテーブル 2 個、事前構築済みレポートテーブル 12 個、custom_report テーブル 1 個)をサポートします。サイトテーブルは完全更新で同期され、レポートテーブルは増分同期されます。カーソルフィールドは、日次レポートテーブルの場合は date で、custom_report、および時間単位のレポートテーブルの場合は hour です。
サポートされているソーステーブル
Google Search Console コネクターは、default ソーススキーマの下にある次のソーステーブルをサポートしています。サイトテーブルには、確認済みの Google Search Console プロパティに関するメタデータが含まれています。各レポートテーブルは、検索アナリティクス API を介して検索パフォーマンスレポートを実行し、固定のディメンションセットで結果をグループ化します。事前に構築されたレポートテーブルは、時間粒度によって整理されています。
各ディメンションとメトリクスの定義については、Google ドキュメントの 検索アナリティクス: クエリー を参照してください。
サイトテーブル
これらのテーブルには、検証済みの Google Search Console プロパティに関するメタデータが含まれています。これらには検索パフォーマンスのメトリクスは含まれておらず、パイプラインのランごとに完全に更新されます。
ソーステーブル | プライマリーキー | 説明 | 同期モード |
|---|---|---|---|
|
| 権限レベルを含む、Google Search Consoleに登録された検証済みサイトプロパティ。 | フル更新のみ |
|
| 検証済みの各プロパティについて Google Search Console に送信されたサイトマップ。 | フル更新のみ |
構築済みレポートテーブル
事前構築されたレポートテーブルには、Google Search アナリティクス APIからのクリック、インプレッション、クリックスルー率(CTR)、および位置データが含まれます。事前構築されたレポートテーブルはすべて増分同期されます。
各テーブルは同じ4つのメトリクス (clicks、impressions、ctr、position) を返しますが、データが集計されるディメンションと、結果を返す前に Google が適用する集計タイプが異なります。集計タイプを参照してください。
日次レポート テーブル
これらのテーブルは、検索パフォーマンスデータを暦日単位で集計します。カーソルフィールドは date です。
ソーステーブル | ディメンション | 集計タイプ | 検索タイプ | プライマリーキー | カーソルフィールド |
|---|---|---|---|---|---|
| 日付、国、デバイス、ページ、クエリー | 自動 | Web、ニュース、画像、動画 |
|
|
| 日付、国 | 自動 | ウェブ、ニュース、画像、動画、発見、Google ニュース |
|
|
| 日付 | 自動 | ウェブ、ニュース、画像、動画、発見、Google ニュース |
|
|
| 日付、デバイス | 自動 | ウェブ、ニュース、画像、動画、googleNews |
|
|
| 日付、ページ | 自動 | ウェブ、ニュース、画像、動画、発見、Google ニュース |
|
|
| 日付、クエリー | 自動 | Web、ニュース、画像、動画 |
|
|
| 日付、国、デバイス、ページ | 自動 | ウェブ、ニュース、画像、動画、googleNews |
|
|
| 日付、国、デバイス | ページ単位 | ウェブ、ニュース、画像、動画、googleNews |
|
|
| 日付、国、デバイス | byProperty | Web、ニュース、画像、動画 |
|
|
時間単位のレポートテーブル
これらのテーブルは、検索パフォーマンス・データを1時間ごとに集計します。これらは hourly_all データ状態のみを使用し、data_state コネクタ・オプションの影響を受けません。カーソル・フィールドは hour です。利用可能な検索タイプは web および googleNews に制限されています。
ソーステーブル | ディメンション | 集計タイプ | 検索タイプ | プライマリーキー | カーソルフィールド |
|---|---|---|---|---|---|
| 時間、国、デバイス、ページ | 自動 | Web、googleNews |
|
|
| 時間、国、デバイス | ページ単位 | Web、googleNews |
|
|
| 時間、国、デバイス | byProperty | Web、googleNews |
|
|
カスタムレポートテーブル
custom_report テーブルは、コネクタオプションで指定されたディメンション、検索タイプ、および集計タイプを使用して日次レポートを実行します。カスタムレポートを参照してください。
ソーステーブル | ディメンション | 集計タイプ | 検索タイプ | プライマリーキー | カーソルフィールド |
|---|---|---|---|---|---|
| の値 | の値 |
|
|
コネクターのオプション
Google Search Console コネクタは、以下の構成オプションをサポートしています。使用方法については、例を参照してください。
オプション | Type | スコープ | 必須 | 適用対象 | 説明 |
|---|---|---|---|---|---|
| JSON形式の文字列の配列 | パイプライン | はい | すべてのテーブル | 取り込む、検証済みの Google Search Console プロパティ URL(1つ以上)。各 URL は、Google Search Console で検証済みのプロパティである必要があります(例: |
| 文字列 ( | パイプライン | No | すべてのインクリメンタル テーブル ( | データを取り込む最も早い日付( |
| String | テーブル | No | 毎日の検索パフォーマンス テーブル ( | 日次検索パフォーマンス表および |
| JSON形式の文字列の配列 | テーブル | はい |
| レポートをグループ化するディメンション。たとえば |
| JSON形式の文字列の配列 | テーブル | はい |
| レポートをランする検索タイプ(例: |
| String | テーブル | No |
| Google Search Console がメトリクスを集計する方法。 |
カスタムレポート
custom_report テーブルを使用して、構築済みのテーブルではカバーされないディメンション、検索タイプ、および集計タイプの組み合わせをインジェストします。パイプライン内の各 custom_report オブジェクトは、site_urls 内のすべてのサイト URL に対して 1 つのレポートをランします。
コネクタは dimensions のディメンションを要求し、dimensions にまだ含まれていない場合は date も要求します。レポートは日単位で集計されるため、custom_report テーブルは hour ディメンションをサポートしていません。時間単位のデータをインジェストするには、時間単位のレポートテーブルを使用します。
複数のカスタムレポートをインジェストするには、レポートごとに custom_report オブジェクトを追加し、それぞれに異なる destination_table を指定します。カスタムレポートの取り込みをご覧ください。
集計タイプ
aggregation_type オプションは、Google Search Console がカスタムレポートのメトリクスをどのように集計するかを設定します。各事前構築レポートテーブルは、テーブルの行にリストされている固定集計タイプを使用します。
| 集計 |
|---|---|
| Google Search Consoleは集計を選択します。これがdefaultです。 |
| メトリクスをページごとに集計します。 |
| プロパティごとにメトリクスを集計します。 |
集計タイプごとにクリックのカウント方法が異なるため、同じ日付範囲でも、集計タイプの異なるテーブル間のクリック数は一致せず、Google Search Console UIのクリック数とも一致しません。詳細については、GoogleのドキュメントのaggregationTypeをご覧ください。
宛先テーブルのスキーマ
custom_reportを含むすべてのレポートテーブルには、コネクタが追加する次の列が含まれています。
site_url(STRING): 行の元の Google Search Console プロパティ URL。search_type(STRING): 行の取得元である検索タイプ。ingestion_timestamp(TIMESTAMP): コネクタが行を取り込んだ時間。
sites
主キー: site_url
同期モード: フル更新のみ
フィールド | データ型 |
|---|---|
|
|
|
|
sitemaps
プライマリキー: site_url、path
同期モード: 完全更新のみ
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_all_fields
ディメンション: date、country、device、page、query
集計タイプ: auto
検索タイプ: web、news、image、video
主キー: site_url、date、country、device、page、query、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_by_country
ディメンション: date、country
集計タイプ: auto
検索タイプ: web、news、image、video、discover、googleNews
主キー: site_url、date、country、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_by_date
ディメンション: date
集計タイプ: auto
検索タイプ: web、news、image、video、discover、googleNews
プライマリキー: site_url、date、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_by_device
ディメンション: date、device
集計タイプ: auto
検索タイプ: web、news、image、video、googleNews
主キー: site_url、date、device、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_by_page
ディメンション: date、page
集計タイプ: auto
検索タイプ: web、news、image、video、discover、googleNews
主キー: site_url、date、page、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_by_query
ディメンション: date、query
集計タイプ: auto
検索タイプ: web、news、image、video
プライマリキー: site_url、date、query、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_page_report
ディメンション: date、country、device、page
集計タイプ: auto
検索タイプ: web、news、image、video、googleNews
主キー: site_url、date、country、device、page、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_site_report_by_page
ディメンション: date、country、device
集計タイプ: byPage
検索タイプ: web、news、image、video、googleNews
主キー: site_url、date、country、device、search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search_analytics_site_report_by_site
寸法: date 、 country 、 device
集計タイプ: プロパティ別
検索タイプ: ウェブ、ニュース、画像、動画
プライマリキー: site_url 、 date 、 country 、 device 、 search_type
カーソルフィールド: date
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
hourly_search_analytics_page_report
寸法: hour 、 country 、 device 、 page
集計タイプ: 自動
検索タイプ: ウェブ、Googleニュース
プライマリキー: site_url 、 hour 、 country 、 device 、 page 、 search_type
カーソルフィールド: hour
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
hourly_search_analytics_site_report_by_page
ディメンション: hour、country、device
集計タイプ: byPage
検索タイプ: web、googleNews
主キー: site_url、hour、country、device、search_type
カーソルフィールド: hour
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
hourly_search_analytics_site_report_by_site
ディメンション: hour、country、device
集計タイプ: byProperty
検索タイプ: web、googleNews
主キー: site_url、hour、country、device、search_type
カーソルフィールド: hour
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
custom_report
ディメンション: date および dimensions の値
集計タイプ: aggregation_type の値
検索タイプ: search_types の値
主キー: site_url、date、dimensions の値、および search_type
カーソル フィールド: date
テーブルには次のカラムが含まれています。dimensionsにリストするcountry、device、page、およびqueryのそれぞれについて、STRINGカラムも含まれています。
フィールド | データ型 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
必要なOAuth権限
Google Search Consoleコネクタは、https://www.googleapis.com/auth/webmasters.readonlyスコープをリクエストします。このスコープは、認証されたIDがアクセス権を持つプロパティのすべてのGoogle Search Consoleデータに対する読み取り専用アクセス権を付与します。
権限 | 必須: |
|---|---|
| すべてのテーブル |