コネクタが BigQuery からデータを取得する場合は、Looker Studio Advanced Services を使用してコネクタを最適化できます。BigQuery API を直接呼び出す代わりにクエリ構成を指定すると、Looker Studio がデータとスキーマを取得します。
仕組み
Looker Studio の Advanced Services を使用するコミュニティ コネクタは、通常のコネクタと同様に機能します。
顕著な違いは、getSchema()
関数や getData()
関数(あるいはその両方)の実行によるレスポンスです。これらの関数は、スキーマとデータを取得して返す代わりに、クエリ構成を返すことができます。クエリ構成が返されると、Looker Studio は指定されたクエリ構成に基づいてスキーマやデータを直接取得します。
コネクタの開発
Looker Studio Advanced Services を使用するコミュニティ コネクタは、通常のコネクタと同じですが、2 つの点で例外があります。
マニフェスト リファレンス
マニフェストで、次のプロパティを 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)
}