Introduction
L'API Linking permet de configurer un rapport Looker Studio et d'y rediriger directement les utilisateurs via une URL. En suivant une URL de l'API Linking, il est plus simple pour les utilisateurs de consulter leurs données et d'interagir avec elles rapidement.
Ce document décrit le format requis des URL de l'API Linking et les paramètres disponibles.
Cas d'utilisation et avantages
L'API Linking peut être utilisée pour fournir des rapports préconfigurés à vos clients afin qu'ils puissent consulter leurs données et interagir avec elles. Voici les principaux avantages de l'API Linking :
- Vos clients peuvent créer des rapports en un clic.
- La configuration des données est fournie dans l'URL. Les utilisateurs n'ont donc pas besoin de configurer le rapport pour leurs données.
- Les utilisateurs peuvent enregistrer le rapport d'un simple clic et le consulter à tout moment.
- Créez des rapports à grande échelle. L'API Linking réduit le temps nécessaire pour dupliquer ou créer des rapports.
- Activez les intégrations de produits. L'interface stable vous permet d'intégrer Looker Studio dans un workflow de produit.
Fonctionnement
La section suivante décrit comment les développeurs et les utilisateurs interagissent avec l'API Linking.
Workflow de développement de l'API Linking
Le développeur prépare les rapports modèles, les sources de données et met en forme une URL de l'API Linking. Voici le workflow type pour les développeurs :
- Décidez d'utiliser un rapport vide, le modèle de rapport par défaut fourni par Looker Studio ou de créer un rapport Looker Studio qui servira de modèle. Cela inclut la configuration des sources de données du modèle.
- Mettez en forme une URL de l'API Linking pour votre cas d'utilisation spécifique. Le cas échéant, spécifiez le modèle de rapport et d'autres paramètres, y compris le nom du rapport, le nom de la source de données et les configurations de la source de données.
- Utilisez l'URL de l'API Linking pour rediriger les utilisateurs vers le rapport.
Expérience utilisateur de l'API Linking
L'utilisateur suit une URL de l'API Linking qui, si elle est correctement configurée par le développeur, le redirige vers un rapport Looker Studio lui permettant de consulter les données auxquelles il a accès et d'interagir avec elles. Voici un exemple d'expérience utilisateur typique :
- Dans un navigateur, l'utilisateur accède à un service intégré à l'API Linking.
- Une incitation à l'action invite l'utilisateur à cliquer sur un lien pour afficher ses données dans Looker Studio.
- L'utilisateur suit le lien et est redirigé vers un rapport Looker Studio. Le rapport se charge et l'utilisateur peut afficher ses données et interagir avec elles.
- L'utilisateur clique sur "Modifier et partager". Le rapport est enregistré dans son compte Looker Studio.
- L'utilisateur dispose désormais d'un accès complet à sa propre copie du rapport et peut la contrôler. Ils peuvent les consulter, les modifier et les partager à tout moment.
Conditions requises
Pour vous assurer qu'une URL de l'API Linking fonctionne comme prévu, vous devez respecter les conditions suivantes :
- Un rapport à utiliser comme modèle. Si vous n'en fournissez pas, vous pouvez utiliser un rapport vide ou un rapport par défaut fourni par Looker Studio.
- Les utilisateurs d'une URL de l'API Linking doivent au moins disposer d'un accès en lecture au rapport modèle. Selon le type de sources de données utilisées dans le rapport et la configuration fournie via l'API Linking, les utilisateurs peuvent également avoir besoin d'un accès en lecture aux sources de données. Pour en savoir plus, consultez Autorisations des modèles.
- Le type de connecteur de chaque source de données doit être compatible avec la configuration via l'API Linking. Consultez la documentation de référence sur les connecteurs pour obtenir la liste des connecteurs compatibles.
- Les utilisateurs de l'URL de l'API Linking doivent avoir accès aux données configurées dans l'URL de l'API Linking. Si l'utilisateur n'a pas accès aux données sous-jacentes, tous les composants de rapport dépendants afficheront une erreur.
Paramètres d'URL
Une URL de l'API Linking doit se présenter comme suit :
https://lookerstudio.google.com/reporting/create?parameters
L'URL est censée être utilisée dans le contexte d'un navigateur Web, généralement par un utilisateur qui clique sur un lien ou est redirigé vers l'URL. Vous pouvez également l'utiliser pour intégrer un rapport.
Exemple d'URL
Voici un exemple d'URL de l'API Linking. Le nom du rapport est défini et une seule source de données BigQuery est configurée :
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
Certains paramètres d'URL sont obligatoires, tandis que d'autres sont facultatifs. Vous trouverez ci-dessous la liste des paramètres utilisés pour définir une URL de l'API Linking :
Paramètres de contrôle
Les paramètres de contrôle déterminent l'état du rapport lorsqu'il est consulté via l'URL de l'API Linking.
| Nom du paramètre | Description |
|---|---|
| Facultatif. ID du rapport de modèle. Looker Studio s'ouvre et configure le rapport spécifié. Pour savoir comment trouver l'ID, consultez ID du signalement. Si aucun modèle n'est spécifié, un rapport vide ou un modèle de rapport par défaut est utilisé. Pour en savoir plus, consultez Utiliser un rapport vide ou par défaut. | |
| Facultatif. ID de la page initiale à charger dans le rapport. Si aucune valeur n'est spécifiée, la première page du rapport est utilisée par défaut. | |
Facultatif. Mode de création de rapports initial.
view ou
edit. Prend la valeur view par défaut s'il n'est pas spécifié.
|
|
Facultatif. Visibilité de la boîte de dialogue d'informations/de débogage. Définissez la valeur sur true pour afficher le bouton de la boîte de dialogue. Si aucune valeur n'est spécifiée, la valeur définie par défaut est false. Pour en savoir plus, consultez
Résoudre les problèmes de configuration.
|
Exemple
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
Paramètres des rapports
Les paramètres de rapport remplacent les propriétés du rapport.
| Nom du paramètre | Description |
|---|---|
| Facultatif. Définit le nom du rapport. Si aucune valeur n'est spécifiée, le nom du rapport du modèle est utilisé par défaut. | |
|
Facultatif. Définit les ID de mesure Google Analytics sur Mesurer l'utilisation des rapports. Utilisez une virgule pour séparer plusieurs ID. Si |
|
|
Facultatif. Définissez la valeur sur Si |
Exemple
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
Paramètres de source de données
Les paramètres de source de données vous permettent de définir une configuration de source de données et les données auxquelles accéder pour les sources de données dans le rapport modèle.
Un alias est utilisé pour référencer une source de données dans un rapport existant. L'utilisation d'un alias permet la rétrocompatibilité si une source de données est ajoutée ou supprimée du rapport de modèle.
Pour savoir comment trouver une source de données alias, consultez Alias de source de données.
Paramètres de source de données
Les paramètres suivants sont communs à tous les types de connecteurs :
| Nom | Description |
|---|---|
|
Facultatif. Définit le nom de la source de données. Si |
|
|
Facultatif. Définissez la valeur sur Si |
|
|
Facultatif.
Type de connecteur de la source de données. Pour en savoir plus sur les types de connecteurs compatibles, consultez la documentation sur les connecteurs. Si cette option est définie, tous les paramètres de connecteur requis pour le type de connecteur doivent être spécifiés dans l'URL de l'API Linking. La configuration de la source de données du modèle sera alors entièrement remplacée. Si aucune valeur n'est spécifiée, vous pouvez indiquer zéro ou plusieurs paramètres de connecteur pour le type de connecteur dans l'URL de l'API Linking. La configuration de la source de données du modèle sera utilisée pour spécifier les paramètres non fournis dans l'URL de l'API Linking. Pour savoir comment identifier le type de connecteur de la source de données du modèle, consultez Type de connecteur. Pour savoir comment le paramètre |
|
|
Facultatif.
Définissez la valeur sur Définissez la valeur sur Si aucune valeur n'est spécifiée, les valeurs par défaut varient selon le type de connecteur. Consultez la documentation de référence sur les connecteurs pour connaître les valeurs par défaut spécifiques aux connecteurs si vous souhaitez remplacer le comportement par défaut. Éléments à prendre en compte lorsque vous utilisez
refreshFields :
|
|
| Obligatoire. Configuration de la source de données pour le type de connecteur. Pour savoir comment identifier le connecteur utilisé pour créer une source de données, consultez Type de connecteur. Pour en savoir plus sur les paramètres de source de données disponibles pour chaque type de connecteur, consultez la documentation de référence sur les connecteurs. |
Remplacer ou mettre à jour les configurations de source de données
Lorsque vous définissez des paramètres de source de données, la présence ou l'absence du paramètre ds.connector dans l'URL de l'API Linking indique l'intention de remplacer ou de mettre à jour la configuration de la source de données du modèle, respectivement.
Le tableau suivant indique comment le paramètre ds.connector affecte le remplacement complet d'une configuration de source de données de modèle ou son utilisation pour mettre à jour les paramètres non spécifiés :
ds.connector est-il défini ? |
Configuration et comportement attendus | Utilisation type |
|---|---|---|
| Oui |
Remplacer. La configuration de la source de données du modèle est entièrement remplacée à l'aide des paramètres de source de données spécifiés dans l'URL de l'API Linking. Vous devez spécifier tous les paramètres requis pour le type de connecteur. Consultez Paramètres requis lorsque ds.connector est défini.
|
|
| Non | Mettre à jour. La configuration de la source de données du modèle sera utilisée pour spécifier les paramètres non fournis dans l'URL de l'API Linking. Tous les paramètres de connecteur pour le type de connecteur sont facultatifs, sauf indication contraire.
Cela simplifie l'URL de l'API Linking et est généralement recommandé lorsque vous êtes familiarisé avec la configuration de la source de données du modèle et que vous souhaitez uniquement remplacer un sous-ensemble de paramètres. |
|
Paramètres obligatoires lorsque ds.connector est défini
Si le paramètre ds.connector d'une source de données est spécifié, tous les paramètres de connecteur désignés comme Obligatoire doivent être spécifiés pour la source de données. Si le paramètre ds.connector de la source de données n'est pas spécifié, tous les paramètres du connecteur, même ceux désignés comme obligatoires, peuvent être traités comme facultatifs, sauf indication contraire.
Exemples
Configure un rapport avec une seule source de données BigQuery (ds0) et remplace entièrement la configuration de la source de données :
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
L'alias de la source de données peut être omis lorsque le rapport ne comporte qu'une seule source de données. L'URL ci-dessus peut être simplifiée comme suit :
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
Configure un rapport avec une seule source de données BigQuery (ds0) et met à jour uniquement l'ID du projet de facturation de la source de données :
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.billingProjectId=my-billing-project
Configure un rapport avec deux sources de données : une source de données BigQuery (ds0) et une source de données Google Analytics (ds1). La configuration de la source de données BigQuery est entièrement remplacée, tandis que la configuration Google Analytics met à jour un seul paramètre et s'appuie sur la source de données du modèle ds1 pour tous les paramètres de connecteur non spécifiés :
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
Créer ou ajouter
Il peut parfois être utile d'avoir la même source de données dans plusieurs rapports afin que les modifications apportées à la source de données affectent tous les rapports en même temps. Lorsque vous créez un rapport avec l'API Linking, vous pouvez rajouter une source de données à partir de votre rapport modèle en vous assurant que toutes les conditions suivantes sont remplies :
- La source de données est réutilisable (voir Sources de données intégrées et réutilisables).
- L'URL ne fait pas référence à la source de données par son alias.
- L'URL n'utilise pas d'alias générique (voir Alias générique de source de données).
Lorsqu'une source de données est créée avec l'API Linking, elle utilise les identifiants de l'utilisateur qui a cliqué sur l'URL. Cela signifie que l'utilisateur doit avoir accès aux données sous-jacentes, sans quoi la connexion ne fonctionnera pas. En ajoutant à nouveau la source de données au rapport nouvellement généré, vous pouvez conserver ses identifiants afin que les utilisateurs puissent continuer à accéder aux données dans leurs nouveaux rapports.
Caractère générique de l'alias de source de données
Pour appliquer un paramètre de l'API Linking à plusieurs sources de données, vous pouvez utiliser l'alias générique ds.* à la place de l'alias de la source de données.
Cela peut être utile pour supprimer les paramètres répétitifs de votre URL. Par exemple, si vous avez un modèle avec trois sources de données BigQuery associées et que vous souhaitez remplacer projectId et datasetId dans chacune d'elles, mais conserver tableId, vous pouvez écrire :
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
Vous pouvez également utiliser l'URL équivalente suivante avec le caractère générique ds.* :
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
Les paramètres fournis à l'API Linking qui n'utilisent pas le caractère générique ds.* sont prioritaires sur ceux qui l'utilisent. Dans l'exemple ci-dessus, vous pouvez ajouter un alias de source de données spécifique pour remplacer la valeur du caractère générique.
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
Plus généralement, l'ordre de priorité des paramètres est le suivant :
- Paramètre associé à un alias spécifique (
ds.ds1.datasetId) - Paramètre fourni à l'aide du caractère générique (
ds.*.datasetId) - Valeur dérivée de la source de données du modèle, si ds.connector n'est pas fourni (voir Remplacer ou mettre à jour)
- Valeur par défaut du paramètre, s'il est facultatif.
Documentation de référence sur les connecteurs
L'API Linking est compatible avec les connecteurs et configurations suivants. Pour chaque connecteur, la liste des paramètres de source de données disponibles est fournie.
BigQuery
Le connecteur BigQuery est compatible avec deux types de requêtes : les requêtes TABLE, dans lesquelles vous fournissez l'ID de la table à interroger, et les requêtes CUSTOM_QUERY, dans lesquelles vous fournissez une instruction SQL pour interroger une table.
Requêtes TABLE
Les paramètres suivants s'appliquent lorsque type est défini sur TABLE et que vous fournissez l'ID de la table à interroger.
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur bigQuery pour le connecteur BigQuery.Si cette option est définie, elle remplace la source de données par la configuration BigQuery fournie. Consultez Remplacer ou mettre à jour. |
|
Obligatoire** : type de requête. Défini sur TABLE. |
|
| Obligatoire** : ID du projet de la table à interroger. | |
| Obligatoire** : ID de l'ensemble de données de la table à interroger. | |
| Obligatoire** ID de la table à interroger. Tables partitionnées par date : le suffixe * (caractère générique) ou YYYYMMDD est accepté lors de l'interrogation des tables partitionnées par date.Si une table est identifiée comme Google Analytics, Firebase Analytics ou Firebase Crashlytics, un modèle de champs par défaut est sélectionné, sauf si un autre est spécifié. Consultez les paramètres associés au tableau Modèle de champs. |
|
Facultatif. ID du projet à utiliser pour la facturation. Si ce paramètre n'est pas défini, projectId est utilisé. |
|
Facultatif. Définissez sur true si la table est partitionnée et que vous souhaitez utiliser la colonne de partitionnement comme dimension de plage de dates. Cela ne s'applique qu'au partitionnement basé sur le temps (par exemple, à l'aide d'une colonne de partitionnement basée sur le temps ou de la pseudo-colonne _PARTITIONTIME) et ne fonctionne pas pour les tables partitionnées par plages d'entiers. Si aucune valeur n'est spécifiée, la valeur définie par défaut est false. Pour en savoir plus, consultez la page
Présentation des tables partitionnées. |
|
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Modèle de champs pour Google Analytics, Firebase Analytics et Crashlytics
Pour les tableaux identifiés comme Google Analytics, Firebase Analytics ou Firebase Crashlytics, des paramètres supplémentaires sont disponibles pour définir le modèle de champs. Si aucune valeur n'est spécifiée, un modèle par défaut est sélectionné.
| Nom | Description |
|---|---|
Facultatif. Modèle de champs Google Analytics à utiliser. Applicable uniquement lorsqu'une table d'exportation BigQuery pour Google Analytics est interrogée. Spécifiez l'un des types suivants : ALL, SESSION ou HITS. Pour les tableaux Google Analytics, la valeur par défaut est ALL si aucune valeur n'est spécifiée. |
|
Facultatif. Modèle de champs Firebase Analytics à utiliser. Applicable uniquement lorsqu'une table d'exportation BigQuery pour Firebase Analytics est interrogée.
Ne peut être défini que sur EVENTS. Pour les tables Firebase Analytics, la valeur par défaut est EVENTS si aucune valeur n'est spécifiée. |
|
Modèle de champs Firebase Crashlytics à utiliser. Ne peut être défini que sur DEFAULT. Applicable uniquement lorsqu'une table BigQuery Export pour Firebase Crashlytics est interrogée. Pour les tables Firebase Crashlytics, la valeur par défaut est DEFAULT si elle n'est pas spécifiée. |
Requêtes CUSTOM
Les paramètres suivants s'appliquent lorsque type est défini sur CUSTOM_QUERY et que vous fournissez une instruction SQL pour interroger une table.
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur bigQuery pour le connecteur BigQuery.Si cette option est définie, elle remplace la source de données par la configuration BigQuery fournie. Consultez Remplacer ou mettre à jour. |
|
Obligatoire** : type de requête. Défini sur CUSTOM_QUERY. |
|
| Obligatoire** : requête SQL à exécuter. | |
Facultatif. ID du projet à utiliser pour la facturation. Si ce paramètre n'est pas défini, projectId est utilisé. Si projectId n'est pas défini, le projet de la table interrogée est utilisé. |
|
|
Facultatif. Liste de chaînes de modèle et de remplacement séparées par une virgule à appliquer à la requête SQL. Le remplacement de chaîne n'est appliqué que s'il existe une correspondance de modèle. Séparez les paires de chaînes de modèle et de remplacement par une virgule. Par exemple : |
|
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemples
Configuration de type TABLE où la requête est définie avec un ID de table :
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
Configuration de type TABLE pour interroger une table segmentée par date à l'aide du suffixe de caractère générique :
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_*
Configuration de type TABLE pour interroger une table partitionnée par date à l'aide du suffixe 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
Configuration de type TABLE pour interroger une table BigQuery Export pour Google Analytics, à l'aide du modèle de champs 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
Configuration de type TABLE pour interroger une table partitionnée par date d'ingestion et utiliser la colonne de partitionnement comme dimension de plage de dates :
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
Configuration de type CUSTOM_QUERY où la requête est définie avec une instruction 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
Configuration de type CUSTOM_QUERY où seule l'instruction SQL est mise à jour et où la source de données du modèle est utilisée pour le reste de la configuration :
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60
Configuration de type CUSTOM_QUERY dans laquelle l'instruction SQL de la source de données du modèle est mise à jour à l'aide de 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
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur cloudSpanner pour le connecteur Cloud Spanner.Si cette option est définie, elle remplace la source de données par la configuration Cloud Spanner fournie. Consultez Remplacer ou mettre à jour. |
|
| Obligatoire** ID du projet. | |
| Obligatoire** : ID de l'instance. | |
| Obligatoire** : ID de la base de données. | |
| Obligatoire** : requête SQL à exécuter. | |
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié.
Pour en savoir plus, consultez refreshFields. |
Exemple
Configuration Cloud Spanner avec une instruction 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
Connecteurs de communauté
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur community pour un connecteur de communauté.Si cette option est définie, elle remplace la source de données par la configuration du connecteur de communauté fournie. Consultez Remplacer ou mettre à jour. |
|
Obligatoire** : le connecteur de communauté connectorId (également appelé deploymentId).
| |
| Facultatif. Paramètres supplémentaires spécifiques au connecteur, tels que définis par la configuration du connecteur du connecteur de communauté. | |
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemple
Connectez-vous à un connecteur de communauté avec les paramètres de configuration state et 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
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur googleAnalytics pour le connecteur Google Analytics.Si elle est définie, remplace la source de données par la configuration Google Analytics fournie. Consultez Remplacer ou mettre à jour. |
|
| Obligatoire** ID du compte. | |
| Obligatoire** : ID de la propriété. | |
| ID de la vue. Obligatoire** pour les propriétés Universal Analytics. Ne définissez pas cette valeur pour les propriétés Google Analytics 4. |
|
Facultatif. Prend la valeur false par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemples
Configuration Google Analytics pour une propriété 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
Configuration Google Analytics pour une propriété 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
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur googleCloudStorage
Connecteur Google
Cloud Storage.Si cette option est définie, elle remplace la source de données par la configuration Google Cloud Storage fournie. Consultez Remplacer ou mettre à jour. |
|
Obligatoire** : type de chemin. Utilisez FILE pour sélectionner un seul fichier ou FOLDER pour sélectionner tous les fichiers du chemin d'accès donné. |
|
Obligatoire** Chemin d'accès au fichier (par exemple, MyBucket/MyData/MyFile.csv) si pathType est défini sur FILE, ou chemin d'accès au dossier (par exemple, *MyBucket/MyData) si pathType est défini sur FOLDER. |
|
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié.
Pour en savoir plus, consultez refreshFields. |
Exemple
Configuration Google Cloud Storage pour un seul fichier :
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FILE
&ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv
Configuration Google Cloud Storage pour tous les fichiers du chemin d'accès :
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FOLDER
&ds.ds50.path=MyBucket%2FMyData
Google Sheets
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur googleSheets pour le connecteur Google Sheets.: si cette valeur est définie, elle remplace la source de données par la configuration Google Sheets fournie. Consultez Remplacer ou mettre à jour. |
|
| Obligatoire** ID de la feuille de calcul. | |
| Obligatoire** : ID de la feuille de calcul. | |
Facultatif. Définissez la valeur sur true pour utiliser la première ligne comme en-tête.
Prend la valeur true par défaut s'il n'est pas spécifié. Les en-têtes de colonne doivent être uniques. Les colonnes sans en-tête ne seront pas ajoutées à la source de données.
|
|
Facultatif. Définissez la valeur sur true pour inclure les cellules masquées.
Prend la valeur true par défaut s'il n'est pas spécifié. |
|
Facultatif. Définissez la valeur sur true pour inclure les cellules filtrées.
Prend la valeur true par défaut s'il n'est pas spécifié. |
|
| Facultatif. Plage, par exemple A1:B52. | |
Facultatif. Prend la valeur true par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemples
Configuration Google Sheets :
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
Configuration Google Sheets avec la première ligne utilisée comme en-tête et les cellules masquées et filtrées incluses :
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
Configuration Google Sheets avec une plage (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
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur looker pour le
connecteur Looker.Si cette option est définie, elle remplace la source de données par la configuration Looker fournie. Consultez Remplacer ou mettre à jour. |
|
| Obligatoire** : URL de l'instance Looker. | |
| Obligatoire** : modèle Looker. | |
| Obligatoire** : l'exploration Looker. | |
Facultatif. Prend la valeur false par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemple
Se connecter à une exploration 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
| Nom du paramètre | Description |
|---|---|
Facultatif. Définissez la valeur sur searchConsole pour le connecteur Search Console.Si cette valeur est définie, elle remplace la source de données par la configuration Search Console fournie. Consultez Remplacer ou mettre à jour. |
|
Obligatoire** URL du site. Pour une propriété de domaine, ajoutez le préfixe sc-domain\:. |
|
Obligatoire** Définit le type de tableau. Peut correspondre à SITE_IMPRESSION ou URL_IMPRESSION. |
|
Obligatoire** Définit le type de recherche. Il peut s'agir de WEB, IMAGE, VIDEO ou NEWS. |
|
Facultatif. Prend la valeur false par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez refreshFields. |
Exemple
Configuration Search Console pour une propriété avec préfixe d'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
Configuration Search Console pour une propriété de domaine :
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
Autorisations des modèles
Pour offrir la meilleure expérience possible aux utilisateurs, il est important de définir correctement les autorisations d'accès aux rapports pour votre rapport de modèle et les sources de données associées. Les autorisations requises dépendent du fait que le modèle de rapport utilise des sources de données intégrées ou réutilisables et que la configuration de l'API Linking est définie sur remplacer ou mettre à jour une configuration de source de données.
Le tableau suivant indique l'accès recommandé aux sources de données pour une expérience utilisateur optimale, en fonction des sources de données du modèle et de la configuration de l'API Linking :
| Type de source de données | Configuration de l'API Linking pour la source de données | Recommandation concernant les autorisations de source de données | Remarques |
|---|---|---|---|
| Intégrée | Remplacer | N/A : l'accès en lecture sera hérité du rapport. | Si un utilisateur a accès en lecture au rapport de modèle, il aura automatiquement accès en lecture à toutes les sources de données intégrées. |
| Intégrée | Mettre à jour | N/A : l'accès en lecture sera hérité du rapport. | Si un utilisateur a accès en lecture au rapport de modèle, il aura automatiquement accès en lecture à toutes les sources de données intégrées. |
| Réutilisable | Remplacer | Les utilisateurs n'ont pas besoin d'accéder à l'affichage. | Étant donné que la configuration de la source de données est entièrement remplacée par l'API Linking, l'accès en lecture n'est pas nécessaire. |
| Réutilisable | Mettre à jour | Les utilisateurs doivent disposer d'un accès en lecture. | L'accès en lecture à la source de données est requis pour que l'API Linking puisse lire et utiliser la configuration de la source de données du modèle. Si l'utilisateur n'a pas accès à l'affichage, il recevra un message d'erreur lors du chargement du rapport. |
Utiliser un rapport vide ou par défaut
Pour utiliser un rapport vide ou le rapport par défaut, configurez votre API Linking comme suit :
| Type de rapport | Définir le paramètre de contrôle reportId |
Définissez les paramètres de la source de données (). |
Remarques |
|---|---|---|---|
| Rapport vide | Non | Non | |
| Rapport par défaut | Non | Oui | Le rapport par défaut est fourni par Looker Studio. Il n'est pas nécessaire d'utiliser un alias de source de données lorsque vous spécifiez des paramètres de source de données pour le rapport par défaut, car celui-ci ne comporte qu'une seule source de données intégrée. |
Les exemples suivants montrent différentes URL de l'API Linking qui utilisent un rapport vide ou par défaut.
Lancez le workflow de création de rapports avec un rapport vide :
https://lookerstudio.google.com/reporting/create
Lancez le workflow de création de rapport avec un rapport vide et définissez le nom du rapport :
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Utilisez le modèle de rapport par défaut avec une configuration de connecteur Google Sheets :
https://lookerstudio.google.com/reporting/create?
ds.connector=googleSheets
&ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
&ds.worksheetId=0
Intégrer un rapport
Pour intégrer un rapport créé avec l'API Linking, définissez des paramètres d'URL et incluez le chemin d'accès /embed/. Une URL d'intégration de l'API Linking doit se présenter comme suit :
https://lookerstudio.google.com/embed/reporting/create?parameters
Trouver des ID et des alias
ID du rapport
Pour trouver l'ID du rapport :
- Ouvrez le rapport que vous souhaitez utiliser comme modèle. Inspectez l'URL du rapport. La partie comprise entre
reporting/et/pagecorrespond à l'ID du rapport. Par exemple, dans l'URL suivante,0B_U5RNpwhcE6SF85TENURnc4UjAcorrespond à l'ID du rapport :
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Alias de la source de données
Un rapport peut comporter plusieurs sources de données. Une source de données doit être référencée par son alias.
Pour trouver un alias de source de données :
- Modifiez le rapport.
- Dans la barre d'outils, sélectionnez Ressource > Gérer les nouvelles sources de données.
- Examinez la colonne Alias pour trouver des informations sur les alias de chaque source de données.
Vous pouvez modifier les noms d'alias pour assurer la rétrocompatibilité lorsqu'une source de données est ajoutée ou supprimée.
Type de connecteur
Un rapport peut comporter plusieurs sources de données, chacune étant créée en configurant un connecteur. Pour trouver le type de connecteur utilisé pour créer une source de données :
- Modifiez le rapport.
- Dans la barre d'outils, sélectionnez Ressource > Gérer les nouvelles sources de données.
- Examinez la colonne Type de connecteur pour identifier le connecteur utilisé pour créer une source de données.
Conseils et dépannage
Si vous rencontrez des difficultés, consultez les informations ci-dessous pour identifier les problèmes potentiels et les erreurs de configuration courantes.
Boîte de dialogue de débogage
Utilisez la boîte de dialogue de débogage pour examiner la configuration de l'API Linking telle qu'interprétée par Looker Studio. Cela peut vous aider à déboguer les problèmes liés à l'API.
- Lorsqu'une erreur est détectée lors de l'analyse de l'URL de l'API Linking, une boîte de dialogue s'affiche automatiquement avec des informations détaillées sur l'erreur.
- Lorsqu'une erreur se produit et qu'aucune boîte de dialogue ne s'affiche automatiquement, recherchez le bouton d'informations en haut à droite du rapport. Cliquez pour obtenir des informations de débogage supplémentaires.
- Si aucun bouton d'informations n'est disponible, vous pouvez l'activer en ajoutant le paramètre
&c.explain=trueà la fin de n'importe quelle URL de l'API Linking.
Autorisations
Assurez-vous que les autorisations de modèle appropriées sont définies pour les types de sources de données et la configuration de l'API Linking. Pour en savoir plus, consultez Autorisations des modèles.
Mise à jour ou remplacement
Si vous mettez à jour la configuration d'une source de données à partir d'un modèle de source de données, vérifiez la configuration de la source de données du modèle et celle de l'API Linking pour vous assurer qu'elles sont compatibles. Vérifiez que les champs générés par la nouvelle configuration sont compatibles avec les composants et la configuration du rapport.
Lors d'une mise à jour par rapport à un remplacement, il est possible de définir une configuration non valide avec un comportement indéfini. Pour en savoir plus, consultez Remplacer ou mettre à jour.
Actualiser les champs
Si vous avez configuré des noms, des types ou des agrégations de champs pour une source de données de modèle, ces modifications ne seront reportées sur une source de données configurée avec l'API Linking que si le paramètre ds.refreshFields est défini sur false.
Examinez le paramètre de source de données ds.refreshFields de l'URL de votre API Linking. Si vous l'omettez, vérifiez que la valeur par défaut du paramètre pour chaque type de connecteur est correcte pour votre cas d'utilisation.
En règle générale, si vous avez configuré des champs dans la source de données du modèle et que vous êtes certain que les nouvelles configurations de source de données via l'API Linking généreront toujours exactement les mêmes champs, il est recommandé de définir refreshFields sur false.
Par exemple, si lors de la création d'un modèle de rapport, Looker Studio identifie un champ de source de données particulier comme étant de type Nombre et que vous le remplacez par le type Année, cette modification de la configuration du champ fait désormais partie de la source de données du modèle. Tout graphique du modèle de rapport qui utilise le champ corrigé s'attend à recevoir une année. Si le graphique est basé sur le temps, il risque de ne pas s'afficher autrement. Si l'API Linking est utilisée pour fournir une nouvelle configuration de source de données qui génère exactement les mêmes champs, deux résultats sont possibles en fonction de la valeur du paramètre refreshFields :
Si la valeur est définie sur
true, la configuration des champs de la source de données du modèle ne sera pas reportée. Il est possible que les graphiques ne se chargent pas s'ils dépendent de la même configuration de champ (c'est-à-dire si un champ de type Année est attendu).Si la valeur est définie sur
false, la configuration des champs de la source de données du modèle sera reportée sur la nouvelle source de données. Les graphiques du rapport recevront les mêmes champs avec la même configuration et se chargeront correctement.
Commentaires et assistance
Utilisez Issue Tracker pour signaler les problèmes liés à l'API Linking ou pour envoyer des commentaires. Consultez Assistance pour obtenir des ressources générales sur l'aide et les questions.
Journal des modifications
2023-06-06
- Ajout des paramètres de rapport
r.measurementIdetr.keepMeasurementIdpour configurer le paramètre de rapport ID de mesure Google Analytics. - Ajout de
ds.keepDatasourceNamepour contrôler la réutilisation du nom de la source de données du modèle. - Ajout d'une section Intégrer un rapport.
- Connecteur BigQuery
- Ajout de
sqlReplace. Vous permet de spécifier des chaînes de modèle et de remplacement pour mettre à jour la requête SQL de la source de données du modèle.
- Ajout de
2023-05-22
- Ajout de la prise en charge du connecteur Looker.
- Ajout de la prise en charge des connecteurs de communauté.
2022-11-21
- Ajout de la possibilité d'utiliser un rapport vide. Consultez Utiliser un rapport vide ou par défaut.
- Ajout d'une section
refreshFieldsà Conseils et dépannage.
2022-11-14
- La référence du connecteur Surveys a été supprimée en raison de l'arrêt de Google Surveys.
2022-06-15
- Fin de la version bêta
- L'API Integration a été renommée API Linking.
- L'API Linking n'est plus en version bêta.
- Ajout du paramètre de contrôle
pageIdpour permettre la création de liens vers une page de rapport spécifique. - Ajout du paramètre de contrôle
modepour définir l'état du rapport sur le mode Affichage ou Édition au chargement. - Les configurations de sources de données peuvent désormais être entièrement remplacées ou partiellement mises à jour. Ce comportement est déterminé par la définition ou non du paramètre
ds.connector. Pour en savoir plus, consultez Remplacer ou mettre à jour. - Un modèle par défaut est désormais utilisé si aucun modèle de rapport n'est fourni à l'aide du paramètre
c.reportId. - Ajout du paramètre de source de données
ds.refreshFields. Cela vous permet de contrôler si les champs de la source de données sont actualisés lors du chargement d'une configuration de source de données. - Connecteur BigQuery
projectIdn'est pas obligatoire lorsquetypeest défini surCUSTOM_QUERY.- Lorsque
billingProjectIdn'est pas défini, le projet de facturation est remplacé parprojectIdou par le projet de la table interrogée. - Ajout de la prise en charge des tables partitionnées par date. Définissez le paramètre
isPartitionedsurtruepour utiliser le champ de partition en tant que dimension de plage de dates. - Ajout de la prise en charge des requêtes sur les tables partitionnées par date à l'aide du caractère générique ou du suffixe de table
YYYYMMDD. - Ajout de la possibilité d'interroger les tables Google Analytics, Firebase Analytics ou Crashlytics, et de sélectionner un modèle de champs.
- Google Sheets
- La valeur par défaut de
hasHeaderesttrue, ce qui correspond à la valeur par défaut de l'interface utilisateur Web. includeHiddenAndFilteredCelldivisé enincludeHiddenCellsetincludeFilteredCells. Les deux sont désormais définis par défaut surtrue, comme dans l'interface utilisateur Web.
- La valeur par défaut de
- Connecteur Search Console
- Le paramètre
propertyTypea été renommésearchType.
- Le paramètre
- Connecteur Enquêtes
surveyIdaccepte désormais un seul ID d'enquête ou une liste d'ID d'enquêtes séparés par une virgule.
2021-12-16
- Première version de l'API Integration.
- Permet de créer un lien vers un rapport existant et de définir son nom.
- Vous pouvez configurer plusieurs sources de données et définir le nom de chacune d'elles.
- Prise en charge des types de connecteurs suivants : BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Google Sheets, Google Surveys, Search Console.