Looker Studio の高度なサービス

コネクタが BigQuery からデータを取得する場合、Looker Studio の Advanced Services を使用するとコネクタを最適化できます。BigQuery API を直接呼び出す代わりにクエリ設定を指定すると、Looker Studio でデータとスキーマが取得されます。

仕組み

Looker Studio Advanced Services を使用するコミュニティ コネクタは、通常のコネクタと同様に機能します。

ただし、getSchema() 関数や getData() 関数の実行からのレスポンスが異なります。これらの関数は、スキーマとデータを取得して返すのではなく、クエリ設定を返すことができます。クエリ構成が返されると、Looker Studio は提供されたクエリ構成に基づいてスキーマやデータを直接取得します。

コネクタの開発

Looker Studio Advanced Services を使用するコミュニティ コネクタは、通常のコネクタと同じように機能しますが、以下の点では異なります。

  1. マニフェスト キーが加えられる
  2. getSchema() および getData() からのレスポンスが異なる

マニフェスト リファレンス

マニフェストで、次のプロパティを true に設定します。

  • getSchema() にはプロパティ dataStudio.advancedServices.schema を使用します
  • getData() にはプロパティ dataStudio.advancedServices.data を使用します

true の値は、それぞれの関数について、コネクタが標準のレスポンスではなくクエリ設定を返すことを示します。

標準の getSchema() レスポンスを使用して独自のスキーマを定義するには、マニフェストで dataStudio.advancedServices.schema を false に設定するか、このプロパティを省略します。これは、スキーマ内のすべてのフィールドを 1 つの BigQuery クエリで表すことができない場合（マルチスキーマ コネクタを作成する場合など）に必要です。

BigQuery クエリは承認されたユーザーに代わって実行されるため、マニフェストに BigQuery OAuth スコープ（"https://www.googleapis.com/auth/bigquery.readonly"）を含めて、承認をリクエストする必要もあります。

以下は、承認されたユーザーの認証情報を使用して BigQuery に接続するコネクタ マニフェストです。

{
  "dataStudio": {
    "name": "BigQuery Public Dataset Demo",
    "logoUrl": "https://www.gstatic.com/images/branding/product/1x/data_connector_48dp.png",
    "company": "Looker DevRel",
    "companyUrl": "https://developers.google.com/looker-studio/",
    "addOnUrl": "https://developers.google.com/looker-studio/",
    "supportUrl": "https://developers.google.com/looker-studio/",
    "description": "Use BigQuery public dataset with Looker Studio's Advanced Services.",
    "advancedServices": {
      "schema": true,
      "data": true
    }
  },
  "oauthScopes": ["https://www.googleapis.com/auth/bigquery.readonly"]
}

サービス アカウントを使用して BigQuery にアクセスしている場合、マニフェストで bigquery.readonly OAuth スコープは必要ありません。ただし、スコープはサービス アカウントのスコープ リストに追加する必要があります。

getData と getSchema のリファレンス

Looker Studio の Advanced Services を使用するコネクタは、getSchema() と getData() のクエリ設定オブジェクトを返します。データソースによっては、この設定に追加のプロパティが必要になる場合があります。

以下は、DataStudioApp サービスを使用してこの設定オブジェクトを作成するサンプルコードです。

var bqTypes = DataStudioApp.createCommunityConnector().BigQueryParameterType;
var configuration = DataStudioApp.createCommunityConnector().newBigQueryConfig()
    // BigQuery billing project's Id.
    .setBillingProjectId('billingProjectId')
    // The query that will be executed.
    .setQuery('myQueryString')
    // Set to `true` to use StandardSQL.
    .setUseStandardSql(true)
    // The accessToken used for service execution.
    .setAccessToken('myAccessToken')
    // Adding a `STRING` query parameter. Other supported types are `BOOL`,
    // `FLOAT64`, and `INT64`.
    .addQueryParameter('myUrlParameterName', bqTypes.STRING, 'myUrlParameterValue')
    .build();

関数 getSchema() と getData() の例

var sqlString = "" +
    "SELECT " +
    "  _TABLE_SUFFIX AS yyyymm, " +
    "  ROUND(SUM(IF(fcp.start < @fast_fcp, fcp.density, 0)), 4) AS fast_fcp, " +
    "  ROUND(SUM(IF(fcp.start >= 1000 AND fcp.start < 3000, fcp.density, 0)), 4) AS avg_fcp, " +
    "  ROUND(SUM(IF(fcp.start >= 3000, fcp.density, 0)), 4) AS slow_fcp " +
    "FROM " +
    "  `chrome-ux-report.all.*`, " +
    "  UNNEST(first_contentful_paint.histogram.bin) AS fcp " +
    "WHERE " +
    "  origin = @url " +
    "GROUP BY " +
    "  yyyymm " +
    "ORDER BY " +
    "  yyyymm ";

function getQueryConfig(request) {
  var url = (request.configParams && request.configParams.url);
  var projectId = (request.configParams && request.configParams.projectId);
  var authToken = ScriptApp.getOAuthToken();
  return DataStudioApp.createCommunityConnector().newBigQueryConfig()
      .setAccessToken(authToken)
      .setUseStandardSql(true)
      .setBillingProjectId(projectId)
      .setQuery(sqlString)
      .addQueryParameter('url', bqTypes.STRING, url)
      .addQueryParameter('fast_fcp', bqTypes.INT64, '' + 1000)
      .build();
}

function getSchema(request) {
  return getQueryConfig(request);
}

function getData(request) {
  return getQueryConfig(request)
}