Introducción
La API de Linking proporciona una interfaz confiable para configurar y reenviar a los usuarios directamente a un informe de Looker Studio a través de una URL. Cuando los usuarios sigan una URL de la API de Linking, tendrán una experiencia optimizada para ver sus datos e interactuar con ellos rápidamente.
En este documento, se describe el formato requerido para las URLs de la API de vinculación y los parámetros disponibles.
Caso de uso y beneficios
La API de Linking se puede usar para proporcionar informes preconfigurados a fin de que tus clientes los vean y también interactúen con sus datos. Los beneficios clave de la API de Linking son los siguientes:
- Una experiencia de creación de informes con un solo clic para sus clientes.
- La configuración de datos se proporciona en la URL para que los usuarios no necesiten configurar el informe para sus datos.
- Los usuarios pueden guardar el informe con un solo clic y volver a verlo en cualquier momento.
- Crea informes a gran escala. La API de Linking reduce el tiempo necesario para duplicar o crear informes nuevos.
- Habilita las integraciones de productos. La interfaz estable te permite integrar Looker Studio en el flujo de trabajo de un producto.
Cómo funciona
A continuación, se describe cómo interactúan los desarrolladores y los usuarios con la API de Linking.
Vincula el flujo de trabajo de desarrolladores de API
El desarrollador prepara los informes de la plantilla y las fuentes de datos, y les da formato a una URL de la API de vinculación. El flujo de trabajo típico de los desarrolladores es el siguiente:
- Decide si usar un informe en blanco, la plantilla de informes predeterminada que proporciona Looker Studio, o bien crea un informe de Looker Studio que sirva como plantilla. Esto incluye la configuración de las fuentes de datos de la plantilla.
- Da formato a una URL de API de vinculación según tu caso de uso específico. Si corresponde, especifica la plantilla del informe y otros parámetros, incluido el nombre del informe, el nombre de la fuente de datos y la configuración de la fuente de datos.
- Usa la URL de la API de vinculación para dirigir a los usuarios al informe.
Vincula la experiencia del usuario de la API
El usuario sigue una URL de la API de vinculación que, si el desarrollador la configura correctamente, lo dirigirá a un informe de Looker Studio que le permitirá ver los datos a los que tiene acceso y también interactuar con ellos. Una experiencia del usuario típica puede ser la siguiente:
- En un navegador, el usuario visita un servicio que se integró en la API de Linking.
- Un llamado a la acción invita al usuario a hacer clic en un vínculo para ver sus datos en Looker Studio.
- El usuario sigue el vínculo y se lo dirige a un informe de Looker Studio. Se carga el informe y el usuario puede ver sus datos e interactuar con ellos.
- El usuario hace clic en “Editar y compartir”. El informe se guarda en su cuenta de Looker Studio.
- Ahora el usuario tiene acceso y control totales sobre su propia copia del informe. Pueden ver, editar y compartir en cualquier momento.
Requisitos
Para garantizar que una URL de la API de vinculación funcione como se espera, se requiere lo siguiente:
- Un informe, que se usa como plantilla Si no se proporciona, se puede usar un informe en blanco o un informe predeterminado que proporciona Looker Studio.
- Los usuarios de una URL de API de vinculación deben tener, como mínimo, acceso de lectura al informe de la plantilla. Según el tipo de fuentes de datos que se usen en el informe y la configuración proporcionada a través de la API de Linking, es posible que los usuarios también requieran acceso de lectura a las fuentes de datos. Consulta Permisos de plantilla para obtener más detalles.
- El tipo de conector de cada fuente de datos debe admitir la configuración mediante la API de vinculación. Consulta la Referencia de conectores para obtener una lista de conectores compatibles.
- Los usuarios de la URL de la API de vinculación deben tener acceso a los datos configurados en esa URL. Si el usuario no tiene acceso a los datos subyacentes, cualquier componente de informe dependiente mostrará un error.
Parámetros de URL
Una URL de API de vinculación debe tener el siguiente formato:
https://lookerstudio.google.com/reporting/create?parameters
Se espera que la URL se use en el contexto de un navegador web, por lo general, cuando el usuario hace clic en un vínculo o se redirecciona a la URL. También se puede usar para incorporar un informe.
URL de ejemplo
El siguiente es un ejemplo de URL de API de vinculación. Se establece el nombre del informe y se configura una única fuente de datos de BigQuery:
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
Algunos parámetros de URL son obligatorios, mientras que otros son opcionales. La siguiente es una lista de los parámetros que se usan para definir una URL de API de vinculación:
Parámetros de control
Los parámetros de control determinan el estado del informe cuando se visualizan a través de la URL de la API de vinculación.
Nombre del parámetro | Descripción |
---|---|
Opcional. El ID de informe de la plantilla. Looker Studio abrirá y configurará el informe especificado. Para obtener detalles sobre cómo encontrar el ID, consulta ID de denuncia. Si no se especifica, se usa un informe en blanco o una plantilla de informe predeterminada. Consulta Cómo usar un informe en blanco o predeterminado para obtener más detalles. | |
Opcional. Es el ID de la página inicial que se cargará en el informe. El valor predeterminado es la primera página del informe si no se especifica. | |
Opcional. El modo de informes inicial Uno de los siguientes:
view o
edit . Si no se especifica, el valor predeterminado es view .
|
|
Opcional. La visibilidad del diálogo de información y depuración. Configúralo en true para mostrar el botón de diálogo. Si no se especifica, el valor predeterminado es false . Consulta
Cómo solucionar problemas de configuración para obtener más información.
|
Ejemplo
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 del informe
Los parámetros del informe anulan las propiedades del informe.
Nombre del parámetro | Descripción |
---|---|
Opcional. Establece el nombre del informe. Si no se especifica, se establece de forma predeterminada el nombre del informe de la plantilla. | |
Opcional. Configura los IDs de medición de Google Analytics en Medir el uso de los informes. Usa comas para separar los diferentes IDs. Si no se especifican |
|
Opcional. Configúralo en Si no se especifican |
Ejemplo
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 de la fuente de datos
Los parámetros de la fuente de datos te permiten definir una configuración de fuente de datos y los datos a los que se accederá para las fuentes de datos en el informe de plantillas.
Se usa un alias
para hacer referencia a una fuente de datos en un informe existente. El uso de un alias permite la retrocompatibilidad si se agrega o quita una fuente de datos del informe de plantilla.
Para obtener detalles sobre cómo encontrar una fuente de datos alias
, consulta Alias de la fuente de datos.
Parámetros de la fuente de datos
Los siguientes parámetros son comunes en todos los tipos de conectores:
Nombre | Descripción |
---|---|
Opcional. Establece el nombre de la fuente de datos. Si no se especifican |
|
Opcional. Configúralo en Si no se especifican |
|
Opcional.
El tipo de conector de la fuente de datos. Para obtener más información sobre los tipos de conectores compatibles, consulta la Referencia de conectores. Si se configura, se deben especificar todos los parámetros de conector obligatorios para el tipo de conector en la URL de la API de vinculación y se reemplazará por completo la configuración de la fuente de datos de la plantilla. Si no se especifica, se pueden especificar cero o más parámetros de conector para el tipo de conector en la URL de la API de vinculación. La configuración de la fuente de datos de la plantilla se usará para especificar cualquier parámetro que no se proporcione en la URL de la API de vinculación. Para obtener detalles sobre cómo identificar el tipo de conector de la fuente de datos de la plantilla, consulta Tipo de conector. A fin de obtener más información sobre cómo el parámetro |
|
Opcional.
Configúralo en Configúralo en Si no se especifica, los valores predeterminados varían según el tipo de conector. Consulta la Referencia del conector para conocer los valores predeterminados específicos del conector en caso de que quieras anular el comportamiento predeterminado. Consideraciones para cuando usas
refreshFields :
|
|
Obligatorio: Es la configuración de la fuente de datos para el tipo de conector. Si quieres obtener detalles sobre cómo identificar el conector que se usa para crear una fuente de datos, consulta Tipo de conector. Si deseas obtener detalles sobre los parámetros de la fuente de datos disponibles para cada tipo de conector, consulta la Referencia de conectores. |
Reemplazar vs. actualizar: Configuraciones de fuentes de datos
Cuando configuras los parámetros de la fuente de datos, la presencia o la omisión del parámetro ds.connector
en la URL de la API de vinculación indica la intención de reemplazar o actualizar la configuración de la fuente de datos de la plantilla, respectivamente.
En la siguiente tabla, se detalla cómo el parámetro ds.connector
afecta si la configuración de una fuente de datos de plantilla se reemplaza por completo o se usa para actualizar parámetros no especificados:
¿Se configuró ds.connector ? |
Configuración y comportamiento esperados | Uso típico |
---|---|---|
Sí |
Reemplazar. La configuración de la fuente de datos de la plantilla se reemplaza por completo con los parámetros de la fuente de datos especificados en la URL de la API de vinculación. Debes especificar todos los parámetros obligatorios para el tipo de conector. Consulta Parámetros obligatorios cuando se configura ds.connector .
|
|
No | Actualizar. La configuración de la fuente de datos de la plantilla se usará para
especificar cualquier parámetro que no se proporcione en la URL de la API de vinculación. Todos los parámetros
del conector para el tipo de conector son opcionales, a menos que se indique lo contrario.
Esto simplifica la URL de la API de vinculación y, por lo general, se recomienda cuando estás familiarizado con la configuración de la fuente de datos de la plantilla y solo deseas anular un subconjunto de parámetros. |
|
Parámetros obligatorios cuando se establece ds.connector
Si se especifica el parámetro ds.connector
de una fuente de datos, se deben especificar todos los parámetros del conector designados como Obligatorio para la fuente de datos. Si no se especifica el parámetro ds.connector
de la fuente de datos, todos los parámetros del conector, incluso los designados como obligatorios, se pueden tratar como opcionales, a menos que se indique lo contrario.
Ejemplos
Configura un informe con una sola fuente de datos de BigQuery (ds0
) y reemplaza por completo la configuración de la fuente de datos:
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
El alias de la fuente de datos se puede omitir cuando el informe tiene una sola fuente de datos. La URL anterior se puede simplificar de la siguiente manera:
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 un informe con una sola fuente de datos de BigQuery (ds0
) y actualiza solo el ID del proyecto de facturación de la fuente de datos:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.billingProjectId=my-billing-project
Configura un informe con dos fuentes de datos: una de BigQuery (ds0
) y una de Google Analytics (ds1
). La configuración de la fuente de datos de BigQuery se reemplaza por completo, mientras que la configuración de Google Analytics actualiza un solo parámetro y se basa en la fuente de datos de la plantilla ds1
para cualquier parámetro del conector no especificado:
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
Crear en comparación con agregar
A veces, puede ser útil tener la misma fuente de datos en varios informes para que las actualizaciones de la fuente de datos afecten a todos los informes juntos. Cuando creas un informe con la API de Linking, puedes volver a agregar una fuente de datos desde tu informe de plantilla si te aseguras de que se cumplan todas las condiciones siguientes:
- La fuente de datos es reutilizable (consulta Fuentes de datos incorporadas y reutilizables).
- La URL no hace referencia a la fuente de datos por alias.
- La URL no usa un alias comodín (consulta Comodín de alias de la fuente de datos).
Cuando se crea una fuente de datos nueva con la API de vinculación, esta usa las credenciales del usuario que hizo clic en la URL. Esto significa que el usuario debe tener acceso a los datos subyacentes; de lo contrario, la conexión no funcionará. Si vuelves a agregar la fuente de datos al informe recién generado, puedes conservar sus credenciales para que los usuarios puedan seguir accediendo a los datos en sus informes nuevos.
Comodín de alias de la fuente de datos
Para aplicar un parámetro de la API de vinculación a varias fuentes de datos, se puede usar el alias comodín ds.*
en lugar del alias de la fuente de datos.
Esto puede ser útil para quitar parámetros repetitivos de tu URL. Por ejemplo, si tienes una plantilla con tres fuentes de datos de BigQuery adjuntas y deseas reemplazar projectId
y datasetId
en cada una, pero conservar tableId
, puedes escribirla de la siguiente manera:
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
O bien, con el comodín ds.*
, puedes usar esta URL equivalente:
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
Los parámetros proporcionados a la API de Linking que no usan el comodín ds.*
tienen
prioridad sobre los que sí lo tienen. En el ejemplo anterior, puedes agregar un alias de fuente de datos específico para anular el valor del comodín.
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
En términos más generales, el orden de prioridad de los parámetros es el siguiente:
- Un parámetro proporcionado con un alias específico (
ds.ds1.datasetId
) - Un parámetro proporcionado con el comodín (
ds.*.datasetId
) - Un valor derivado de la fuente de datos de la plantilla, si no se proporciona ds.connector (consulta Reemplazar frente a actualizar)
- El valor predeterminado del parámetro, si es opcional.
Referencia del conector
La API de Linking admite los siguientes conectores y configuraciones. Para cada conector, se proporciona la lista de parámetros de fuente de datos disponibles.
BigQuery
El conector de BigQuery admite dos tipos de consultas, una consulta TABLE
, en la que proporcionas el ID de la tabla que deseas consultar y un CUSTOM_QUERY
, en el que proporcionas una instrucción de SQL para consultar una tabla.
Consultas TABLE
Los siguientes parámetros se aplican cuando type
se establece en TABLE
y proporcionas el ID de la tabla que se debe consultar.
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo como bigQuery para el conector de BigQuery.Si se establece, reemplaza la fuente de datos por la configuración de BigQuery proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** Indica el tipo de consulta. Se establece en TABLE . |
|
Obligatorio** El ID del proyecto de la tabla que se consultará. | |
Obligatorio** El ID del conjunto de datos de la tabla que se consultará. | |
Obligatorio** El ID de tabla de la tabla que se consultará. Tablas fragmentadas por fecha: Se admite el sufijo * (carácter comodín) o YYYYMMDD cuando se consultan tablas fragmentadas por fecha.Si una tabla se identifica como Google Analytics, Firebase Analytics o Firebase Crashlytics, se seleccionará una plantilla de campos predeterminada, a menos que se especifique una. Consulta los parámetros relacionados con la tabla de la plantilla de campos. |
|
Opcional. Es el ID del proyecto que se usará para la facturación. Si no se establece, se usará projectId . |
|
Opcional. Configúralo en true si la tabla está particionada y deseas usar la columna de partición como una dimensión de período. Esto solo es aplicable a la partición basada en el tiempo (p.ej., con una columna de partición basada en el tiempo o la seudocolumna _PARTITIONTIME ) y no funciona para tablas particionadas por rango de números enteros. Si no se especifica, el valor predeterminado es false . Para obtener más información, consulta
Introducción a las tablas con particiones. |
|
Opcional. Si no se especifica, el número predeterminado es true . Para obtener más información, consulta refreshFields. |
Plantilla de campos para Google Analytics, Firebase Analytics y Crashlytics
En las tablas identificadas como Google Analytics, Firebase Analytics o Firebase Crashlytics, hay parámetros adicionales disponibles para configurar la plantilla de campos. Si no se especifica, se seleccionará una plantilla predeterminada.
Nombre | Descripción |
---|---|
Opcional. La plantilla de campos de Google Analytics que se usará. Solo se aplica
cuando se consulta una tabla de BigQuery Export para Google Analytics. Uno de ALL , SESSION o HITS . En las tablas de Google Analytics, el valor predeterminado es ALL si no se especifica. |
|
Opcional. La plantilla de campos de Firebase Analytics que se usará. Solo se aplica
cuando se consulta una tabla de BigQuery Export para Firebase Analytics.
Solo se puede establecer en EVENTS . En las tablas de Firebase Analytics,
el valor predeterminado es EVENTS si no se especifica. |
|
La plantilla de campos de Firebase Crashlytics para usar. Solo se puede establecer en
DEFAULT . Solo se aplica cuando se realizan consultas en una tabla de BigQuery Export para Firebase
Crashlytics. En las tablas de Firebase Crashlytics,
la configuración predeterminada es DEFAULT si no se especifica. |
Consultas CUSTOM
Los siguientes parámetros se aplican cuando type
se establece en CUSTOM_QUERY
y proporcionas una instrucción de SQL para consultar una tabla.
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo como bigQuery para el conector de BigQuery.Si se establece, reemplaza la fuente de datos por la configuración de BigQuery proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** Indica el tipo de consulta. Se establece en CUSTOM_QUERY . |
|
Obligatorio** La consulta de SQL que se ejecutará. | |
Opcional. Es el ID del proyecto que se usará para la facturación. Si no se establece, se usará projectId . Si projectId no está configurado, se usará el proyecto de la tabla consultada. |
|
Opcional. Una lista delimitada por comas de strings de patrón y de reemplazo para aplicar a la consulta de SQL. El reemplazo de strings solo se aplica si hay una coincidencia de patrón. Usa una coma para separar los pares de strings de patrones y reemplazos. Por ejemplo, |
|
Opcional. Si no se especifica, el número predeterminado es true . Para obtener más información, consulta refreshFields. |
Ejemplos
Una configuración de tipo TABLE
en la que la consulta se define con un ID de tabla:
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
Una configuración de tipo TABLE
para consultar una tabla fragmentada por fecha con el sufijo de caracteres comodín:
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_*
Una configuración de tipo TABLE
para consultar una tabla fragmentada por fecha con el sufijo 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
Una configuración de tipo TABLE
a fin de consultar una tabla de BigQuery Export para Google Analytics
mediante la plantilla 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
Una configuración de tipo TABLE
para consultar una tabla particionada por tiempo de transferencia y usar la columna de partición como una dimensión 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
Una configuración de tipo CUSTOM_QUERY
en la que la consulta se define con una instrucción de 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
Una configuración de tipo CUSTOM_QUERY
en la que solo se actualiza la instrucción de SQL y la fuente de datos de la plantilla se usa para el resto de la configuración:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60
Una configuración de tipo CUSTOM_QUERY
en la que la instrucción de SQL de la fuente de datos de la plantilla se actualiza con 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
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo en cloudSpanner para el conector de Cloud Spanner.Si se establece, reemplaza la fuente de datos por la configuración de Cloud Spanner proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** Es el ID del proyecto. | |
Obligatorio** El ID de la instancia. | |
Obligatorio** El ID de la base de datos. | |
Obligatorio** La consulta de SQL que se ejecutará. | |
Opcional. Si no se especifica, el número predeterminado es true .
Para obtener más información, consulta refreshFields. |
Ejemplo
Una configuración de Cloud Spanner con una instrucción de 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 de la comunidad
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo como community para un Conector de la comunidad.Si se establece, se reemplaza la fuente de datos por la configuración proporcionada del conector de comunidad. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** El conector de la comunidad connectorId (también conocido como deploymentId ).
| |
Opcional. Parámetros adicionales específicos del conector, tal como se define en la configuración del conector de la comunidad | |
Opcional. Si no se especifica, el número predeterminado es true . Para obtener más información, consulta refreshFields. |
Ejemplo
Conéctate a un conector de comunidad con los parámetros de configuración state
y 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
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo en googleAnalytics para el conector de Google Analytics.Si se establece, se reemplaza la fuente de datos por la configuración de Google Analytics proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio**: Es el ID de la cuenta. | |
Obligatorio**: Es el ID de propiedad. | |
El ID de vista. Obligatorio** para las propiedades Universal Analytics. No se debe configurar para las propiedades Google Analytics 4. |
|
Opcional. Si no se especifica, el número predeterminado es false . Para obtener más información, consulta refreshFields. |
Ejemplos
Una configuración de Google Analytics para una propiedad 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
Una configuración de Google Analytics para una propiedad 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
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo como googleCloudStorage
Conector de Google Cloud Storage.Si se establece, se reemplaza la fuente de datos por la configuración de Google Cloud Storage proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** Es el tipo de ruta de acceso. Usa FILE para seleccionar un solo archivo o FOLDER para seleccionar todos los archivos de la ruta de acceso determinada. |
|
Obligatorio** La ruta de acceso del archivo (p.ej., MyBucket/MyData/MyFile.csv) si pathType es FILE o la ruta de acceso de la carpeta (p.ej., *MyBucket/MyData) si pathType es FOLDER . |
|
Opcional. Si no se especifica, el número predeterminado es true .
Para obtener más información, consulta refreshFields. |
Ejemplo
Una configuración de Google Cloud Storage para un solo archivo:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FILE
&ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv
Una configuración de Google Cloud Storage para todos los archivos en la ruta:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FOLDER
&ds.ds50.path=MyBucket%2FMyData
Hojas de cálculo de Google
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo en googleSheets para el conector de Hojas de cálculo de Google.Si se establece, se reemplaza la fuente de datos por la configuración proporcionada de Hojas de cálculo de Google. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** El ID de la hoja de cálculo. | |
Obligatorio** El ID de la hoja de cálculo. | |
Opcional. Configúralo en true para usar la primera fila como encabezados.
Si no se especifica, el valor predeterminado es true . Los encabezados de columna deben ser
únicos. Las columnas con encabezados vacíos no se agregarán a la fuente de datos.
|
|
Opcional. Configúralo en true para incluir celdas ocultas.
Si no se especifica, el valor predeterminado es true . |
|
Opcional. Configúralo en true para incluir las celdas filtradas.
Si no se especifica, el valor predeterminado es true . |
|
Opcional. Rango, p.ej., A1:B52. | |
Opcional. Si no se especifica, el número predeterminado es true . Para obtener más información, consulta refreshFields. |
Ejemplos
Una configuración de Hojas de cálculo de Google:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
Una configuración de Hojas de cálculo de Google con la primera fila utilizada como encabezado y celdas ocultas y filtradas incluidas:
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
Una configuración de Hojas de cálculo de Google con un rango (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
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo en looker para el
conector de Looker.Si se establece, se reemplaza la fuente de datos por la configuración de Looker proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio**: La URL de la instancia de Looker. | |
Obligatorio** El modelo de Looker | |
Obligatorio** La exploración de Looker. | |
Opcional. Si no se especifica, el número predeterminado es false . Para obtener más información, consulta refreshFields. |
Ejemplo
Cómo conectarse a Looker Explore:
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
Nombre del parámetro | Descripción |
---|---|
Opcional. Configúralo en searchConsole para el conector de Search Console.Si se establece, reemplaza la fuente de datos por la configuración de Search Console proporcionada. Consulta Comparación entre reemplazar y actualizar. |
|
Obligatorio** La URL del sitio. Para una Propiedad de dominio, usa el prefijo sc-domain\: . |
|
Obligatorio** Establece el tipo de tabla. Puede ser SITE_IMPRESSION o URL_IMPRESSION . |
|
Obligatorio** Establece el tipo de búsqueda. Puede ser WEB , IMAGE , VIDEO o NEWS . |
|
Opcional. Si no se especifica, el número predeterminado es false . Para obtener más información, consulta refreshFields. |
Ejemplo
Una configuración de Search Console para una propiedad de prefijo 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
Una configuración de Search Console para una Propiedad de dominio:
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
Permisos de plantilla
A fin de garantizar la mejor experiencia para los usuarios, es importante configurar correctamente los permisos de acceso a los informes para el informe de la plantilla y las fuentes de datos asociadas. Los permisos necesarios dependen de si la plantilla de informe usa fuentes de datos incorporadas o reutilizables y de si la configuración de la API de Linking está establecida para reemplazar o actualizar una configuración de fuente de datos.
En la siguiente tabla, se proporciona el acceso recomendado a la fuente de datos para la experiencia del usuario óptima en función de las fuentes de datos de la plantilla y la configuración de la API de Linking:
Tipo de fuente de datos | Vincular la configuración de la API para la fuente de datos | Recomendación para permisos de fuente de datos | Notas |
---|---|---|---|
Incorporados | Reemplaza los siguientes elementos: | N/A: El acceso de lectura se heredará del informe. | Si el usuario tiene acceso de lectura al informe de plantillas, automáticamente tendrá acceso de lectura a cualquier fuente de datos incorporada. |
Incorporados | Actualizar | N/A: El acceso de lectura se heredará del informe. | Si el usuario tiene acceso de lectura al informe de plantillas, automáticamente tendrá acceso de lectura a cualquier fuente de datos incorporada. |
Se puede reutilizar | Reemplaza los siguientes elementos: | Los usuarios no necesitan acceso de lectura. | Dado que la configuración de la fuente de datos se reemplaza por completo a través de la API de Linking, no se requiere acceso de lectura. |
Se puede reutilizar | Actualizar | Los usuarios requieren acceso de lectura. | Se requiere acceso de lectura a la fuente de datos para que la API de Linking pueda leer y usar la configuración de la fuente de datos de la plantilla. Si los usuarios no tienen acceso de lectura, recibirán un error cuando carguen el informe. |
Utiliza un informe en blanco o predeterminado
Para usar un informe en blanco o el informe predeterminado, configura la API de Linking de la siguiente manera:
Tipo de informe | Establece el parámetro de control reportId . |
Configura los parámetros de la fuente de datos ( ). |
Notas |
---|---|---|---|
Informe en blanco | No | No | |
Informe predeterminado | No | Sí | Looker Studio proporciona el informe predeterminado. No es necesario usar un alias de fuente de datos cuando se especifican parámetros de fuente de datos para el informe predeterminado, ya que el informe predeterminado tiene una sola fuente de datos incorporada. |
En los siguientes ejemplos, se muestran varias URLs de la API de vinculación que usan un informe en blanco o predeterminado.
Inicia el flujo de trabajo de creación de informes con un informe en blanco:
https://lookerstudio.google.com/reporting/create
Inicia el flujo de trabajo de creación de informes con un informe en blanco y establece el nombre del informe:
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Usa la plantilla de informes predeterminada con una configuración de conector de Hojas de cálculo de Google:
https://lookerstudio.google.com/reporting/create?
ds.connector=googleSheets
&ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
&ds.worksheetId=0
Cómo incorporar un informe
Para incorporar un informe creado con la API de vinculación, configura parámetros de URL y, luego, incluye la ruta /embed/
. Una URL de incorporación de la API de vinculación debe tener el siguiente formato:
https://lookerstudio.google.com/embed/reporting/create?parameters
Cómo buscar IDs y alias
ID de informe
Para encontrar el ID del informe, sigue estos pasos:
- Abra el informe que desea utilizar como plantilla. Inspecciona la URL del informe. La parte entre
reporting/
y/page
es el ID del informe. Por ejemplo, en la siguiente URL,0B_U5RNpwhcE6SF85TENURnc4UjA
es el ID del informe:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
![Barra de direcciones del navegador que muestra la URL de un informe de Looker Studio.
El ID del informe está destacado.](https://developers.google.cn/static/looker-studio/integrate/images/reportId-parameter.png?authuser=8&hl=es)
Alias de la fuente de datos
Un informe puede tener varias fuentes de datos. Se debe hacer referencia a una fuente de datos mediante su alias.
Para encontrar un alias de fuente de datos, haz lo siguiente:
- Edita el informe.
- En la barra de herramientas, selecciona Recurso > Administrar fuentes de datos agregadas.
- Examina la columna Alias para encontrar información de alias para cada fuente de datos.
Puedes editar los nombres de alias para garantizar la retrocompatibilidad cuando se agrega o quita una fuente de datos.
![Una lista de fuentes de datos en la página de administración de recursos de Fuente de datos.
Se destaca la columna Alias.](https://developers.google.cn/static/looker-studio/integrate/images/data-source-alias.png?authuser=8&hl=es)
Tipo de conector
Un informe puede tener varias fuentes de datos, cada una creada mediante la configuración de un conector. Para buscar el tipo de conector que se usa para crear una fuente de datos, haz lo siguiente:
- Edita el informe.
- En la barra de herramientas, selecciona Recurso > Administrar fuentes de datos agregadas.
- Verifica la columna Tipo de conector a fin de identificar el conector utilizado para crear una fuente de datos.
![Una lista de fuentes de datos en la página de administración de recursos de Fuente de datos.
Se destaca la columna Tipo de conector.](https://developers.google.cn/static/looker-studio/integrate/images/data-source-connector.png?authuser=8&hl=es)
Sugerencias y solución de problemas
Si tienes problemas, revisa los detalles a continuación para identificar posibles problemas y errores de configuración comunes.
Diálogo de depuración
Usa el diálogo de depuración para revisar la configuración de la API de vinculación tal como la interpreta Looker Studio. Puede ser útil para depurar problemas con la API.
- Cuando se encuentre un error durante el análisis de la URL de la API de vinculación, se mostrará automáticamente un diálogo con los detalles del error.
- Cuando se produce un error y no se muestra ningún diálogo automáticamente, busca el botón de información en la parte superior derecha del informe. Haz clic para obtener
información de depuración adicional.
- Si no hay un botón de información disponible, puedes habilitarlo agregando el parámetro
&c.explain=true
al final de cualquier URL de la API de vinculación.
Permisos
Asegúrate de tener configurados los permisos de plantilla correctos para los tipos de fuente de datos y la configuración de la API de Linking. Consulta Permisos de plantilla para obtener más detalles.
Actualizar frente a reemplazar
Si actualizas la configuración de una fuente de datos desde una plantilla de fuente de datos, revisa la configuración de la fuente de datos de la plantilla y la configuración de la API de vinculación para asegurarte de que sean compatibles. Confirma que los campos generados a partir de la configuración nueva sean compatibles con los componentes y la configuración del informe.
Cuando se realiza una actualización o un reemplazo, es posible establecer una configuración no válida con comportamiento indefinido. Consulta Comparación entre reemplazar y actualizar para obtener más detalles.
Actualizar campos
Si configuraste nombres de campos, tipos o agregaciones para una fuente de datos de plantilla, estos cambios solo se transferirán a una fuente de datos configurada con la API de vinculación si el parámetro ds.refreshFields
se establece en false
.
Revisa el parámetro de fuente de datos ds.refreshFields
de la URL de la API de vinculación. Si se omite, confirma que el valor predeterminado del parámetro para cada tipo de conector sea el correcto en tu caso de uso.
Por lo general, si configuraste campos en la fuente de datos de la plantilla y estás seguro de que las configuraciones nuevas de la fuente de datos a través de la API de Linking siempre generarán los mismos campos, se recomienda configurar refreshFields
como false
.
Por ejemplo, si durante la creación de una plantilla de informe, Looker Studio identifica un campo de fuente de datos en particular como de tipo Number y lo cambias a Year, este cambio de configuración del campo ahora es parte de la fuente de datos de la plantilla. Cualquier gráfico de la plantilla de informe que use el campo corregido esperará un Year y, si el gráfico está basado en el tiempo, es posible que no se renderice. Si
la API de Linking se usa para proporcionar una configuración nueva de fuente de datos que genera
los mismos campos, hay dos resultados basados en el valor del parámetro
refreshFields
:
Si se establece como
true
, la configuración del campo de la fuente de datos de la plantilla no se transferirá y es posible que los gráficos no se carguen si dependen de la misma configuración de campo (es decir, se espera un campo de tipo Year).Si se establece en
false
, la configuración del campo de la fuente de datos de la plantilla se transferirá a la nueva fuente de datos, y los gráficos de informes recibirán los mismos campos con la misma configuración y se cargarán de forma correcta.
Comentarios y asistencia
Usa la Herramienta de seguimiento de errores para informar problemas relacionados con la API de Linking o enviar comentarios. Consulta Asistencia para ver recursos generales sobre cómo obtener ayuda y hacer preguntas.
Registro de cambios
2023-06-06
- Se agregaron los parámetros de informe
r.measurementId
yr.keepMeasurementId
para establecer los parámetros de configuración del informe de IDs de medición de Google Analytics. - Se agregó
ds.keepDatasourceName
para controlar la reutilización del nombre de la fuente de datos de la plantilla. - Se agregó la sección Incorporar informe.
- Conector de BigQuery
- Se agregó
sqlReplace
. Te permite especificar strings de patrones y reemplazos para actualizar la consulta en SQL de la fuente de datos de la plantilla.
- Se agregó
2023-05-22
- Se agregó compatibilidad con el conector de Looker.
- Se agregó compatibilidad con los Conectores de la comunidad.
2022-11-21
- Se agregó la función para usar un informe en blanco. Consulta Cómo usar un informe en blanco o predeterminado.
- Se agregó una sección
refreshFields
a Sugerencias y solución de problemas.
2022-11-14
- Se quitó la referencia del conector de Surveys debido a la eliminación de Google Surveys.
2022-06-15
- Finalizó la etapa beta
- Se cambió el nombre de la API de Integration por Linking API.
- La API de Linking dejó de estar en versión beta.
- Se agregó el parámetro de control
pageId
para permitir la vinculación a una página específica de informes. - Se agregó el parámetro de control
mode
para establecer el estado del informe en el modo Ver o Editar durante la carga. - Los parámetros de configuración de las fuentes de datos ahora se pueden actualizar por completo o parcialmente. Este comportamiento se determina por si se configuró el parámetro
ds.connector
. Consulta Comparación entre reemplazar y actualizar para obtener más detalles. - Ahora se utiliza una plantilla predeterminada si no se proporciona una plantilla de informe con el parámetro
c.reportId
. - Se agregó el parámetro de fuente de datos
ds.refreshFields
. Esto te permite controlar si los campos de fuente de datos se actualizan cuando se carga una configuración de fuente de datos. - Conector de BigQuery
projectId
no es obligatorio cuandotype
se configura comoCUSTOM_QUERY
.- Cuando
billingProjectId
no está configurado, el proyecto de facturación recurrirá aprojectId
o al proyecto de la tabla consultada. - Se agregó compatibilidad con tablas particionadas por fecha. Establece el parámetro
isPartitioned
entrue
para usar el campo de partición como una dimensión de período. - Se agregó compatibilidad para consultar tablas particionadas por fecha mediante el carácter comodín o el sufijo de tabla
YYYYMMDD
. - Se agregó compatibilidad para realizar consultas en tablas de Google Analytics, Firebase Analytics o Crashlytics y seleccionar una plantilla de campos.
- Hojas de cálculo de Google
- El valor predeterminado de
hasHeader
estrue
, de manera coherente con el valor predeterminado de la IU web. includeHiddenAndFilteredCell
se dividió enincludeHiddenCells
yincludeFilteredCells
: La configuración predeterminada de ambos ahora estrue
, de acuerdo con la configuración predeterminada de la IU web.
- El valor predeterminado de
- Conector de Search Console
- Se cambió el nombre del parámetro
propertyType
asearchType
.
- Se cambió el nombre del parámetro
- Conector de Surveys
surveyId
ahora acepta un ID de encuesta único o una lista de ID de encuesta separados por comas.
2021-12-16
- Versión inicial de la API de Integration.
- Admite la vinculación a un informe existente y la configuración de su nombre.
- Se pueden configurar varias fuentes de datos y se puede establecer cada nombre de fuente de datos.
- Compatibilidad con los siguientes tipos de conectores: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Hojas de cálculo de Google, Google Surveys y Search Console.