Cette page a été traduite par l'API Cloud Translation.

API Linking

Introduction

L'API Linking permet de configurer un rapport Looker Studio et de le rediriger directement vers une URL via une interface fiable. Lorsque les utilisateurs suivent une URL de l'API Linking, ils bénéficient d'une expérience simplifiée pour consulter et interagir rapidement avec leurs données.

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 permet de fournir des rapports préconfigurés permettant à vos clients de consulter leurs données et d'interagir avec elles. Les principaux avantages de l'API Linking sont les suivants:

Un processus de création de rapports en un clic pour vos clients :
- 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 de nouveau à 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 à un workflow de produit.

Fonctionnement

Vous trouverez ci-dessous la manière dont 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 modèles de rapports et les sources de données, et met en forme une URL de l'API Linking. Le workflow classique pour les développeurs est le suivant:

Déterminez si vous souhaitez utiliser un rapport vide, le modèle de rapport par défaut fourni par Looker Studio, ou créer un rapport Looker Studio qui servira de modèle. Cela inclut la configuration des sources de données des modèles.
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 qui lui permet d'afficher les données auxquelles il a accès et d'interagir avec elles. Une expérience utilisateur type peut se présenter comme suit:

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 et d'un contrôle total sur sa propre copie du rapport. 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 exigences suivantes:

Un rapport, qui sert de modèle S'il n'est pas fourni, un rapport vide ou par défaut, fourni par Looker Studio, peut être utilisé.
Les utilisateurs d'une URL de l'API Linking doivent disposer au minimum d'un accès en lecture au modèle de rapport. En fonction du type de sources de données utilisées dans le rapport et de 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 la section Autorisations liées aux modèles.
Le type de connecteur de chaque source de données doit être compatible avec la configuration via l'API d'association. 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 respecter le format suivant:

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. Elle peut également être utilisée 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, d'autres sont facultatifs. Voici une liste de paramètres permettant de 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
`c.reportId`	Facultatif. ID du rapport du modèle. Looker Studio s'ouvre et configure le rapport spécifié. Pour savoir comment trouver cet ID, consultez ID du rapport. Si aucune valeur n'est spécifiée, un rapport vide ou un modèle de rapport par défaut est utilisé. Pour en savoir plus, consultez la section Utiliser un rapport vide ou par défaut.
`c.pageId`	Facultatif. ID de la page initiale à charger dans le rapport. La valeur par défaut est la première page du rapport si elle n'est pas spécifiée.
`c.mode`	Facultatif. Mode de rapport initial. `view` ou `edit`. Si aucune valeur n'est spécifiée, la valeur par défaut est `view`.
`c.explain`	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 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 du rapport

Les paramètres de rapport remplacent les propriétés de rapport.

Nom du paramètre Description

Nom du paramètre	Description
`r.reportName`	Facultatif. Définit le nom du rapport. Si aucune valeur n'est spécifiée, le nom par défaut est celui du modèle de rapport.
`r.measurementId`	Facultatif. Définit les ID de mesure Google Analytics sur Mesurer l'utilisation des rapports. Utilisez une virgule pour séparer les différents ID. Si `r.measurementId` et `r.keepMeasurementId` ne sont pas spécifiés, le paramètre du rapport ID de mesure Google Analytics n'est pas défini par défaut. Si `r.measurementId` et `r.keepMeasurementId` sont définis, `r.keepMeasurementId` est prioritaire pour définir l'ID.
`r.keepMeasurementId`	Facultatif. Définissez la valeur sur `true` pour utiliser le modèle de rapport ID de mesure Google Analytics. Si aucune valeur n'est spécifiée, la valeur par défaut est `false`. Si `r.measurementId` et `r.keepMeasurementId` ne sont pas spécifiés, le paramètre du rapport ID de mesure Google Analytics n'est pas défini par défaut. Si `r.measurementId` et `r.keepMeasurementId` sont définis, `r.keepMeasurementId` est prioritaire pour définir l'ID.

