Advanced Services do Data Studio

Se seu conector busca dados do BigQuery, é possível usar o Advanced Services do Data Studio para otimizar o conector. Em vez de chamar a API BigQuery diretamente, você fornece uma configuração de consulta, e o Data Studio buscará as informações.

Como funciona

Os conectores da comunidade que usam o Advanced Services do Data Studio funcionam de maneira semelhante a um conector normal.

A maior diferença é a resposta esperada da execução da função getData(). Em vez de buscar e retornar dados, getData() retorna uma configuração de consulta que o Data Studio usa para procurar as informações.

Como desenvolver seu conector

Os conectores da comunidade que utilizam o Advanced Services do Data Studio são iguais a um conector normal, com duas exceções.

  1. Uma chave de manifesto adicional
  2. Uma resposta diferente de getData()

Referência do manifesto

No manifesto, defina a propriedade dataStudio.useQueryConfig como true. Isso informa ao Data Studio que a função getData() do seu conector retornará uma configuração de consulta em vez de dados.

Como a consulta do BigQuery será executada em nome do usuário autorizado, você também precisará incluir o escopo do OAuth do BigQuery ("https://www.googleapis.com/auth/bigquery.readonly") para solicitar autorização.

Veja a seguir um manifesto do conector com as credenciais do usuário autorizado para se conectar ao BigQuery:

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

Referência do getData

Os conectores que usam o Advanced Services do Data Studio retornam um objeto de configuração de consulta para getData. Dependendo da fonte de dados, essa configuração precisará de mais propriedades. O BigQuery, por exemplo, requer bigQueryConnectorConfig.

Veja a seguir um exemplo de como usar o serviço DataStudioApp para criar esse objeto de configuração:

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();
    

Exemplo de função 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 getData(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();
    }