Introducción
La API de Linking proporciona una interfaz confiable para configurar y redireccionar 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 obligatorio de las URLs de la API de Linking y los parámetros disponibles.
Caso de uso y beneficios
La API de Linking se puede usar para proporcionar informes preconfigurados para que tus clientes vean sus datos y puedan interactuar con ellos. Estos son los principales beneficios de la API de Linking:
- Una experiencia de creación de informes con un solo clic para tus clientes.
- La configuración de datos se proporciona en la URL, por lo que los usuarios no necesitan configurar el informe para sus datos.
- Los usuarios pueden guardar el informe con un solo clic y volver a consultarlo 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 un flujo de trabajo del producto.
Cómo funciona
A continuación, se describe cómo interactúan los desarrolladores y los usuarios con la API de Linking.
Flujo de trabajo para desarrolladores de la API de Linking
El desarrollador prepara las plantillas de informes, las fuentes de datos y formatea una URL de la API de Linking. El flujo de trabajo típico para los desarrolladores es el siguiente:
- Decide si usarás un informe en blanco, la plantilla de informe predeterminada que proporciona Looker Studio o si crearás un informe de Looker Studio que servirá como plantilla. Esto incluye la configuración de las fuentes de datos de la plantilla.
- Da formato a una URL de la API de Linking para tu caso de uso específico. Si corresponde, especifica la plantilla del informe y otros parámetros, incluidos el nombre del informe, el nombre de la fuente de datos y las configuraciones de la fuente de datos.
- Usa la URL de la API de Linking para dirigir a los usuarios al informe.
Experiencia del usuario de la API de Linking
El usuario sigue una URL de la API de Linking que, si el desarrollador la configuró 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ó con 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 total sobre su propia copia del informe. Pueden ver, editar y compartir en cualquier momento.
Requisitos
Para garantizar que una URL de la API de Linking funcione según lo esperado, se requiere lo siguiente:
- Es un informe que servirá como plantilla. Si no se proporciona, se puede usar un informe en blanco o predeterminado que proporciona Looker Studio.
- Los usuarios de una URL de la API de Linking deben tener, como mínimo, acceso de visualización al informe de 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 necesiten acceso de visualización 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 a través de la API de Linking. Consulta la referencia del conector para obtener una lista de los conectores compatibles.
- Los usuarios de la URL de la API de vinculación deben tener acceso a los datos configurados en la URL de la API de vinculación. Si el usuario no tiene acceso a los datos subyacentes, los componentes del informe dependientes mostrarán un error.
Parámetros de URL
La URL de la API de Linking 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 un usuario hace clic en un vínculo o se lo redirecciona a la URL. También se puede usar para incorporar un informe.
URL de ejemplo
A continuación, se muestra un ejemplo de URL de la API de Linking. Se establece el nombre del informe y se configura una sola 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. A continuación, se incluye una lista de los parámetros que se usan para definir una URL de la API de Linking:
Parámetros de control
Los parámetros de control determinan el estado del informe cuando se visualiza a través de la URL de la API de vinculación.
| Nombre del parámetro | Descripción |
|---|---|
| Opcional. Es el ID de la plantilla del informe. Se abrirá Looker Studio y se configurará el informe especificado. Para obtener detalles sobre cómo encontrar el ID, consulta ID del informe. 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. Si no se especifica, el valor predeterminado es la primera página del informe. | |
Opcional. Es el modo de informe inicial. Uno de
view o
edit. Si no se especifica, el valor predeterminado es view.
|
|
Opcional. Visibilidad del diálogo de información o depuración Se establece en true para mostrar el botón del diálogo. Si no se especifica, el valor predeterminado es false. Consulta
Solución de 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 de los informes
Los parámetros del informe reemplazan las propiedades del informe.
| Nombre del parámetro | Descripción |
|---|---|
| Opcional. Establece el nombre del informe. Si no se especifica, se usa de forma predeterminada el nombre del informe de la plantilla. | |
|
Opcional. Establece los IDs de medición de Google Analytics para medir el uso de los informes. Usa una coma para separar varios IDs. Si no se especifican |
|
|
Opcional. Se establece 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 la fuente de datos y los datos a los que se accederá para las fuentes de datos en el informe de plantilla.
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 a todos los tipos de conectores:
| Nombre | Descripción |
|---|---|
|
Opcional. Establece el nombre de la fuente de datos. Si no se especifican |
|
|
Opcional. Se establece en Si no se especifican |
|
|
Opcional.
Es el tipo de conector de la fuente de datos. Para obtener más información sobre los tipos de conectores admitidos, consulta la referencia del conector. Si se configura, todos los parámetros del conector requeridos para el tipo de conector se deben especificar en la URL de la API de vinculación, y la configuración de la fuente de datos de la plantilla se reemplazará por completo. Si no se especifica, se pueden incluir cero o más parámetros del conector para el tipo de conector en la URL de la API de Linking. La configuración de la fuente de datos de la plantilla se usará para especificar los parámetros que no se proporcionen en la URL de la API de Linking. Para obtener detalles sobre cómo identificar el tipo de conector de la fuente de datos de la plantilla, consulta Tipo de conector. Para obtener más información sobre cómo el parámetro |
|
|
Opcional.
Se establece en Configúralo como Si no se especifica, los valores predeterminados varían según el tipo de conector. Revisa la referencia del conector para conocer los valores predeterminados específicos del conector en caso de que desees anular el comportamiento predeterminado. Consideraciones para usar
refreshFields:
|
|
| Obligatorio. Es la configuración de la fuente de datos para el tipo de conector. Para obtener detalles sobre cómo identificar el conector que se usó para crear una fuente de datos, consulta Tipo de conector. Para obtener detalles sobre los parámetros de la fuente de datos disponibles para cada tipo de conector, consulta la Referencia de conector. |
Reemplazar vs. actualizar: Configuraciones de fuentes de datos
Cuando se configuran 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 Linking 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 se reemplaza por completo la configuración de una fuente de datos de plantilla o si se usa para actualizar los parámetros no especificados:
¿Está configurado 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 Linking. Debes especificar todos los parámetros obligatorios para el tipo de conector. Consulta Parámetros obligatorios cuando se establece ds.connector.
|
|
| No | Actualizar La configuración de la fuente de datos de la plantilla se usará para especificar los parámetros que no se proporcionen en la URL de la API de Linking. 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 Linking y, en general, se recomienda cuando conoces 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 Obligatorios 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 la configuración de la fuente de datos en su totalidad:
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 solo actualiza 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 fuente de datos de BigQuery (ds0) y una fuente de datos 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 vs. 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 a la vez. Cuando creas un informe con la API de Linking, puedes volver a agregar una fuente de datos de tu informe de plantilla si te aseguras de que se cumplan todas las siguientes condiciones:
- La fuente de datos es reutilizable (consulta Fuentes de datos incorporadas o reutilizables).
- La URL no hace referencia a la fuente de datos por alias.
- La URL no usa un alias de comodín (consulta Comodín de alias de fuente de datos).
Cuando se crea una nueva fuente de datos con la API de Linking, se usan las credenciales del usuario que hizo clic en la URL. Esto significa que el usuario debe tener acceso a los datos subyacentes, o 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 sigan accediendo a los datos en sus informes nuevos.
Comodín del alias de la fuente de datos
Para aplicar un parámetro de la API de Linking 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, podrías escribirlo 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 usan. 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 general, 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) - Es un valor derivado de la fuente de datos de la plantilla, si no se proporciona ds.connector (consulta Reemplazar vs. actualizar).
- Es el valor predeterminado del parámetro, si es opcional.
Referencia del conector
La API de Linking admite los siguientes conectores y parámetros de configuración. Para cada conector, se proporciona la lista de parámetros de fuentes 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 una consulta CUSTOM_QUERY, en la que proporcionas una instrucción 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 consultará.
| Nombre del parámetro | Descripción |
|---|---|
Opcional. Se establece en bigQuery para el conector de BigQuery.Si se configura, reemplaza la fuente de datos por la configuración de BigQuery proporcionada. Consulta Reemplazar vs. actualizar. |
|
Obligatorio** Tipo de búsqueda. Se establece en TABLE. |
|
| Obligatorio** Es el ID del proyecto de la tabla que se consultará. | |
| Obligatorio** Es el ID del conjunto de datos de la tabla que se consultará. | |
| Obligatorio** Es el ID 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 se identifica una tabla 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 plantillas de campos. |
|
Opcional. Es el ID del proyecto que se usará para la facturación. Si no se establece, se usará projectId. |
|
Opcional. Se establece en true si la tabla está particionada y deseas usar la columna de partición como una dimensión de período. Esto solo se aplica a la partición basada en el tiempo (p.ej., con una columna de partición basada en el tiempo o la pseudocolumna _PARTITIONTIME) y no funciona para las 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 particionadas. |
|
Opcional. Si no se especifica, el número predeterminado es true. Consulta refreshFields para obtener más detalles. |
Plantilla de campos para Google Analytics, Firebase Analytics y Crashlytics
En el caso de las tablas identificadas como Google Analytics, Firebase Analytics o Firebase Crashlytics, hay parámetros adicionales disponibles para establecer la plantilla de campos. Si no se especifica, se seleccionará una plantilla predeterminada.
| Nombre | Descripción |
|---|---|
Opcional. Es la plantilla de campos de Google Analytics que se usará. Solo se aplica cuando se consulta una tabla de BigQuery Export de Google Analytics. Uno de los siguientes: ALL, SESSION o HITS. En el caso de las tablas de Google Analytics, el valor predeterminado es ALL si no se especifica. |
|
Opcional. Es la plantilla de campos de Firebase Analytics que se usará. Solo se aplica cuando se consulta una tabla de exportación de BigQuery para Firebase Analytics.
Solo se puede establecer en EVENTS. En el caso de las tablas de Firebase Analytics, el valor predeterminado es EVENTS si no se especifica. |
|
Es la plantilla de campos de Firebase Crashlytics que se usará. Solo se puede establecer en DEFAULT. Solo se aplica cuando se consulta una tabla de BigQuery Export para Firebase Crashlytics. En el caso de las tablas de Firebase Crashlytics, el valor predeterminado es DEFAULT si no se especifica. |
Consultas PERSONALIZADAS
Los siguientes parámetros se aplican cuando type se establece en CUSTOM_QUERY y proporcionas una instrucción SQL para consultar una tabla.
| Nombre del parámetro | Descripción |
|---|---|
Opcional. Se establece en bigQuery para el conector de BigQuery.Si se configura, reemplaza la fuente de datos por la configuración de BigQuery proporcionada. Consulta Reemplazar vs. actualizar. |
|
Obligatorio** Tipo de búsqueda. Se establece en CUSTOM_QUERY. |
|
| Obligatorio** Es 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 no se configura projectId, se usará el proyecto de la tabla consultada. |
|
|
Opcional. Lista delimitada por comas de cadenas de reemplazo y patrones para aplicar a la consulta de SQL. El reemplazo de cadenas solo se aplica si hay una coincidencia de patrón. Usa una coma para separar los pares de cadenas de reemplazo y patrones. Por ejemplo, |
|
Opcional. Si no se especifica, el número predeterminado es true. Consulta refreshFields para obtener más detalles. |
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 carácter 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
Es una configuración de tipo TABLE para consultar una tabla de BigQuery Export de Google Analytics con 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 rango de fechas:
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 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 SQL y se usa la fuente de datos de la plantilla 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
Es una configuración de tipo CUSTOM_QUERY en la que la instrucción 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. Se establece en cloudSpannerpara el conector de Cloud Spanner.Si se configura, reemplaza la fuente de datos por la configuración de Cloud Spanner proporcionada. Consulta Reemplazar vs. actualizar. |
|
| Obligatorio** ID del proyecto. | |
| Obligatorio** Es el ID de la instancia. | |
| Obligatorio** Es el ID de la base de datos. | |
| Obligatorio** Es la consulta de SQL que se ejecutará. | |
Opcional. Si no se especifica, el número predeterminado es true.
Consulta refreshFields para obtener más detalles. |
Ejemplo
Una configuración de Cloud Spanner con una instrucción 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 comunidad
| Nombre del parámetro | Descripción |
|---|---|
Opcional. Se establece en community para un conector de comunidad.Si se configura, reemplaza la fuente de datos por la configuración del conector de comunidad proporcionada. Consulta Reemplazar vs. actualizar. |
|
Obligatorio** El conector de la comunidad
connectorId (también conocido como deploymentId).
| |
| Opcional. Parámetros adicionales específicos del conector, según se definen en la configuración del conector del conector de la comunidad. | |
Opcional. Si no se especifica, el número predeterminado es true. Consulta refreshFields para obtener más detalles. |
Ejemplo
Conéctate a un conector comunitario con 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. Se establece en googleAnalytics para el conector de Google Analytics.Si se configura, reemplaza la fuente de datos por la configuración de Google Analytics proporcionada. Consulta Reemplazar vs. actualizar. |
|
| Obligatorio** Es el ID de la cuenta. | |
| Obligatorio** Es el ID de la propiedad. | |
| Es el ID de la vista. Obligatorio** para las propiedades de Universal Analytics. No se debe configurar para las propiedades de Google Analytics 4. |
|
Opcional. Si no se especifica, el número predeterminado es false. Consulta refreshFields para obtener más detalles. |
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. Se establece en googleCloudStorage
Conector de Google
Cloud Storage.Si se configura, reemplaza la fuente de datos por la configuración de Google Cloud Storage proporcionada. Consulta Reemplazar vs. actualizar. |
|
Obligatorio** 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** Es la ruta de acceso al archivo (p.ej., MyBucket/MyData/MyFile.csv) si pathType es FILE o la ruta de acceso a la carpeta (p.ej., *MyBucket/MyData) si pathType es FOLDER. |
|
Opcional. Si no se especifica, el número predeterminado es true.
Consulta refreshFields para obtener más detalles. |
Ejemplo
Es 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 de la ruta de acceso:
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. Se establece en googleSheets para el conector de Hojas de cálculo de Google.Si se configura, reemplaza la fuente de datos por la configuración proporcionada de Hojas de cálculo de Google. Consulta Reemplazar vs. actualizar. |
|
| Obligatorio** ID de la hoja de cálculo. | |
| Obligatorio** Es el ID de la hoja de cálculo. | |
Opcional. Se establece 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. Se configura como true para incluir celdas ocultas.
Si no se especifica, el valor predeterminado es true. |
|
Opcional. Se establece en true para incluir celdas filtradas.
Si no se especifica, el valor predeterminado es true. |
|
| Opcional. Es el rango, p.ej., A1:B52. | |
Opcional. Si no se especifica, el número predeterminado es true. Consulta refreshFields para obtener más detalles. |
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 encabezados 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. Se establece en looker para el
conector de Looker.Si se configura, reemplaza la fuente de datos por la configuración de Looker proporcionada. Consulta Reemplazar vs. actualizar. |
|
| Obligatoria** Es la URL de la instancia de Looker. | |
| Obligatorio** Es el modelo de Looker. | |
| Obligatorio** Es la Exploración de Looker. | |
Opcional. Si no se especifica, el número predeterminado es false. Consulta refreshFields para obtener más detalles. |
Ejemplo
Sigue estos pasos para conectarte a una exploración de 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
| Nombre del parámetro | Descripción |
|---|---|
Opcional. Se establece en searchConsole para el conector de Search Console.Si se configura, reemplaza la fuente de datos por la configuración de Search Console proporcionada. Consulta Reemplazar vs. actualizar. |
|
Obligatorio** Es la URL del sitio. En el caso de una propiedad de dominio, agrega 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 uno de los siguientes: WEB, IMAGE, VIDEO o NEWS. |
|
Opcional. Si no se especifica, el número predeterminado es false. Consulta refreshFields para obtener más detalles. |
Ejemplo
Una configuración de Search Console para una propiedad con 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
Para garantizar la mejor experiencia del usuario, es importante configurar correctamente los permisos de acceso a los informes de tu informe de plantilla y las fuentes de datos asociadas. Los permisos necesarios dependen de si la plantilla del informe usa fuentes de datos integradas 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 lograr una 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 | Vinculación de la configuración de la API para la fuente de datos | Recomendación para los permisos de la fuente de datos | Notas |
|---|---|---|---|
| Incorporada | Reemplazar | N/A: El acceso de lectura se heredará del informe. | Si el usuario tiene acceso de visualización al informe de plantilla, automáticamente tendrá acceso de visualización a cualquier fuente de datos incorporada. |
| Incorporada | Actualizar | N/A: El acceso de lectura se heredará del informe. | Si el usuario tiene acceso de visualización al informe de plantilla, automáticamente tendrá acceso de visualización a cualquier fuente de datos incorporada. |
| Se puede reutilizar | Reemplazar | Los usuarios no necesitan acceso de visualización. | 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 visualización. |
| Se puede reutilizar | Actualizar | Los usuarios requieren acceso de lectura. | Se requiere acceso de visualización 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 visualización, recibirán un error cuando carguen el informe. |
Usa 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 |
Establece 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 este tiene una sola fuente de datos integrada. |
En los siguientes ejemplos, se muestran varias URLs de la API de Linking 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 informe predeterminada con una configuración del 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 Linking, establece parámetros de URL y, luego, incluye la ruta de acceso /embed/. La URL de incorporación de la API de Linking debe tener el siguiente formato:
https://lookerstudio.google.com/embed/reporting/create?parameters
Cómo encontrar IDs y alias
ID del informe
Para encontrar el ID del informe, sigue estos pasos:
- Abre el informe que deseas usar como plantilla. Inspecciona la URL del informe. La parte entre
reporting/y/pagees el ID del informe. Por ejemplo, en la siguiente URL,0B_U5RNpwhcE6SF85TENURnc4UjAes el ID del informe:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Alias de fuente de datos
Un informe puede tener varias fuentes de datos. Se debe hacer referencia a una fuente de datos por su alias.
Para encontrar un alias de fuente de datos, sigue estos pasos:
- Edita el informe.
- En la barra de herramientas, selecciona Recurso > Administrar fuentes de datos agregadas.
- Examina la columna Alias para encontrar información sobre los alias de cada fuente de datos.
Puedes editar los nombres de alias para garantizar la compatibilidad con versiones anteriores cuando se agrega o quita una fuente de datos.
Tipo de conector
Un informe puede tener varias fuentes de datos, cada una creada configurando un conector. Para encontrar el tipo de conector que se usó para crear una fuente de datos, sigue estos pasos:
- Edita el informe.
- En la barra de herramientas, selecciona Recurso > Administrar fuentes de datos agregadas.
- Examina la columna Tipo de conector para identificar el conector que se usó para crear una fuente de datos.
Sugerencias y solución de problemas
Si tienes problemas, revisa los detalles que se indican 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 Linking tal como la interpreta Looker Studio. Puede ayudar a depurar problemas con la API.
- Cuando se produce un error durante el análisis de la URL de la API de Linking, se muestra automáticamente un diálogo con detalles sobre el error.
- Cuando se produce un error y no se muestra automáticamente ningún diálogo, 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=trueal final de cualquier URL de la API de Linking.
Permisos
Asegúrate de tener configurados los permisos de plantilla correctos para los tipos de fuentes de datos y la configuración de la API de Linking. Consulta Permisos de plantilla para obtener más detalles.
Actualización vs. reemplazo
Si actualizas la configuración de una fuente de datos a partir de 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 Linking para asegurarte de que sean compatibles. Confirma que los campos que se obtienen de la nueva configuración sean compatibles con los componentes y la configuración del informe.
Cuando se realiza una actualización en lugar de un reemplazo, es posible establecer una configuración no válida con un comportamiento indefinido. Consulta Reemplazo vs. actualización para obtener más detalles.
Actualizar los campos
Si configuraste nombres, tipos o agregaciones de campos para una fuente de datos de plantilla, estos cambios solo se transferirán a una fuente de datos configurada con la API de Linking si el parámetro ds.refreshFields está establecido en false.
Revisa el parámetro de fuente de datos ds.refreshFields de la URL de la API de Linking. Si se omite, confirma que el valor predeterminado del parámetro para cada tipo de conector sea correcto para tu caso de uso.
En general, si configuraste campos en la fuente de datos de la plantilla y tienes la certeza de que las nuevas configuraciones de la fuente de datos a través de la API de Linking siempre generarán los mismos campos exactos, se recomienda establecer refreshFields en 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 Número y lo cambias a tipo Año, este cambio en la configuración del campo ahora forma parte de la fuente de datos de la plantilla. Cualquier gráfico de la plantilla del informe que use el campo corregido esperará un año y, si el gráfico se basa en el tiempo, es posible que no se renderice de otra manera. Si se usa la API de Linking para proporcionar una nueva configuración de la fuente de datos que genera exactamente los mismos campos, hay dos resultados posibles según el valor del parámetro refreshFields:
Si se establece en
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 del campo (es decir, se espera un campo de tipo Year).Si se configura como
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 del informe recibirán los mismos campos con la misma configuración y se cargarán correctamente.
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 obtener recursos generales sobre cómo obtener ayuda y hacer preguntas.
Registro de cambios
2023-06-06
- Se agregaron los parámetros de informes
r.measurementIdyr.keepMeasurementIdpara configurar el parámetro de configuración del informe IDs de medición de Google Analytics. - Se agregó
ds.keepDatasourceNamepara controlar la reutilización del nombre de la fuente de datos de la plantilla. - Se agregó una sección Incorporar informe.
- Conector de BigQuery
- Se agregó
sqlReplace. Te permite especificar cadenas de reemplazo y patrones 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 capacidad de usar un informe en blanco. Consulta Cómo usar un informe en blanco o predeterminado.
- Se agregó una sección
refreshFieldsa 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
- Finalización de la versión beta
- Se cambió el nombre de la API de Integration a API de Linking.
- La API de Linking ya no está en versión beta.
- Se agregó el parámetro de control
pageIdpara permitir la vinculación a una página de informe específica. - Se agregó el parámetro de control
modepara establecer el estado del informe en el modo Ver o Editar durante la carga. - Ahora se pueden reemplazar por completo o actualizar parcialmente los parámetros de configuración de las fuentes de datos. Este comportamiento se determina según si se configura el parámetro
ds.connector. Consulta Reemplazar vs. actualizar para obtener más detalles. - Ahora se usa 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 la fuente de datos se actualizan cuando se carga una configuración de fuente de datos. - Conector de BigQuery
projectIdno es obligatorio cuandotypese establece comoCUSTOM_QUERY.- Cuando no se establece
billingProjectId, el proyecto de facturación recurrirá aprojectIdo al proyecto de la tabla consultada. - Se agregó compatibilidad con tablas particionadas por fecha. Establece el parámetro
isPartitionedentruepara usar el campo de partición como una dimensión de período. - Se agregó compatibilidad para consultar tablas particionadas por fecha con el carácter comodín o el sufijo de tabla
YYYYMMDD. - Se agregó compatibilidad para consultar tablas de Google Analytics, Firebase Analytics o Crashlytics, y seleccionar una plantilla de campos.
- Hojas de cálculo de Google
hasHeaderse establece de forma predeterminada entrue, lo que coincide con la configuración predeterminada de la IU web.includeHiddenAndFilteredCelldividido enincludeHiddenCellsyincludeFilteredCells. Ahora, ambos valores predeterminados sontrue, lo que coincide con el valor predeterminado de la IU web.
- Conector de Search Console
- Se cambió el nombre del parámetro
propertyTypeasearchType.
- Se cambió el nombre del parámetro
- Conector de Surveys
surveyIdahora acepta un solo ID de encuesta o una lista de IDs de encuestas separados por comas.
2021-12-16
- Se lanzó la versión inicial de la API de Integration.
- Permite vincular un informe existente y establecer el nombre del informe.
- Se pueden configurar varias fuentes de datos y se puede establecer el nombre de cada una.
- 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.