r.reportName

Facultatif. Définit le nom du rapport. Si aucune valeur n'est spécifiée, le nom par défaut est celui du modèle de rapport.

r.measurementId

Facultatif. Définit les ID de mesure Google Analytics sur Mesurer l'utilisation des rapports. Utilisez une virgule pour séparer les différents ID.

Si r.measurementId et r.keepMeasurementId ne sont pas spécifiés, le paramètre du rapport ID de mesure Google Analytics n'est pas défini par défaut. Si r.measurementId et r.keepMeasurementId sont définis, r.keepMeasurementId est prioritaire pour définir l'ID.

r.keepMeasurementId

Facultatif. Définissez la valeur sur true pour utiliser le modèle de rapport ID de mesure Google Analytics. Si aucune valeur n'est spécifiée, la valeur par défaut est false.

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 des sources de données vous permettent de définir une configuration de source de données et les données auxquelles les sources de données peuvent accéder dans le modèle de rapport.

Un alias permet de référencer une source de données dans un rapport existant. L'utilisation d'un alias permet une rétrocompatibilité si une source de données est ajoutée ou supprimée du modèle de rapport.

Pour savoir comment trouver une source de données alias, consultez Alias de la source de données.

Paramètres de source de données

Les paramètres suivants sont communs à tous les types de connecteurs:

Nom	Description
`ds.alias.datasourceName`	Facultatif. Définit le nom de la source de données. Si `ds.datasourceName` et `ds.keepDatasourceName` ne sont pas spécifiés, le nom de la source de données est défini par défaut selon une convention d'attribution de noms incluant le type de connecteur et l'heure de création (par exemple, échantillons – 12/12/21, 22h53). Si `ds.datasourceName` et `ds.keepDatasourceName` sont définis, `ds.datasourceName` est prioritaire pour définir le nom de la source de données.
`ds.alias.keepDatasourceName`	Facultatif. Définissez la valeur sur `true` pour utiliser le nom de la source de données du modèle. Si aucune valeur n'est spécifiée, la valeur par défaut est `false`. Si `ds.datasourceName` et `ds.keepDatasourceName` ne sont pas spécifiés, le nom de la source de données est défini par défaut selon une convention d'attribution de noms incluant le type de connecteur et l'heure de création (par exemple, échantillons – 12/12/21, 22h53). Si `ds.datasourceName` et `ds.keepDatasourceName` sont définis, `ds.datasourceName` est prioritaire pour définir le nom de la source de données.
`ds.alias.connector`	Facultatif. Type de connecteur de la source de données. Pour en savoir plus sur les types de connecteurs compatibles, consultez la documentation de référence 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 intégralement remplacée. S'il n'est pas spécifié, vous pouvez en indiquer plusieurs paramètres pour le type de connecteur dans l'URL de l'API Linking. La configuration de la source de données du modèle permettra de spécifier les paramètres non fournis dans l'URL de l'API Linking. Pour savoir comment identifier le type de connecteur du modèle de source de données, consultez Type de connecteur. Pour en savoir plus sur l'impact du paramètre `ds.connector` sur le remplacement de la configuration d'une source de données d'un modèle dans son intégralité ou sur son utilisation pour mettre à jour des paramètres non spécifiés, consultez la section Remplacer ou mettre à jour.
`ds.alias.refreshFields`	Facultatif. Définissez la valeur sur `true` pour utiliser la configuration de la source de données spécifiée via l'API Linking. Vous pourrez ainsi actualiser les champs de la source de données et mettre à jour les composants du rapport avec de nouvelles sélections de champs. `true` est généralement spécifié lors du changement de type de connecteur ou pour les types de connecteurs pour lesquels une modification de la configuration génère des champs différents (par exemple, les champs des sources de données BigQuery changent souvent avec des configurations de table différentes). Définissez la valeur sur `false` pour ne pas modifier les champs de la source de données par rapport au modèle de rapport. `false` est généralement spécifié lorsque la nouvelle configuration de données génère exactement les mêmes champs et que vous préférez conserver toutes les modifications de champ que vous avez apportées à la source de données du modèle. 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 le connecteur pour connaître les valeurs par défaut spécifiques au connecteur au cas où vous souhaiteriez remplacer le comportement par défaut. Éléments à prendre en compte lors de l'utilisation de `refreshFields`: Si `refreshFields` est défini sur `false` et que la configuration de la source de données spécifiée via l'API Linking génère des champs différents de ceux utilisés dans le modèle de rapport, l'utilisateur verra probablement une erreur de configuration pour les composants concernés. Les modifications apportées aux champs de la source de données modèle (nom, type, agrégation, etc.) ne sont pas reportées sur les nouvelles sources de données lorsque `refreshFields` est défini sur `true`. Définissez `refreshFields` sur `false` pour conserver les configurations des champs de la source de données du modèle. Les champs calculés et les paramètres définis dans les sources de données de modèle sont toujours copiés dans les nouvelles sources de données et ne sont pas affectés par la valeur de `refreshFields`.
`ds.alias.connectorParameters`	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 – Configurations des sources de données

