メインコンテンツまでスキップ

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 プロパティに関するメタデータが含まれています。これらには検索パフォーマンスのメトリクスは含まれておらず、パイプラインのランごとに完全に更新されます。

ソーステーブル

プライマリーキー

説明

同期モード

sites

site_url

権限レベルを含む、Google Search Consoleに登録された検証済みサイトプロパティ。

フル更新のみ

sitemaps

site_url, path

検証済みの各プロパティについて Google Search Console に送信されたサイトマップ。

フル更新のみ

ソーステーブル

プライマリーキー

説明

同期モード

sites

site_url

権限レベルを含む、Google Search Consoleに登録された検証済みサイトプロパティ。

フル更新のみ

sitemaps

site_url, path

検証済みの各プロパティについて Google Search Console に送信されたサイトマップ。

フル更新のみ

構築済みレポートテーブル​

事前構築されたレポートテーブルには、Google Search アナリティクス APIからのクリック、インプレッション、クリックスルー率(CTR)、および位置データが含まれます。事前構築されたレポートテーブルはすべて増分同期されます。

各テーブルは同じ4つのメトリクス (clicks、impressions、ctr、position) を返しますが、データが集計されるディメンションと、結果を返す前に Google が適用する集計タイプが異なります。集計タイプを参照してください。

日次レポート テーブル​

これらのテーブルは、検索パフォーマンスデータを暦日単位で集計します。カーソルフィールドは date です。

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

search_analytics_all_fields

日付、国、デバイス、ページ、クエリー

自動

Web、ニュース、画像、動画

site_url、date、country、device、page、query、 search_type

date

search_analytics_by_country

日付、国

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、country、 search_type

date

search_analytics_by_date

日付

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、 search_type

date

search_analytics_by_device

日付、デバイス

自動

ウェブ、ニュース、画像、動画、googleNews

site_url、date、device、 search_type

date

search_analytics_by_page

日付、ページ

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、page、 search_type

date

search_analytics_by_query

日付、クエリー

自動

Web、ニュース、画像、動画

site_url、date、query、 search_type

date

search_analytics_page_report

日付、国、デバイス、ページ

自動

ウェブ、ニュース、画像、動画、googleNews

site_url、date、country、device、page、 search_type

date

search_analytics_site_report_by_page

日付、国、デバイス

ページ単位

ウェブ、ニュース、画像、動画、googleNews

site_url、date、country、device、 search_type

date

search_analytics_site_report_by_site

日付、国、デバイス

byProperty

Web、ニュース、画像、動画

site_url、date、country、device、 search_type

date

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

search_analytics_all_fields

日付、国、デバイス、ページ、クエリー

自動

Web、ニュース、画像、動画

site_url、date、country、device、page、query、 search_type

date

search_analytics_by_country

日付、国

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、country、 search_type

date

search_analytics_by_date

日付

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、 search_type

date

search_analytics_by_device

日付、デバイス

自動

ウェブ、ニュース、画像、動画、googleNews

site_url、date、device、 search_type

date

search_analytics_by_page

日付、ページ

自動

ウェブ、ニュース、画像、動画、発見、Google ニュース

site_url、date、page、 search_type

date

search_analytics_by_query

日付、クエリー

自動

Web、ニュース、画像、動画

site_url、date、query、 search_type

date

search_analytics_page_report

日付、国、デバイス、ページ

自動

ウェブ、ニュース、画像、動画、googleNews

site_url、date、country、device、page、 search_type

date

search_analytics_site_report_by_page

日付、国、デバイス

ページ単位

ウェブ、ニュース、画像、動画、googleNews

site_url、date、country、device、 search_type

date

search_analytics_site_report_by_site

日付、国、デバイス

byProperty

Web、ニュース、画像、動画

site_url、date、country、device、 search_type

date

時間単位のレポートテーブル​

これらのテーブルは、検索パフォーマンス・データを1時間ごとに集計します。これらは hourly_all データ状態のみを使用し、data_state コネクタ・オプションの影響を受けません。カーソル・フィールドは hour です。利用可能な検索タイプは web および googleNews に制限されています。

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

