API de vinculação

Introdução

Ela oferece uma interface confiável para configurar e encaminhar usuários diretamente a um relatório do Looker Studio por um URL. Quando os usuários seguem um URL da API Linking, eles têm uma experiência simplificada para ver e interagir com os dados rapidamente.

Este documento descreve o formato necessário dos URLs da API Linking e os parâmetros disponíveis.

Caso de uso e benefícios

Com a API Linking, é possível fornecer relatórios pré-configurados para seus clientes visualizarem e interagirem com os dados deles. Os principais benefícios da API Linking são os seguintes:

  • Uma experiência de criação de relatórios com um clique para seus clientes.
    • A configuração de dados é fornecida no URL para que os usuários não precisem configurar o relatório para os próprios dados.
    • Os usuários podem salvar o relatório com um único clique e revisitar o documento quando quiserem.
  • Criar relatórios em grande escala. A API Linking reduz o tempo necessário para duplicar ou criar relatórios.
  • Possibilitar integrações de produtos. A interface estável permite integrar o Looker Studio a um fluxo de trabalho de produto.

Como funciona

Veja a seguir como desenvolvedores e usuários interagem com a API Linking.

Fluxo de trabalho do desenvolvedor da API Linking

O desenvolvedor prepara os relatórios de modelo, as fontes de dados e formata um URL da API Linking. O fluxo de trabalho típico para desenvolvedores é o seguinte:

  1. Decida se quer usar um relatório em branco, o modelo de relatório padrão fornecido pelo Looker Studio ou criar um relatório do Looker Studio que sirva como modelo. Isso inclui configurar as fontes de dados do modelo.
  2. Formate um URL da API Linking para seu caso de uso específico. Se aplicável, especifique o modelo de relatório e outros parâmetros, incluindo o nome do relatório, o nome da fonte de dados e as configurações dela.
  3. Use o URL da API Linking para direcionar os usuários ao relatório.

Experiência do usuário da API Linking

O usuário segue um URL da API Linking que, se configurado corretamente pelo desenvolvedor, o direciona a um relatório do Looker Studio que permite visualizar e interagir com os dados a que ele tem acesso. Uma experiência típica do usuário pode ser assim:

  1. Em um navegador, o usuário acessa um serviço que foi integrado à API Linking.
  2. Uma call-to-action convida o usuário a clicar em um link para ver os dados no Looker Studio.
  3. O usuário segue o link e é direcionado a um relatório do Looker Studio. O relatório é carregado, e o usuário pode ver e interagir com os dados.
  4. O usuário clica em "Editar e compartilhar". O relatório é salvo na conta do Looker Studio.
  5. Agora o usuário tem acesso e controle total sobre a própria cópia do relatório. Ele pode ver, editar e compartilhar a qualquer momento.

Requisitos

Para garantir que um URL da API Linking funcione conforme o esperado, é necessário:

  1. Um relatório para servir como modelo. Se não for fornecido, um relatório em branco ou padrão, disponibilizado pelo Looker Studio, poderá ser usado.
  2. Os usuários de um URL da API Linking precisam ter, no mínimo, acesso de leitura ao relatório de modelo. Dependendo do tipo de fontes de dados usadas no relatório e da configuração fornecida pela API Linking, os usuários também podem precisar de acesso de leitura às fontes de dados. Consulte Permissões de modelo para mais detalhes.
  3. O tipo de conector de cada fonte de dados precisa ser compatível com a configuração pela API Linking. Consulte a referência de conectores para ver uma lista dos conectores compatíveis.
  4. Os usuários do URL da API Linking precisam ter acesso aos dados configurados nele. Se o usuário não tiver acesso aos dados subjacentes, todos os componentes de relatório dependentes vão mostrar um erro.

Parâmetros de URL

Um URL da API Linking precisa ter o seguinte formato:

https://lookerstudio.google.com/reporting/create?parameters

O URL deve ser usado no contexto de um navegador da Web, normalmente quando um usuário clica em um link ou é redirecionado ao URL. Também é possível usar para incorporar um relatório.

URL de exemplo

Confira a seguir um exemplo de URL da API Linking. O nome do relatório é definido e uma única fonte de dados do BigQuery é configurada:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.connector=bigQuery
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

Alguns parâmetros de URL são obrigatórios, enquanto outros são opcionais. Confira a seguir uma lista de parâmetros usados para definir um URL da API Linking:

Parâmetros de controle

Os parâmetros de controle determinam o estado do relatório quando ele é acessado pelo URL da API Linking.

Nome do parâmetro Descrição
c.reportId
Opcional. O ID do modelo do relatório. O Looker Studio vai abrir e configurar o relatório especificado. Para saber como encontrar o ID, consulte ID do relatório. Se não for especificado, um relatório em branco ou um modelo de relatório padrão será usado. Consulte Usar um relatório em branco ou padrão para mais detalhes.
c.pageId
Opcional. O ID da página inicial que vai ser carregada no relatório. O padrão é a primeira página do relatório se não for especificado.
c.mode
Opcional. O modo de relatório inicial. Um de view ou edit. Quando não especificado, o padrão é view.
c.explain
Opcional. A visibilidade da caixa de diálogo de informações/depuração. Defina como true para mostrar o botão da caixa de diálogo. Quando não especificado, o padrão é false. Consulte Solução de problemas de configuração para saber mais.