Lorsque vous définissez des paramètres de source de données, la présence ou l'omission 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 détaille l'impact du paramètre ds.connector sur le remplacement de la configuration d'une source de données d'un modèle ou sur son utilisation pour mettre à jour des 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 intégralement 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 la section Paramètres obligatoires lorsque `ds.connector` est défini.	Lorsque vous modifiez le type de connecteur d'une source de données. Exemple : vous avez configuré une source de données BigQuery dans le modèle de rapport, mais souhaitez configurer une source de données Sheets via l'API Linking. Vous devrez alors définir une nouvelle configuration de connecteur dans son intégralité. Lorsque vous souhaitez garantir la configuration d'une source de données. Le remplacement de la configuration évite que des valeurs inconnues soient éventuellement utilisées à partir de la source de données du modèle.
Non	Mettre à jour La configuration de la source de données du modèle permettra de spécifier les paramètres non fournis dans l'URL de l'API Linking. Sauf indication contraire, tous les paramètres de connecteur pour le type de connecteur sont facultatifs. Cela simplifie l'URL de l'API Linking. Cette approche est généralement recommandée lorsque vous maîtrisez la configuration de la source de données d'un modèle et que vous ne souhaitez remplacer qu'un sous-ensemble de paramètres.	Lorsque vous souhaitez uniquement fournir des valeurs de paramètres qui diffèrent de celles du modèle de source de données et que vous acceptez de vous fier à la source de données du modèle pour tout paramètre de connecteur non spécifié. Par exemple, vous pouvez modifier uniquement l'ID du projet de facturation d'une configuration de source de données BigQuery et utiliser la configuration de modèle pour tous les autres 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 obligatoires doivent l'être. Si le paramètre ds.connector de la source de données n'est pas spécifié, tous les paramètres de connecteur, même ceux désignés comme obligatoires, peuvent être considérés comme facultatifs, sauf indication contraire.

Exemples

Configure un rapport avec une seule source de données BigQuery (ds0) et remplace l'intégralité de 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

Vous pouvez omettre l'alias de la source de données 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 ne met à jour que 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

Permet de configurer 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 remplacée dans son intégralité, 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 mises à jour apportées à la source de données affectent tous les rapports ensemble. Lorsque vous créez un rapport avec l'API Linking, vous pouvez ajouter à nouveau une source de données à partir de votre modèle de rapport 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 alias.
L'URL n'utilise pas d'alias de caractère générique (voir Caractère générique d'alias de la 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, sinon la connexion ne fonctionnera pas. En ajoutant de 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 de leurs nouveaux rapports.