hourly_search_analytics_page_report

時間、国、デバイス、ページ

自動

Web、googleNews

site_url、hour、country、device、page、 search_type

hour

hourly_search_analytics_site_report_by_page

時間、国、デバイス

ページ単位

Web、googleNews

site_url、hour、country、device、 search_type

hour

hourly_search_analytics_site_report_by_site

時間、国、デバイス

byProperty

Web、googleNews

site_url、hour、country、device、 search_type

hour

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

hourly_search_analytics_page_report

時間、国、デバイス、ページ

自動

Web、googleNews

site_url、hour、country、device、page、 search_type

hour

hourly_search_analytics_site_report_by_page

時間、国、デバイス

ページ単位

Web、googleNews

site_url、hour、country、device、 search_type

hour

hourly_search_analytics_site_report_by_site

時間、国、デバイス

byProperty

Web、googleNews

site_url、hour、country、device、 search_type

hour

カスタムレポートテーブル​

custom_report テーブルは、コネクタオプションで指定されたディメンション、検索タイプ、および集計タイプを使用して日次レポートを実行します。カスタムレポートを参照してください。

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

custom_report

date、さらにその値 dimensions

の値 aggregation_type

の値 search_types

site_url、date、dimensionsの値、および search_type

date

ソーステーブル

ディメンション

集計タイプ

検索タイプ

プライマリーキー

カーソルフィールド

custom_report

date、さらにその値 dimensions

の値 aggregation_type

の値 search_types

site_url、date、dimensionsの値、および search_type

date

コネクターのオプション​

Google Search Console コネクタは、以下の構成オプションをサポートしています。使用方法については、例を参照してください。

オプション

Type

スコープ

必須

適用対象

説明

site_urls

JSON形式の文字列の配列

パイプライン

はい

すべてのテーブル