Exemplo

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &c.pageId=g7u8s9
  &c.mode=edit
  &r.reportName=MyNewReport
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

Parâmetros do relatório

Os parâmetros substituem as propriedades do relatório.

Nome do parâmetro Descrição
r.reportName
Opcional. Define o nome do relatório. Se não for especificado, o padrão será o nome do relatório do modelo.
r.measurementId

Opcional. Define os IDs de métricas do Google Analytics como Medir o uso de relatórios. Use uma vírgula para separar vários IDs.

Se r.measurementId e r.keepMeasurementId não forem especificados, a configuração padrão do relatório IDs de métricas do Google Analytics será "Não definido". Se r.measurementId e r.keepMeasurementId estiverem definidos, r.keepMeasurementId terá precedência para definir o ID.

r.keepMeasurementId

Opcional. Defina como true para usar o relatório de modelo IDs de métricas do Google Analytics. O padrão é false se não for especificado.

Se r.measurementId e r.keepMeasurementId não forem especificados, a configuração padrão do relatório IDs de métricas do Google Analytics será "não definido". Se r.measurementId e r.keepMeasurementId estiverem definidos, r.keepMeasurementId terá precedência para definir o ID.

Exemplo

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &r.measurementId=G-XXXXXXXXXX
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

Parâmetros da fonte de dados

Com os parâmetros de fonte de dados, é possível definir uma configuração e os dados a serem acessados para as fontes no relatório de modelo.

Um alias é usado para fazer referência a uma fonte de dados em um relatório existente. Isso permite a compatibilidade com versões anteriores se uma fonte de dados for adicionada/removida do relatório de modelo.

Para saber detalhes sobre como encontrar um alias de uma fonte de dados, consulte Alias de fonte de dados.

Parâmetros da fonte de dados

Os parâmetros a seguir são comuns a todos os tipos de conector:

Nome Descrição
ds.alias.datasourceName

Opcional. Define o nome da fonte de dados.

Se ds.datasourceName e ds.keepDatasourceName não forem especificados, o nome da fonte de dados vai usar uma convenção de nomenclatura que inclui o tipo de conector e a hora da criação, por exemplo, samples - 12/12/21, 10:53 PM. Se ds.datasourceName e ds.keepDatasourceName estiverem definidos, ds.datasourceName terá precedência para definir o nome da fonte de dados.

ds.alias.keepDatasourceName

Opcional. Defina como true para usar o nome da fonte de dados do modelo. Quando não especificado, o padrão é false.

Se ds.datasourceName e ds.keepDatasourceName não forem especificados, o nome da fonte de dados vai usar uma convenção de nomenclatura que inclui o tipo de conector e a hora da criação, por exemplo, samples - 12/12/21, 10:53 PM. Se ds.datasourceName e ds.keepDatasourceName estiverem definidos, ds.datasourceName terá precedência para definir o nome da fonte de dados.

ds.alias.connector
Opcional.

O tipo de conector da fonte de dados. Para mais informações sobre os tipos de conectores compatíveis, consulte a Referência de conectores.

Se definido, todos os parâmetros de conector obrigatórios para o tipo de conector precisam ser especificados no URL da API Linking, e a configuração da fonte de dados do modelo será substituída por completo.

Se não for especificado, zero ou mais parâmetros de conector para o tipo de conector poderão ser especificados no URL da API Linking. A configuração da fonte de dados do modelo será usada para especificar parâmetros não fornecidos no URL da API Linking. Para mais detalhes sobre como identificar o tipo de conector da fonte de dados do modelo, consulte Tipo de conector.

Para saber mais sobre como o parâmetro ds.connector afeta se uma configuração de fonte de dados de modelo é substituída por completo ou usada para atualizar parâmetros não especificados, consulte Substituir x atualizar.

ds.alias.refreshFields
Opcional.

Defina como true para usar a configuração da fonte de dados especificada pela API Linking para atualizar os campos da fonte de dados e atualizar os componentes do relatório com novas seleções de campos. true geralmente é especificado ao mudar o tipo de conector ou para tipos de conector em que uma mudança de configuração gera campos diferentes. Por exemplo, os campos para fontes de dados do BigQuery geralmente mudam com diferentes configurações de tabela.

Defina como false para deixar os campos da fonte de dados inalterados em relação ao relatório de modelo. Normalmente, false é especificado quando a nova configuração de dados gera exatamente os mesmos campos e você prefere manter as mudanças feitas na fonte de dados do modelo.

Se não for especificado, os padrões vão variar de acordo com o tipo de conector. Consulte a referência de conector para ver os padrões específicos do conector caso queira substituir o comportamento padrão.

Considerações ao usar refreshFields:
  • Se refreshFields estiver definido como false e a configuração da fonte de dados especificada pela API Linking gerar campos diferentes dos usados no relatório do modelo, o usuário provavelmente vai encontrar um erro de configuração nos componentes afetados.
  • As mudanças nos campos da fonte de dados do modelo (por exemplo, nome, tipo, agregação etc.) não são transferidas para novas fontes de dados quando refreshFields é definido como true. Defina refreshFields como false para manter as configurações de campo da fonte de dados do modelo.
  • Campos calculados e parâmetros definidos em fontes de dados de modelo sempre serão copiados para fontes de dados recém-criadas e não serão afetados pelo valor de refreshFields.