Caractère générique de l'alias de la 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 s'avérer utile pour supprimer les paramètres répétitifs de votre URL. Par exemple, si vous avez un modèle associé à trois sources de données BigQuery et que vous souhaitez remplacer projectId et datasetId dans chacune d'entre elles, tout en conservant tableId, vous pouvez l'écrire comme suit:

  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 les paramètres qui le sont. 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, voici l'ordre de priorité des paramètres:

Paramètre indiqué avec 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, si elle est facultative.

Documentation de référence sur les connecteurs

L'API Linking est compatible avec les configurations et connecteurs suivants. Pour chaque connecteur, la liste des paramètres de source de données disponibles est fournie.

BigQuery

Le connecteur BigQuery accepte deux types de requêtes : une requête TABLE, dans laquelle vous indiquez l'ID de la table à interroger, et une requête CUSTOM_QUERY, dans laquelle 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
`ds.alias.connector`	Facultatif. Définissez la valeur sur `bigQuery` pour le connecteur BigQuery. Si cet attribut est défini, il remplace la source de données par la configuration BigQuery fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.type`	Obligatoire** : type de requête. Défini sur `TABLE`.
`ds.alias.projectId`	Obligatoire** : ID du projet de la table à interroger.
`ds.alias.datasetId`	Obligatoire** : ID de l'ensemble de données de la table à interroger.
`ds.alias.tableId`	Obligatoire** : ID de table de la table à interroger. Date des tables segmentées : Le suffixe * (caractère générique) ou `YYYYMMDD` est accepté lorsque vous interrogez des tables segmentées par date. Si une table est identifiée comme étant Google Analytics, Firebase Analytics ou Firebase Crashlytics, un modèle de champs par défaut sera sélectionné, sauf si vous en indiquez un. Consultez les paramètres liés à la table fields template.
`ds.alias.billingProjectId`	Facultatif. ID du projet à utiliser pour la facturation. Si ce champ n'est pas défini, `projectId` est utilisé.
`ds.alias.isPartitioned`	Facultatif. Définissez la valeur sur `true` si la table est partitionnée et que vous souhaitez utiliser la colonne de partitionnement en tant que dimension de plage de dates. Cela ne s'applique qu'au partitionnement temporel (par exemple, à l'aide d'une colonne de partitionnement en fonction du 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 par défaut est `false`. Pour en savoir plus, consultez la section Présentation des tables partitionnées.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Modèle de champs pour Google Analytics, Firebase Analytics et Crashlytics

Pour les tables identifiées 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 sera sélectionné.

Nom	Description
`ds.alias.gaTemplateLevel`	Facultatif. Modèle de champs Google Analytics à utiliser. Applicable uniquement lorsqu'une exportation BigQuery pour Google Analytics est interrogée. Au choix : `ALL`, `SESSION` ou `HITS`. Pour les tables Google Analytics, la valeur par défaut est `ALL` si aucune valeur n'est spécifiée.
`ds.alias.firebaseTemplateLevel`	Facultatif. Modèle de champs Firebase Analytics à utiliser. Applicable uniquement lorsqu'une table BigQuery Export pour Firebase Analytics est interrogée. Ne peut être défini que sur `EVENTS`. Pour les tables Firebase Analytics, la valeur par défaut `EVENTS` n'est pas spécifiée.
`ds.alias.crashlyticsTemplateLevel`	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 aucune valeur n'est spécifiée.

Requêtes PERSONNALISÉES

Les paramètres suivants sont applicables lorsque type est défini sur CUSTOM_QUERY et que vous fournissez une instruction SQL pour interroger une table.

Nom du paramètre	Description
`ds.alias.connector`	Facultatif. Définissez la valeur sur `bigQuery` pour le connecteur BigQuery. Si cet attribut est défini, il remplace la source de données par la configuration BigQuery fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.type`	Obligatoire** : type de requête. Défini sur `CUSTOM_QUERY`.
`ds.alias.sql`	Obligatoire** : Requête SQL à exécuter.
`ds.alias.billingProjectId`	Facultatif. ID du projet à utiliser pour la facturation. Si ce champ n'est pas défini, `projectId` est utilisé. Si `projectId` n'est pas défini, le projet de la table interrogée est utilisé.
`ds.alias.sqlReplace`	Facultatif. Liste de modèles et de chaînes de remplacement séparés par une virgule à appliquer à la requête SQL. Le remplacement de chaîne n'est appliqué qu'en cas de correspondance de modèle. Utilisez une virgule pour séparer les paires de modèle et de chaîne de remplacement. Par exemple, `stringPattern1,replacementString1, stringPattern2,replacementString2`.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemples

Une configuration de type TABLE dans laquelle 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

Une configuration de type TABLE pour interroger une table segmentée par date en utilisant le suffixe du 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_*

Une configuration de type TABLE pour interroger une table segmentée par date avec le 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

Une 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

Une configuration de type TABLE pour interroger une table partitionnée par date d'ingestion et utiliser la colonne de partitionnement en tant que 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

Une configuration de type CUSTOM_QUERY dans laquelle les requêtes sont définies 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

Une configuration de type CUSTOM_QUERY dans laquelle seule l'instruction SQL est mise à jour et le modèle de source de données est utilisé 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

Une configuration de type CUSTOM_QUERY dans laquelle l'instruction SQL de la source de données 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
`ds.alias.connector`	Facultatif. Défini sur `cloudSpanner` pour le connecteur Cloud Spanner. Si ce champ est défini, il remplace la source de données par la configuration Cloud Spanner fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.projectId`	Obligatoire** : ID du projet.
`ds.alias.instanceId`	Obligatoire** : ID de l'instance.
`ds.alias.databaseId`	Obligatoire** : ID de la base de données.
`ds.alias.sql`	Obligatoire** : Requête SQL à exécuter.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemple

Une 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
`ds.alias.connector`	Facultatif. Défini sur `community` pour un connecteur de communauté. Si cet indicateur est défini, il remplace la source de données par la configuration du connecteur de communauté fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.connectorId`	Obligatoire** : connecteur de communauté `connectorId` (également appelé `deploymentId`).
`ds.alias.parameters`	Facultatif. Paramètres supplémentaires propres au connecteur, tels que définis par sa configuration.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section 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
`ds.alias.connector`	Facultatif. Définissez cette valeur sur `googleAnalytics` pour le connecteur Google Analytics. Si cet attribut est défini, il remplace la source de données par la configuration Google Analytics fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.accountId`	Obligatoire** : ID du compte.
`ds.alias.propertyId`	Obligatoire** : ID de la propriété.
`ds.alias.viewId`	ID de la vue. Obligatoire** pour les propriétés Universal Analytics. Ne le définissez pas pour les propriétés Google Analytics 4.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `false` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section 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
`ds.alias.connector`	Facultatif. Défini sur `googleCloudStorage` Connecteur Google Cloud Storage. Si ce champ est défini, il remplace la source de données par la configuration Google Cloud Storage fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.pathType`	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 indiqué.
`ds.alias.path`	Obligatoire** : chemin d'accès au fichier (par exemple, MyBucket/MyData/MyFile.csv) si `pathType` est `FILE` ou au chemin d'accès au dossier (par exemple, *MyBucket/MyData) si `pathType` est `FOLDER`.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemple

Une 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