取り込む、検証済みの Google Search Console プロパティ URL(1つ以上)。各 URL は、Google Search Console で検証済みのプロパティである必要があります(例:https://example.com/ または sc-domain:example.com)。

start_date

文字列 (yyyy-MM-dd)

パイプライン

No

すべてのインクリメンタル テーブル (search_analytics_*、 hourly_search_analytics_*、 custom_report)

データを取り込む最も早い日付(yyyy-MM-dd形式)。最初の同期の500日前がdefault。sites または sitemaps(フル更新)には影響しません。

data_state

String

テーブル

No

毎日の検索パフォーマンス テーブル (search_analytics_*) と custom_report

日次検索パフォーマンス表および custom_report のデータの鮮度。all (default) には、確定データと最新データが含まれます。final には、確定データのみが含まれます。search_analytics_* オブジェクトおよび custom_report オブジェクトに対してのみ設定してください。sites、sitemaps、および hourly_search_analytics_* テーブルでは、このオプションは使用できません。

dimensions

JSON形式の文字列の配列

テーブル

はい

custom_report のみ

レポートをグループ化するディメンション。たとえば '["country", "device"]'。許可される値は date、country、device、page、および query です。コネクターには、リストに記載していない場合でも date が含まれます。

search_types

JSON形式の文字列の配列

テーブル

はい

custom_report のみ

レポートをランする検索タイプ(例: '["web", "image"]')。許容される値は、 web、 image、 video、 news、 discover、および googleNewsです。コネクタは、検索タイプごとにレポートを1回ランし、 search_type カラムに検索タイプを書き込みます。

aggregation_type

String

テーブル

No

custom_report のみ

Google Search Console がメトリクスを集計する方法。auto(default)、byPage、またはbyPropertyのいずれか。集計タイプを参照してください。

オプション

Type

スコープ

必須

適用対象

説明

site_urls

JSON形式の文字列の配列

パイプライン

はい

すべてのテーブル

取り込む、検証済みの Google Search Console プロパティ URL(1つ以上)。各 URL は、Google Search Console で検証済みのプロパティである必要があります(例:https://example.com/ または sc-domain:example.com)。

start_date

文字列 (yyyy-MM-dd)

パイプライン

No

すべてのインクリメンタル テーブル (search_analytics_*、 hourly_search_analytics_*、 custom_report)

データを取り込む最も早い日付(yyyy-MM-dd形式)。最初の同期の500日前がdefault。sites または sitemaps(フル更新)には影響しません。

data_state

String

テーブル

No

毎日の検索パフォーマンス テーブル (search_analytics_*) と custom_report

日次検索パフォーマンス表および custom_report のデータの鮮度。all (default) には、確定データと最新データが含まれます。final には、確定データのみが含まれます。search_analytics_* オブジェクトおよび custom_report オブジェクトに対してのみ設定してください。sites、sitemaps、および hourly_search_analytics_* テーブルでは、このオプションは使用できません。

dimensions

JSON形式の文字列の配列

テーブル

はい

custom_report のみ

レポートをグループ化するディメンション。たとえば '["country", "device"]'。許可される値は date、country、device、page、および query です。コネクターには、リストに記載していない場合でも date が含まれます。

search_types

JSON形式の文字列の配列

テーブル

はい

custom_report のみ

レポートをランする検索タイプ(例: '["web", "image"]')。許容される値は、 web、 image、 video、 news、 discover、および googleNewsです。コネクタは、検索タイプごとにレポートを1回ランし、 search_type カラムに検索タイプを書き込みます。

aggregation_type

String

テーブル

No

custom_report のみ

Google Search Console がメトリクスを集計する方法。auto(default)、byPage、またはbyPropertyのいずれか。集計タイプを参照してください。

カスタムレポート​

custom_report テーブルを使用して、構築済みのテーブルではカバーされないディメンション、検索タイプ、および集計タイプの組み合わせをインジェストします。パイプライン内の各 custom_report オブジェクトは、site_urls 内のすべてのサイト URL に対して 1 つのレポートをランします。

コネクタは dimensions のディメンションを要求し、dimensions にまだ含まれていない場合は date も要求します。レポートは日単位で集計されるため、custom_report テーブルは hour ディメンションをサポートしていません。時間単位のデータをインジェストするには、時間単位のレポートテーブルを使用します。

複数のカスタムレポートをインジェストするには、レポートごとに custom_report オブジェクトを追加し、それぞれに異なる destination_table を指定します。カスタムレポートの取り込みをご覧ください。

集計タイプ​

aggregation_type オプションは、Google Search Console がカスタムレポートのメトリクスをどのように集計するかを設定します。各事前構築レポートテーブルは、テーブルの行にリストされている固定集計タイプを使用します。

aggregation_type

集計

auto

Google Search Consoleは集計を選択します。これがdefaultです。

byPage

メトリクスをページごとに集計します。

byProperty

プロパティごとにメトリクスを集計します。page ディメンションまたは discover および googleNews 検索タイプをサポートしていません。

aggregation_type

集計

auto

Google Search Consoleは集計を選択します。これがdefaultです。

byPage

メトリクスをページごとに集計します。

byProperty

プロパティごとにメトリクスを集計します。page ディメンションまたは discover および googleNews 検索タイプをサポートしていません。

集計タイプごとにクリックのカウント方法が異なるため、同じ日付範囲でも、集計タイプの異なるテーブル間のクリック数は一致せず、Google Search Console UIのクリック数とも一致しません。詳細については、GoogleのドキュメントのaggregationTypeをご覧ください。

宛先テーブルのスキーマ​

custom_reportを含むすべてのレポートテーブルには、コネクタが追加する次の列が含まれています。

  • site_url (STRING): 行の元の Google Search Console プロパティ URL。
  • search_type (STRING): 行の取得元である検索タイプ。
  • ingestion_timestamp (TIMESTAMP): コネクタが行を取り込んだ時間。

sites​

主キー: site_url 同期モード: フル更新のみ

フィールド

データ型

site_url

STRING

permission_level

STRING

フィールド

データ型

site_url

STRING

permission_level

STRING

sitemaps​

プライマリキー: site_url、path 同期モード: 完全更新のみ

フィールド

データ型

site_url

STRING

path

STRING

last_submitted

STRING

is_pending

BOOLEAN

is_sitemaps_index

BOOLEAN

type

STRING

last_downloaded

STRING

warnings

BIGINT

errors

BIGINT

contents

ARRAY<STRUCT<type: STRING, submitted: BIGINT, indexed: BIGINT>>

フィールド

データ型

site_url

STRING

path

STRING

last_submitted

STRING

is_pending

BOOLEAN

is_sitemaps_index

BOOLEAN

type

STRING

last_downloaded

STRING

warnings

BIGINT

errors

BIGINT

contents

ARRAY<STRUCT<type: STRING, submitted: BIGINT, indexed: BIGINT>>

search_analytics_all_fields​

ディメンション: date、country、device、page、query 集計タイプ: auto 検索タイプ: web、news、image、video 主キー: site_url、date、country、device、page、query、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

page

STRING

query

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

page

STRING

query

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_by_country​

ディメンション: date、country 集計タイプ: auto 検索タイプ: web、news、image、video、discover、googleNews 主キー: site_url、date、country、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_by_date​

ディメンション: date 集計タイプ: auto 検索タイプ: web、news、image、video、discover、googleNews プライマリキー: site_url、date、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_by_device​

ディメンション: date、device 集計タイプ: auto 検索タイプ: web、news、image、video、googleNews 主キー: site_url、date、device、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_by_page​

ディメンション: date、page 集計タイプ: auto 検索タイプ: web、news、image、video、discover、googleNews 主キー: site_url、date、page、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_by_query​

ディメンション: date、query 集計タイプ: auto 検索タイプ: web、news、image、video プライマリキー: site_url、date、query、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

query

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

query

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_page_report​

ディメンション: date、country、device、page 集計タイプ: auto 検索タイプ: web、news、image、video、googleNews 主キー: site_url、date、country、device、page、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_site_report_by_page​

ディメンション: date、country、device 集計タイプ: byPage 検索タイプ: web、news、image、video、googleNews 主キー: site_url、date、country、device、search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

search_analytics_site_report_by_site​

寸法: date 、 country 、 device 集計タイプ: プロパティ別 検索タイプ: ウェブ、ニュース、画像、動画 プライマリキー: site_url 、 date 、 country 、 device 、 search_type カーソルフィールド: date

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

hourly_search_analytics_page_report​

寸法: hour 、 country 、 device 、 page 集計タイプ: 自動 検索タイプ: ウェブ、Googleニュース プライマリキー: site_url 、 hour 、 country 、 device 、 page 、 search_type カーソルフィールド: hour

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

page

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

hourly_search_analytics_site_report_by_page​

ディメンション: hour、country、device 集計タイプ: byPage 検索タイプ: web、googleNews 主キー: site_url、hour、country、device、search_type カーソルフィールド: hour

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

hourly_search_analytics_site_report_by_site​

ディメンション: hour、country、device 集計タイプ: byProperty 検索タイプ: web、googleNews 主キー: site_url、hour、country、device、search_type カーソルフィールド: hour

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

hour

STRING

country

STRING

device

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

custom_report​

ディメンション: date および dimensions の値 集計タイプ: aggregation_type の値 検索タイプ: search_types の値 主キー: site_url、date、dimensions の値、および search_type カーソル フィールド: date

テーブルには次のカラムが含まれています。dimensionsにリストするcountry、device、page、およびqueryのそれぞれについて、STRINGカラムも含まれています。

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

フィールド

データ型

site_url

STRING

search_type

STRING

date

STRING

clicks

DOUBLE

impressions

DOUBLE

ctr

DOUBLE

position

DOUBLE

ingestion_timestamp

TIMESTAMP

必要なOAuth権限​

Google Search Consoleコネクタは、https://www.googleapis.com/auth/webmasters.readonlyスコープをリクエストします。このスコープは、認証されたIDがアクセス権を持つプロパティのすべてのGoogle Search Consoleデータに対する読み取り専用アクセス権を付与します。

権限

必須:

https://www.googleapis.com/auth/webmasters.readonly

すべてのテーブル

権限

必須:

https://www.googleapis.com/auth/webmasters.readonly

すべてのテーブル