ds.alias.connectorParameters
Obrigatório. A configuração da fonte de dados para o tipo de conector. Para mais detalhes sobre como identificar o conector usado para criar uma fonte de dados, consulte Tipo de conector. Para detalhes sobre os parâmetros de fonte de dados disponíveis para cada tipo de conector, consulte a Referência de conectores.

Substituir x atualizar: configurações da fonte de dados

Ao definir parâmetros de fonte de dados, a presença ou omissão do parâmetro ds.connector no URL da API Linking indica a intenção de substituir ou atualizar a configuração da fonte de dados do modelo, respectivamente.

A tabela a seguir detalha como o parâmetro ds.connector afeta a substituição completa de uma configuração de fonte de dados de modelo ou o uso dela para atualizar parâmetros não especificados:

O valor ds.connector foi definido? Configuração e comportamento esperados Uso típico
Sim Substituir. A configuração da fonte de dados do modelo é substituída por completo usando os parâmetros especificados no URL da API Linking. É necessário especificar todos os parâmetros obrigatórios para o tipo de conector. Consulte Parâmetros obrigatórios quando ds.connector está definido.
  • Ao mudar o tipo de conector de uma fonte de dados. Por exemplo, se você configurou uma fonte de dados do BigQuery no relatório de modelo, mas quer configurar uma fonte de dados do Google Sheets usando a API Linking. Isso vai exigir uma nova configuração de conector definida por completo.
  • Quando você quer garantir a configuração de uma fonte de dados. A substituição evita que valores desconhecidos sejam usados na fonte de dados do modelo.
Não Atualizar. A configuração da fonte de dados do modelo será usada para especificar parâmetros não fornecidos no URL da API Linking. Todos os parâmetros do conector para o tipo de conector são opcionais, a menos que indicado de outra forma.

Isso simplifica o URL da API Linking e geralmente é recomendado quando você conhece a configuração da fonte de dados do modelo e quer substituir apenas um subconjunto de parâmetros.
  • Quando você quer fornecer apenas valores de parâmetros diferentes da fonte de dados do modelo e não se importa em depender dela para parâmetros de conector não especificados. Por exemplo, mude apenas o ID do projeto de faturamento de uma configuração de fonte de dados do BigQuery e use a configuração do modelo para todos os outros parâmetros.

Parâmetros obrigatórios quando ds.connector está definido

Se o parâmetro ds.connector de uma fonte de dados for especificado, todos os parâmetros do conector designados como Obrigatório também precisarão ser especificados para a fonte. Se o parâmetro ds.connector da fonte de dados não for especificado, todos os parâmetros do conector, mesmo os designados como obrigatórios, poderão ser tratados como opcionais, a menos que seja indicado o contrário.

Exemplos

Configura um relatório com uma única fonte de dados do BigQuery (ds0) e substitui toda a configuração da fonte de dados:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare

O alias da fonte de dados pode ser omitido quando o relatório tem uma única fonte. O URL acima pode ser simplificado para o seguinte:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.datasourceName=MyNewDataSource
  &ds.connector=bigQuery
  &ds.type=TABLE
  &ds.projectId=bigquery-public-data
  &ds.datasetId=samples
  &ds.tableId=shakespeare

Configura um relatório com uma única fonte de dados do BigQuery (ds0) e atualiza apenas o ID do projeto de faturamento da fonte de dados:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.billingProjectId=my-billing-project

Configura um relatório com duas fontes de dados, uma do BigQuery (ds0) e uma do Google Analytics (ds1). A configuração da fonte de dados do BigQuery é substituída por completo, enquanto a do Google Analytics atualiza um único parâmetro e depende da fonte de dados de modelo ds1 para parâmetros de conector não especificados:

https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &r.reportName=MyNewReportWithMultipleDataSources
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare
  &ds.ds1.viewId=92320289

Criar x adicionar

Às vezes, é útil ter a mesma fonte de dados em vários relatórios para que as atualizações nela afetem todos os relatórios juntos. Ao criar um relatório com a API Linking, você pode adicionar novamente uma fonte de dados do relatório de modelo se todas as condições a seguir forem atendidas:

  1. A fonte de dados é reutilizável (consulte fontes de dados incorporadas x reutilizáveis).
  2. O URL não faz referência à fonte de dados por alias
  3. O URL não usa um alias curinga. Consulte Alias curinga de fonte de dados.

Quando uma nova fonte de dados é criada com a API Linking, ela usa as credenciais do usuário que clicou no URL. Isso significa que o usuário precisa ter acesso aos dados subjacentes, ou a conexão não vai funcionar. Ao adicionar novamente a fonte de dados ao relatório recém-gerado, você preserva as credenciais dela para que os usuários possam continuar acessando os dados nos novos relatórios.

Curinga de alias da fonte de dados

Para aplicar um parâmetro da API Linking a várias fontes de dados, use o alias curinga ds.* no lugar do alias da fonte de dados.

