Zaawansowane usługi Looker Studio

Jeśli Twój łącznik pobiera dane z BigQuery, możesz zoptymalizować go za pomocą usług zaawansowanych Looker Studio. Zamiast bezpośrednio wywoływać interfejs BigQuery API, podajesz konfigurację zapytania, a Looker Studio pobiera dane i schemat.

Jak to działa

Oprogramowanie sprzęgające społeczności korzystające z usług zaawansowanych Looker Studio działa podobnie do zwykłego oprogramowania sprzęgającego.

Istotną różnicą jest oczekiwana odpowiedź po wykonaniu funkcji getSchema() lub getData(). Zamiast pobierać i zwracać schemat i dane, te funkcje mogą zwracać konfiguracje zapytań. Gdy zwracana jest konfiguracja zapytania, Looker Studio bezpośrednio pobiera schemat lub dane na podstawie podanej konfiguracji zapytania.

Tworzenie oprogramowania sprzęgającego

Oprogramowanie sprzęgające społeczności, które korzysta z usług zaawansowanych Looker Studio, jest takie samo jak zwykłe oprogramowanie sprzęgające z 2 wyjątkami.

  1. dodatkowy klucz pliku manifestu,
  2. Inna odpowiedź niż getSchema() lub getData()

Dokumentacja pliku manifestu

W pliku manifestu ustaw te właściwości na true.

  • W przypadku getSchema() użyj usługi dataStudio.advancedServices.schema
  • W przypadku getData() użyj usługi dataStudio.advancedServices.data

Wartość true oznacza, że w przypadku danej funkcji łącznik zwróci konfigurację zapytania zamiast standardowej odpowiedzi.

Aby zdefiniować własny schemat za pomocą standardowej odpowiedzi getSchema(), ustaw wartość dataStudio.advancedServices.schema na false w pliku manifestu lub pomiń tę właściwość. Jest to potrzebne, gdy wszystkich pól w schemacie nie można przedstawić za pomocą jednego zapytania BigQuery, np. podczas tworzenia oprogramowania sprzęgającego z wieloma schematami.

Zapytanie BigQuery zostanie wykonane w imieniu autoryzowanego użytkownika, dlatego w manifeście musisz też uwzględnić zakres OAuth BigQuery ("https://www.googleapis.com/auth/bigquery.readonly"), aby poprosić o autoryzację.

Poniżej znajduje się plik manifestu oprogramowania sprzęgającego, który używa danych logowania autoryzowanego użytkownika do łączenia się z 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"]
}

Jeśli do uzyskiwania dostępu do BigQuery używasz konta usługi, w pliku manifestu nie jest wymagany bigquery.readonlyzakres OAuth. Zakres należy jednak dodać do listy zakresów konta usługi.

Materiały referencyjne dotyczące obiektów getData i getSchema

Oprogramowania sprzęgające korzystające z usług zaawansowanych Looker Studio zwracają obiekt konfiguracji zapytania dla getSchema() lub getData(). W zależności od źródła danych ta konfiguracja może wymagać dodatkowych właściwości.

Ten przykład pokazuje, jak utworzyć ten obiekt konfiguracji za pomocą usługi 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();

Przykład funkcji getSchema() i 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)
}