Une 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
`ds.alias.connector`	Facultatif. Définissez la valeur sur `googleSheets` pour le connecteur Google Sheets. Si ce champ est défini, il remplace la source de données par la configuration Google Sheets fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.spreadsheetId`	Obligatoire** : ID de la feuille de calcul.
`ds.alias.worksheetId`	Obligatoire** : ID de la feuille de calcul.
`ds.alias.hasHeader`	Facultatif. Définissez la valeur sur `true` pour utiliser la première ligne comme en-têtes. Si aucune valeur n'est spécifiée, la valeur par défaut est `true`. 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.
`ds.alias.includeHiddenCells`	Facultatif. Définissez la valeur sur `true` pour inclure les cellules masquées. Si aucune valeur n'est spécifiée, la valeur par défaut est `true`.
`ds.alias.includeFilteredCell`	Facultatif. Définissez la valeur sur `true` pour inclure les cellules filtrées. Si aucune valeur n'est spécifiée, la valeur par défaut est `true`.
`ds.alias.range`	Facultatif. Plage (par exemple, A1:B52).
`ds.alias.refreshFields`	Facultatif. Prend la valeur `true` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemples

Une configuration Google Sheets:

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

Voici une configuration Google Sheets avec la première ligne utilisée pour les en-têtes et les cellules masquées et filtrées:

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

Une 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
`ds.alias.connector`	Facultatif. Définissez la valeur sur `looker` pour le connecteur Looker. Si ce champ est défini, il remplace la source de données par la configuration Looker fournie. Consultez Remplacer ou mettre à jour.
`ds.alias.instanceUrl`	Obligatoire** : URL de l'instance Looker.
`ds.alias.model`	Obligatoire** Modèle Looker.
`ds.alias.explore`	Obligatoire** L'exploration Looker.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `false` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemple

Connexion à 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
`ds.alias.connector`	Facultatif. Définissez cette valeur sur `searchConsole` pour le connecteur Search Console. Si cet attribut est défini, il remplace la source de données par la configuration fournie dans la Search Console. Consultez Remplacer ou mettre à jour.
`ds.alias.siteUrl`	Obligatoire** : URL du site. Pour une propriété de domaine, ajoutez le préfixe `sc-domain\:`.
`ds.alias.tableType`	Obligatoire** Définit le type de table. Il peut s'agir de `SITE_IMPRESSION` ou `URL_IMPRESSION`.
`ds.alias.searchType`	Obligatoire** Définit le type de recherche. Il peut s'agir de `WEB`, `IMAGE`, `VIDEO` ou `NEWS`.
`ds.alias.refreshFields`	Facultatif. Prend la valeur `false` par défaut s'il n'est pas spécifié. Pour en savoir plus, consultez la section refreshFields.

Exemple

Configuration de la 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 de la 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 liées aux modèles

Pour garantir la meilleure expérience utilisateur possible, il est important de définir correctement les autorisations d'accès aux rapports pour votre modèle de rapport et les sources de données associées. Les autorisations requises varient selon 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 pour remplacer ou mettre à jour une configuration de source de données.

Le tableau suivant indique les accès recommandés aux sources de données pour une expérience utilisateur optimale en fonction des sources de données des modèles 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 pour les autorisations liées aux sources de données	Notes
Imbriqué	Remplacez	N/A : l'accès en lecture sera hérité du rapport.	Si l'utilisateur dispose d'un accès en lecture au modèle de rapport, il dispose automatiquement d'un accès en lecture à toutes les sources de données intégrées.
Imbriqué	Mettre à jour	N/A : l'accès en lecture sera hérité du rapport.	Si l'utilisateur dispose d'un accès en lecture au modèle de rapport, il dispose automatiquement d'un accès en lecture à toutes les sources de données intégrées.
Réutilisable	Remplacez	L'utilisateur n'a pas besoin d'un accès en lecture.	Étant donné que la configuration de la source de données est entièrement remplacée via l'API Linking, l'accès en lecture n'est pas requis.
Réutilisable	Mettre à jour	L'utilisateur a besoin d'un accès en lecture.	L'accès en lecture à la source de données est nécessaire pour que l'API Linking puisse lire et utiliser la configuration à partir de la source de données du modèle. Si les utilisateurs ne disposent pas d'un accès en lecture, ils recevront 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 commande reportId Définissez les paramètres de la source de données (ds). Notes

Rapport vide Non Non

Rapport par défaut

Non

Oui

Type de rapport	Définir le paramètre de commande `reportId`	Définissez les paramètres de la source de données (`ds`).	Notes
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 comporte une seule source de données intégrée.

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 comporte une seule source de données intégrée.

Les exemples suivants présentent différentes URL de l'API Linking qui utilisent un rapport vide ou par défaut.

Lancez le workflow de création de rapport 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 son nom:

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 les paramètres d'URL et incluez le chemin /embed/. Une URL d'intégration de l'API Linking doit respecter le format suivant:

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

Rechercher des identifiants 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 /page correspond à l'ID du rapport. Par exemple, dans l'URL suivante, 0B_U5RNpwhcE6SF85TENURnc4UjA est l'ID du rapport:

https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M

Barre d'adresse du navigateur affichant l'URL d'un rapport Looker Studio.
L'ID du rapport est mis en surbrillance. — Trouvez l'ID du rapport dans l'URL du rapport.

Alias de la source de données

Un rapport peut avoir 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 afin de trouver des informations sur les alias pour 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.

Liste des sources de données sur la page "Gestion des ressources des sources de données".
La colonne "Alias" est mise en surbrillance. — Recherchez l'alias de la source de données sur la page de gestion des *sources de données*.

Type de connecteur

Un rapport peut comporter plusieurs sources de données, chacune 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.

Liste des sources de données sur la page "Gestion des ressources des sources de données".
La colonne "Type de connecteur" est encadrée. — Recherchez le type de connecteur de source de données sur la page de gestion *Sources 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 vérifier la configuration de l'API Linking telle qu'elle est interprétée par Looker Studio. Cela peut vous aider à résoudre les problèmes liés à l'API.

Lorsqu'une erreur se produit lors de l'analyse de l'URL de l'API Linking, une boîte de dialogue contenant des détails sur l'erreur s'affiche automatiquement.
Lorsqu'une erreur se produit et qu'aucune boîte de dialogue ne s'affiche automatiquement, recherchez le bouton d'information en haut à droite du rapport. Cliquez pour obtenir des informations de débogage supplémentaires.
Si aucun bouton d'information n'est disponible, vous pouvez activer le bouton en ajoutant le paramètre &c.explain=true à la fin de n'importe quelle URL de l'API Linking.

Autorisations

Vérifiez que vous disposez des autorisations de modèle appropriées pour les types de sources de données et la configuration de l'API Linking. Pour en savoir plus, consultez la section Autorisations liées aux modèles.

Mettre à jour ou remplacer

Si vous mettez à jour la configuration d'une source de données à partir d'un modèle de source de données, examinez la configuration du modèle et 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 la configuration et les composants du rapport.

Lorsque vous effectuez une mise à jour ou un remplacement, il est possible de définir une configuration non valide avec un comportement non défini. Pour en savoir plus, consultez la section Remplacer ou mettre à jour.

Actualiser les champs

Si vous avez configuré des noms de champs, des types ou des agrégations pour un modèle de source de données, ces modifications ne seront reportées dans une source de données configurée par 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 l'API d'association. Si cette valeur est omise, vérifiez que la valeur par défaut du paramètre de chaque type de connecteur est adaptée à 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 sûr que les nouvelles configurations de la source de données via l'API Linking généreront toujours 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 en tant que type Number et que vous le remplacez par le type Year, cette modification de configuration de 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é nécessite une année. Si le graphique est basé sur le temps, il risque de ne pas s'afficher autrement. Si vous utilisez l'API Linking pour fournir une nouvelle configuration de source de données qui génère exactement les mêmes champs, deux résultats sont possibles selon la valeur du paramètre refreshFields:

Si elle est définie sur true, la configuration des champs de la source de données du modèle n'est pas reportée, et le chargement des graphiques peut échouer s'ils dépendent de la même configuration de champ (par exemple, un champ de type Year est attendu).
Si la valeur est false, la configuration des champs de la source de données du modèle sera reportée sur la nouvelle source de données et les graphiques de rapport recevront les mêmes champs avec la même configuration et seront chargés avec succès.

Commentaires et assistance

Utilisez Issue Tracker pour signaler des problèmes liés à l'API Linking ou envoyer des commentaires. Consultez l'assistance pour accéder à des ressources générales permettant d'obtenir de l'aide et de poser des questions.

Journal des modifications

2023-06-06

Ajout des paramètres de rapport r.measurementId et r.keepMeasurementId pour configurer le paramètre de rapport ID de mesure Google Analytics.
Ajout de ds.keepDatasourceName pour contrôler la réutilisation du nom de la source de données du modèle.
Ajout d'une section Intégrer le rapport.
Connecteur BigQuery
- Ajout de sqlReplace. 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.

2023-05-22

Ajout de la compatibilité avec le connecteur Looker.
Ajout de la compatibilité avec les 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 au 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 d'association.
- L'API Linking n'est plus disponible en version bêta.
Ajout du paramètre de commande pageId pour permettre l'association à une page de rapport spécifique.
Ajout du paramètre de commande mode pour définir l'état du rapport sur Vue ou Édition lors du chargement.
Les configurations des sources de données peuvent désormais être entièrement 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 la section 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
- projectId n'est pas obligatoire lorsque type est défini sur CUSTOM_QUERY.
- Si billingProjectId n'est pas défini, le projet de facturation utilise projectId ou le projet de la table interrogée.
- Ajout de la prise en charge des tables partitionnées par date. Définissez le paramètre isPartitioned sur true pour utiliser le champ de partition en tant que dimension de plage de dates.
- Ajout de la possibilité d'interroger des 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 des tables Google Analytics, Firebase Analytics ou Crashlytics, et de sélectionner un modèle de champs.
Google Sheets
- hasHeader est défini par défaut sur true, comme c'est le cas pour l'interface utilisateur Web par défaut.
- includeHiddenAndFilteredCell divisé en includeHiddenCells et
- includeFilteredCells. Les deux valeurs par défaut sont désormais true, conformément aux valeurs par défaut de l'interface utilisateur Web.
Connecteur Search Console
- Le paramètre propertyType a été renommé searchType.
Connecteur Surveys
- surveyId accepte désormais un seul ID d'enquête ou une liste d'ID d'enquête séparés par une virgule.

2021-12-16

Version initiale de l'API Integration.
- Permet de créer des liens vers un rapport existant et de définir le nom du rapport.
- Vous pouvez configurer plusieurs sources de données et définir le nom de chaque source de données.
- Compatibilité avec les types de connecteurs suivants: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Google Sheets, Google Surveys et Search Console.

API Linking

Introduction

Cas d'utilisation et avantages

Fonctionnement

Workflow de développement de l'API Linking

Expérience utilisateur de l'API Linking

Conditions requises

Paramètres d'URL

Paramètres de contrôle

Paramètres du rapport

Paramètres de source de données

Paramètres de source de données

Remplacer ou mettre à jour – Configurations des sources de données

Paramètres obligatoires lorsque ds.connector est défini

Exemples

Créer ou ajouter

Caractère générique de l'alias de la source de données

Documentation de référence sur les connecteurs

BigQuery

Requêtes TABLE

Modèle de champs pour Google Analytics, Firebase Analytics et Crashlytics

Requêtes PERSONNALISÉES

Cloud Spanner

Connecteurs de communauté

Google Analytics

Google Cloud Storage

Google Sheets

Looker

Search Console

Autorisations liées aux modèles

Utiliser un rapport vide ou par défaut

Intégrer un rapport

Rechercher des identifiants et des alias

ID du rapport

Alias de la source de données

Type de connecteur

Conseils et dépannage

Boîte de dialogue de débogage

Autorisations

Mettre à jour ou remplacer

Actualiser les champs

Commentaires et assistance

Journal des modifications

2023-06-06

2023-05-22

2022-11-21

2022-11-14

2022-06-15

2021-12-16

Paramètres obligatoires lorsque `ds.connector` est défini