Isso pode ser útil para remover parâmetros repetitivos do seu URL. Por exemplo, se você tiver um modelo com três fontes de dados do BigQuery anexadas e quiser substituir projectId e datasetId em cada uma delas, mas preservar tableId, poderá escrever da seguinte forma:

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.ds1.projectId=client-project
  &ds.ds1.datasetId=client-dataset
  &ds.ds2.projectId=client-project
  &ds.ds2.datasetId=client-dataset
  &ds.ds3.projectId=client-project
  &ds.ds3.datasetId=client-dataset

Ou, com o caractere curinga ds.*, você pode usar este URL equivalente:

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset

Os parâmetros fornecidos à API Linking que não usam o caractere curinga ds.* têm precedência sobre os que usam. No exemplo acima, você pode adicionar um alias de fonte de dados específico para substituir o valor do caractere curinga.

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset
  &ds.ds1.datasetId=client-dataset

Em geral, a ordem de precedência dos parâmetros é:

  1. Um parâmetro com um alias específico (ds.ds1.datasetId)
  2. Um parâmetro fornecido usando o caractere curinga (ds.*.datasetId)
  3. Um valor derivado da fonte de dados do modelo, se ds.connector não for fornecido (consulte Substituir x atualizar)
  4. O valor padrão do parâmetro, se ele for opcional.

Referência de conectores

A API Linking é compatível com os seguintes conectores e configurações. Para cada conector, é fornecida a lista de parâmetros da fonte de dados disponíveis.

BigQuery

O conector do BigQuery oferece suporte a dois tipos de consultas: TABLE, em que você fornece o ID da tabela a ser consultada, e CUSTOM_QUERY, em que você fornece uma instrução SQL para consultar uma tabela.

Consultas TABLE

Os parâmetros a seguir são aplicáveis quando type é definido como TABLE e você fornece o ID da tabela a ser consultada.

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como bigQuery para o conector do BigQuery.

Se definido, substitui a fonte de dados pela configuração do BigQuery fornecida. Consulte Substituir x atualizar.
ds.alias.type
Obrigatório**: o tipo de consulta. Defina como TABLE.
ds.alias.projectId
Obrigatório** O ID do projeto da tabela a ser consultada.
ds.alias.datasetId
Obrigatório**: o ID do conjunto de dados da tabela a ser consultada.
ds.alias.tableId
Obrigatório** O ID da tabela a ser consultada.

Tabelas particionadas por data:
o sufixo * (caractere curinga) ou YYYYMMDD é compatível ao consultar tabelas particionadas por data.
Se uma tabela for identificada como do Google Analytics, do Firebase Analytics ou do Firebase Crashlytics, um modelo de campos padrão será selecionado, a menos que um seja especificado. Consulte a tabela de parâmetros relacionados ao modelo de campos.
ds.alias.billingProjectId
Opcional. O ID do projeto a ser usado para faturamento. Se não for definido, projectId será usado.
ds.alias.isPartitioned
Opcional. Defina como true se a tabela for particionada e você quiser usar a coluna de particionamento como uma dimensão de período. Isso só é aplicável ao particionamento com base em tempo (por exemplo, usando uma coluna de particionamento com base em tempo ou a pseudocoluna _PARTITIONTIME) e não funciona para tabelas particionadas por intervalo de números inteiros. Quando não especificado, o padrão é false. Para saber mais, consulte Introdução às tabelas particionadas.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.
Modelo de campos para Google Analytics, Firebase Analytics e Crashlytics

Para tabelas identificadas como Google Analytics, Firebase Analytics ou Firebase Crashlytics, outros parâmetros estão disponíveis para definir o modelo de campos. Se não for especificado, um modelo padrão será selecionado.

Nome Descrição
ds.alias.gaTemplateLevel
Opcional. O modelo de campos do Google Analytics a ser usado. Aplicável somente quando uma tabela de exportação do BigQuery para o Google Analytics está sendo consultada. Uma das seguintes opções: ALL, SESSION, HITS. Para tabelas do Google Analytics, o padrão é ALL se não for especificado.
ds.alias.firebaseTemplateLevel
Opcional. O modelo de campos do Firebase Analytics a ser usado. Aplicável somente quando uma tabela de exportação do BigQuery para o Firebase Analytics está sendo consultada. Só pode ser definido como EVENTS. Para tabelas do Firebase Analytics, o padrão é EVENTS se não for especificado.
ds.alias.crashlyticsTemplateLevel
O modelo de campos do Firebase Crashlytics a ser usado. Só pode ser definido como DEFAULT. Aplicável somente quando uma consulta está sendo feita em uma tabela de exportação do BigQuery para o Firebase Crashlytics. Para tabelas do Firebase Crashlytics, o padrão é DEFAULT se não for especificado.

Consultas PERSONALIZADAS

Os parâmetros a seguir são aplicáveis quando type é definido como CUSTOM_QUERY e você fornece uma instrução SQL para consultar uma tabela.

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como bigQuery para o conector do BigQuery.

Se definido, substitui a fonte de dados pela configuração do BigQuery fornecida. Consulte Substituir x atualizar.
ds.alias.type
Obrigatório**: o tipo de consulta. Defina como CUSTOM_QUERY.
ds.alias.sql
Obrigatório**: a consulta SQL a ser executada.
ds.alias.billingProjectId
Opcional. O ID do projeto a ser usado para faturamento. Se não for definido, projectId será usado. Se projectId não estiver definido, o projeto da tabela consultada será usado.
ds.alias.sqlReplace

Opcional. Uma lista delimitada por vírgulas de padrões e strings de substituição a serem aplicados à consulta SQL. A substituição de string só é aplicada se houver uma correspondência de padrão. Use uma vírgula para separar os pares de padrão e string de substituição. Por exemplo, stringPattern1,replacementString1, stringPattern2,replacementString2.

ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.

Exemplos

Uma configuração de tipo TABLE em que a consulta é definida com um ID de tabela:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare
  &ds.ds0.billingProjectId=myProject

Uma configuração de tipo TABLE para consultar uma tabela fragmentada por data usando o sufixo de caractere curinga:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=price-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=stock_*
  

Uma configuração de tipo TABLE para consultar uma tabela fragmentada por data usando o sufixo YYYYMMDD:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=price-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=stock_YYYYMMDD
  

Uma configuração do tipo TABLE para consultar uma tabela do BigQuery Export para o Google Analytics usando o modelo de campos SESSION:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=my-gabq-project
  &ds.ds0.datasetId=1234567
  &ds.ds0.tableId=ga_sessions_YYYYMMDD
  &ds.ds0.gaTemplateLevel=SESSION
  

Uma configuração do tipo TABLE para consultar uma tabela particionada por tempo de ingestão e usar a coluna de particionamento como uma dimensão de período:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=acme-co-logs
  &ds.ds0.datasetId=logs
  &ds.ds0.tableId=logs_table
  &ds.ds0.isPartitioned=true

Uma configuração de tipo CUSTOM_QUERY em que a consulta é definida com uma instrução SQL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=CUSTOM_QUERY
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.sql=SELECT%20word%2C%20word_count%20FROM%20%60bigquery-public-data.samples.shakespeare%60
  &ds.ds0.billingProjectId=myProject

Uma configuração de tipo CUSTOM_QUERY em que apenas a instrução SQL é atualizada e a fonte de dados de modelo é usada para o restante da configuração:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60

Uma configuração de tipo CUSTOM_QUERY em que a instrução SQL da fonte de dados do modelo é atualizada usando sqlReplace:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.sqlReplace=bigquery-public-data,new-project,samples,new-dataset

# The following shows a template query before and after sqlReplace is applied.
#
# Template data source custom query:
#   SELECT word, word_count FROM big-query-public-data.samples.shakespeare
#   INNER JOIN
#   SELECT word, word_count FROM big-query-public-data.samples.raleigh
#
# New data source custom query with sqlReplace applied:
#   SELECT word, word_count FROM new-project.new-dataset.shakespeare
#   INNER JOIN
#   SELECT word, word_count FROM new-project.new-dataset.raleigh

Cloud Spanner

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como cloudSpanner para o conector do Cloud Spanner.

Se definido, substitui a fonte de dados pela configuração do Cloud Spanner fornecida. Consulte Substituir x atualizar.
ds.alias.projectId
Obrigatório**: o ID do projeto.
ds.alias.instanceId
Obrigatório**: o ID da instância.
ds.alias.databaseId
Obrigatório**: o ID do banco de dados.
ds.alias.sql
Obrigatório**: a consulta SQL a ser executada.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.

Exemplo

Uma configuração do Cloud Spanner com uma instrução SQL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=456def
  &ds.ds1.connector=cloudSpanner
  &ds.ds1.projectId=myProject
  &ds.ds1.instanceId=production
  &ds.ds1.datasetId=transactions
  &ds.ds1.sql=SELECT%20accountId%2C%20date%2C%20revenue%20FROM%20sales%3B

Conectores da comunidade

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como community para um conector da comunidade.

Se definido, substitui a fonte de dados pela configuração do conector da comunidade fornecida. Consulte Substituir x atualizar.
ds.alias.connectorId
Obrigatório**: o conector da comunidade connectorId (também conhecido como deploymentId).
ds.alias.parameters
Opcional. Outros parâmetros específicos do conector, conforme definido na configuração do conector do conector da comunidade.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.

Exemplo

Conecte-se a um conector da comunidade com parâmetros de configuração state e city:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=community
  &ds.ds5.connectorId=AqwqXxQshl94nJa0E0-1MsZXQL0DfCsJIMWk7dnx
  &ds.ds5.state=CA
  &ds.ds5.city=Sacramento

Google Analytics

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como googleAnalytics para o conector do Google Analytics.

Se definido, substitui a fonte de dados pela configuração fornecida do Google Analytics. Consulte Substituir x atualizar.
ds.alias.accountId
Obrigatório**: o ID da conta.
ds.alias.propertyId
Obrigatório**: o ID da propriedade.
ds.alias.viewId
O ID da vista.
Obrigatório** para propriedades do Universal Analytics.
Não defina para propriedades do Google Analytics 4.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é false. Consulte refreshFields para mais detalhes.

Exemplos

Uma configuração do Google Analytics para uma propriedade do Universal Analytics:

https://lookerstudio.google.com/reporting/create?
  c.reportId=789ghi
  &ds.ds2.connector=googleAnalytics
  &ds.ds2.accountId=54516992
  &ds.ds2.propertyId=UA-54516992-1
  &ds.ds2.viewId=92320289

Uma configuração do Google Analytics para uma propriedade do Google Analytics 4:

https://lookerstudio.google.com/reporting/create?
  c.reportId=789ghi
  &ds.ds2.connector=googleAnalytics
  &ds.ds2.accountId=54516992
  &ds.ds2.propertyId=213025502

Google Cloud Storage

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como googleCloudStorage Conector do Google Cloud Storage.

Se definido, substitui a fonte de dados pela configuração fornecida do Google Cloud Storage. Consulte Substituir x atualizar.
ds.alias.pathType
Obrigatório**: o tipo de caminho. Use FILE para selecionar um único arquivo ou FOLDER para selecionar todos os arquivos do caminho fornecido.
ds.alias.path
Obrigatório** O caminho do arquivo (por exemplo, MyBucket/MyData/MyFile.csv) se pathType for FILE ou o caminho da pasta (por exemplo, *MyBucket/MyData) se pathType for FOLDER.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.

Exemplo

Uma configuração do Google Cloud Storage para um único arquivo:

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FILE
  &ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv

Uma configuração do Google Cloud Storage para todos os arquivos no caminho:

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FOLDER
  &ds.ds50.path=MyBucket%2FMyData

Planilhas Google

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como googleSheets para o conector do Planilhas Google.

Se definido, substitui a fonte de dados pela configuração das Planilhas Google fornecida. Consulte Substituir x atualizar.
ds.alias.spreadsheetId
Obrigatório** O ID da planilha.
ds.alias.worksheetId
Obrigatório**: o ID da planilha.
ds.alias.hasHeader
Opcional. Defina como true para usar a primeira linha como cabeçalho. Quando não especificado, o padrão é true. Os cabeçalhos das colunas precisam ser exclusivos. Colunas sem cabeçalho não são adicionadas à fonte de dados.
ds.alias.includeHiddenCells
Opcional. Defina como true para incluir células ocultas. Quando não especificado, o padrão é true.
ds.alias.includeFilteredCell
Opcional. Defina como true para incluir células filtradas. Quando não especificado, o padrão é true.
ds.alias.range
Intervalo opcional, por exemplo: A1:B52.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é true. Consulte refreshFields para mais detalhes.

Exemplos

Uma configuração do Planilhas Google:

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437

Uma configuração do Planilhas Google com a primeira linha usada como cabeçalho e células ocultas e filtradas incluídas:

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437
  &ds.ds3.hasHeader=true
  &ds.ds3.includeHiddenCells=true
  &ds.ds3.includeFilteredCells=true

Uma configuração do Planilhas Google com um intervalo (A1:D20):

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437
  &ds.ds3.range=A1%3AD20

Looker

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como looker para o conector do Looker.

Se definido, substitui a fonte de dados pela configuração do Looker fornecida. Consulte Substituir x atualizar.
ds.alias.instanceUrl
Obrigatório**: o URL da instância do Looker.
ds.alias.model
Obrigatório**: o modelo do Looker.
ds.alias.explore
Obrigatório**: a análise detalhada do Looker.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é false. Consulte refreshFields para mais detalhes.

Exemplo

Conecte-se a uma Análise do Looker:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=looker
  &ds.ds5.instanceUrl=my.looker.com
  &ds.ds5.model=thelook
  &ds.ds5.explore=orders

Search Console

Nome do parâmetro Descrição
ds.alias.connector
Opcional. Defina como searchConsole para o conector do Search Console.

Se definido, substitui a fonte de dados pela configuração do Search Console fornecida. Consulte Substituir x atualizar.
ds.alias.siteUrl
Obrigatório**: o URL do site. Para uma propriedade do domínio, adicione o prefixo sc-domain\:.
ds.alias.tableType
Obrigatório**: define o tipo de tabela. Pode ser SITE_IMPRESSION ou URL_IMPRESSION.
ds.alias.searchType
Obrigatório**: define o tipo de pesquisa. Pode ser WEB, IMAGE, VIDEO ou NEWS.
ds.alias.refreshFields
Opcional. Quando não especificado, o padrão é false. Consulte refreshFields para mais detalhes.

Exemplo

Uma configuração do Search Console para uma propriedade de prefixo de URL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=searchConsole
  &ds.ds5.siteUrl=https%3A%2F%2Fwww.example.com%2Fwelcome
  &ds.ds5.tableType=SITE_IMPRESSION
  &ds.ds5.searchType=WEB

Uma configuração do Search Console para uma propriedade do domínio:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  ds.ds5.connector=searchConsole
  &ds.ds5.siteUrl=sc-domain%3Aexample.com
  &ds.ds5.tableType=SITE_IMPRESSION
  &ds.ds5.searchType=WEB

Permissões de modelo

Para garantir a melhor experiência aos usuários, é importante definir corretamente as permissões de acesso aos relatórios do modelo e das fontes de dados associadas. As permissões necessárias dependem de o modelo de relatório usar fontes de dados incorporadas ou reutilizáveis e de a configuração da API Linking estar definida para substituir ou atualizar uma configuração de fonte de dados.

A tabela a seguir mostra o acesso recomendado à fonte de dados para a melhor experiência do usuário com base nas fontes de dados do modelo e na configuração da API Linking:

Tipo de fonte de dados Configuração da API Linking para fonte de dados Recomendação para permissões de fonte de dados Observações
Incorporada Substituir Não aplicável. O acesso de visualização será herdado do relatório. Se o usuário tiver acesso de leitura ao relatório de modelo, ele também terá acesso de leitura a qualquer fonte de dados incorporada.
Incorporada Atualizar Não aplicável. O acesso de visualização será herdado do relatório. Se o usuário tiver acesso de leitura ao relatório de modelo, ele também terá acesso de leitura a qualquer fonte de dados incorporada.
Reutilizável Substituir Os usuários não precisam de acesso de leitura. Como a configuração da fonte de dados está sendo substituída por completo pela API Linking, não é necessário ter acesso à visualização.
Reutilizável Atualizar Os usuários precisam de acesso de leitura. O acesso de visualização à fonte de dados é necessário para que a API Linking possa ler e usar a configuração da fonte de dados do modelo. Se os usuários não tiverem acesso de leitura, eles vão receber um erro ao carregar o relatório.

Usar um relatório em branco ou padrão

Para usar um relatório em branco ou o relatório padrão, configure a API Linking da seguinte forma:

Tipo de relatório Definir o parâmetro de controle reportId Defina os parâmetros da fonte de dados (ds). Observações
Relatório em branco Não Não
Relatório padrão Não Sim

O relatório padrão é fornecido pelo Looker Studio.

Não é necessário usar um alias ao especificar parâmetros para o relatório padrão, já que ele tem uma única fonte de dados incorporada.

Os exemplos a seguir mostram vários URLs da API Linking que usam um relatório em branco ou padrão.

Inicie o fluxo de trabalho de criação de relatórios com um relatório em branco:

https://lookerstudio.google.com/reporting/create

Inicie o fluxo de trabalho de criação de relatórios com um relatório em branco e defina o nome dele:

https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport

Use o modelo de relatório padrão com uma configuração de conector do Google Planilhas:

https://lookerstudio.google.com/reporting/create?
  ds.connector=googleSheets
  &ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
  &ds.worksheetId=0

Incorporar um relatório

Para incorporar um relatório criado com a API Linking, defina os parâmetros de URL e inclua o caminho /embed/. Um URL de incorporação da API Linking precisa ter o seguinte formato:

https://lookerstudio.google.com/embed/reporting/create?parameters

Encontrar IDs e aliases

ID do relatório

Para encontrar o ID do relatório:

  1. Abra o relatório que você quer usar como modelo. Confira o URL do relatório. A parte entre reporting/ e /page é o ID do relatório. Por exemplo, no URL a seguir, 0B_U5RNpwhcE6SF85TENURnc4UjA é o ID do relatório:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Barra de endereço do navegador que mostra o URL de um relatório do Looker Studio.
            O ID do relatório está destacado.
Encontre o ID do relatório no URL do relatório.

Alias da fonte de dados

Um relatório pode ter várias fontes de dados, que precisam ser referenciadas pelo alias.

Para encontrar um alias de fonte de dados, faça o seguinte:

  1. Edite o relatório.
  2. Na barra de ferramentas, selecione Recurso > Gerenciar fontes de dados adicionadas.
  3. Confira a coluna Alias para encontrar informações de alias sobre cada fonte de dados.

É possível editar os nomes dos aliases para garantir a compatibilidade com versões anteriores quando uma fonte de dados for adicionada ou removida.

Uma lista de fontes de dados na página de gerenciamento de recursos.
            A coluna "Alias" está destacada.
Encontre o alias da fonte de dados na página de gerenciamento Fontes de dados.

Tipo de conector

Um relatório pode ter várias fontes de dados, cada uma criada com a configuração de um conector. Para encontrar o tipo de conector usado para criar uma fonte de dados, faça o seguinte:

  1. Edite o relatório.
  2. Na barra de ferramentas, selecione Recurso > Gerenciar fontes de dados adicionadas.
  3. Confira a coluna Tipo de conector para identificar o conector usado na criação de uma fonte de dados.
Uma lista de fontes de dados na página de gerenciamento de recursos.
            A coluna "Tipo de conector" está destacada.
Encontre o tipo de conector de fonte de dados na página de gerenciamento Fontes de dados.

Dicas e solução de problemas

Se você estiver com problemas, confira os detalhes abaixo para identificar possíveis problemas e erros de configuração comuns.

Caixa de diálogo de depuração

Use a caixa de diálogo de depuração para analisar a configuração da API Linking conforme interpretada pelo Looker Studio. Isso pode ajudar a depurar problemas com a API.

  • Quando um erro é encontrado durante a análise do URL da API Linking, uma caixa de diálogo é exibida automaticamente com detalhes sobre o erro.
  • Quando um erro ocorre e nenhuma caixa de diálogo é mostrada automaticamente, procure o botão de informações na parte de cima à direita do relatório. Clique para mais informações de depuração.
    Um botão de informações para saber como um relatório foi criado.
  • Se nenhum botão de informações estiver disponível, adicione o parâmetro &c.explain=true ao final de qualquer URL da API Linking para ativar o botão.

Permissões

Verifique se você tem as permissões de modelo corretas definidas para os tipos de fonte de dados e a configuração da API Linking. Consulte Permissões de modelo para mais detalhes.

Atualizar x substituir

Se você estiver atualizando uma configuração de fonte de dados de um modelo, revise a configuração da fonte de dados do modelo e a configuração da API Linking para garantir que elas sejam compatíveis. Confirme se os campos gerados pela nova configuração são compatíveis com os componentes e a configuração do relatório.

Ao realizar uma atualização em vez de uma substituição, é possível definir uma configuração inválida com comportamento indefinido. Consulte Substituir x atualizar para mais detalhes.

Atualizar campos

Se você tiver configurado nomes de campos, tipos ou agregações para uma fonte de dados de modelo, essas mudanças só serão transferidas para uma fonte de dados configurada pela API Linking se o parâmetro ds.refreshFields estiver definido como false.

Analise o parâmetro de fonte de dados ds.refreshFields do URL da API Linking. Se omitido, confirme se o valor padrão do parâmetro para cada tipo de conector está correto para seu caso de uso.

Em geral, se você configurou campos na fonte de dados do modelo e tem certeza de que as novas configurações de fonte de dados pela API Linking sempre vão gerar os mesmos campos, é recomendável definir refreshFields como false.

Por exemplo, se durante a criação de um modelo de relatório, o Looker Studio identificar um campo de fonte de dados específico como do tipo Número e você mudar para o tipo Ano, essa mudança na configuração do campo agora fará parte da fonte de dados do modelo. Qualquer gráfico no modelo de relatório que use o campo corrigido vai esperar um Ano. Se o gráfico for baseado em tempo, ele poderá não ser renderizado de outra forma. Se a API Linking for usada para fornecer uma nova configuração de fonte de dados que gere exatamente os mesmos campos, haverá dois resultados com base no valor do parâmetro refreshFields:

  • Se definido como true, a configuração de campo da fonte de dados do modelo não será transferida, e os gráficos poderão não carregar se dependerem da mesma configuração de campo (ou seja, um campo do tipo Ano é esperado).

  • Se definido como false, a configuração de campo da fonte de dados do modelo será transferida para a nova fonte, e os gráficos do relatório vão receber os mesmos campos com a mesma configuração e serão carregados corretamente.

Feedback e suporte

Use o Issue Tracker para relatar problemas com a API Linking ou enviar feedback. Consulte Suporte para recursos gerais sobre como receber ajuda e fazer perguntas.

Registro de alterações

2023-06-06

  • Adicionamos os parâmetros de relatório r.measurementId e r.keepMeasurementId para configurar a definição de relatório IDs de métricas do Google Analytics.
  • Adição de ds.keepDatasourceName para controlar a reutilização do nome da fonte de dados do modelo.
  • Adicionamos uma seção Incorporar relatório.
  • Conector do BigQuery
    • Adicionado sqlReplace. Permite especificar padrões e strings de substituição para atualizar a consulta SQL da fonte de dados do modelo.

2023-05-22

2022-11-21

2022-11-14

2022-06-15

  • Fora da versão Beta
    • A API Integration foi renomeada como API Linking.
    • A API Linking saiu da versão Beta.
  • Adicionamos o parâmetro de controle pageId para permitir a vinculação a uma página de relatório específica.
  • Adição do parâmetro de controle mode para definir o estado do relatório como modo Visualizar ou Editar no carregamento.
  • Agora é possível substituir totalmente ou atualizar parcialmente as configurações das fontes de dados. Esse comportamento é determinado pela definição do parâmetro ds.connector. Consulte Substituir x atualizar para mais detalhes.
  • Agora, um modelo padrão é usado se um modelo de relatório não for fornecido com o parâmetro c.reportId.
  • Adicionamos o parâmetro de fonte de dados ds.refreshFields. Isso permite controlar se os campos da fonte de dados são atualizados ao carregar uma configuração de fonte de dados.
  • Conector do BigQuery
    • projectId não é obrigatório quando type está definido como CUSTOM_QUERY.
    • Quando billingProjectId não está definido, o projeto de faturamento volta para projectId ou o projeto da tabela consultada.
    • Adição de suporte para tabelas particionadas por data. Defina o parâmetro isPartitioned como true para usar o campo de partição como uma dimensão de período.
    • Agora é possível consultar tabelas particionadas por data usando o caractere curinga ou o sufixo de tabela YYYYMMDD.
    • Adicionamos suporte para consultar tabelas do Google Analytics, do Firebase Analytics ou do Crashlytics e selecionar um modelo de campos.
  • Planilhas Google
    • hasHeader tem como padrão true, consistente com o padrão da interface da Web.
    • includeHiddenAndFilteredCell dividido em includeHiddenCells e
    • includeFilteredCells. Agora, os dois usam true por padrão, o que é consistente com o padrão da interface da Web.
  • Conector do Search Console
    • O parâmetro propertyType foi renomeado como searchType.
  • Conector do Surveys
    • O surveyId agora aceita um único ID de pesquisa ou uma lista separada por vírgulas de IDs de pesquisa.

2021-12-16

  • Versão inicial da API Integration.
    • É compatível com a vinculação a um relatório atual e a definição do nome do relatório.
    • É possível configurar várias fontes de dados e definir o nome de cada uma.
    • Suporte para os seguintes tipos de conector: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Planilhas Google, Google Surveys e Search Console.