Gérer les fiches

En tant qu'éditeur Analytics Hub, vous pouvez effectuer les tâches suivantes :

  • Créez des fiches dans un échange de données pour lequel vous disposez d'un accès en publication.
  • Mettez à jour, supprimez, partagez et affichez les métriques d'utilisation des fiches.
  • Gérez différents rôles pour vos fiches Analytics Hub, tels que les administrateurs, les abonnés et les lecteurs de fiches.
  • Affichez tous les abonnés qui se sont abonnés à votre fiche.
  • Surveillez l'utilisation de vos fiches.
  • Supprimez des abonnés de votre fiche.

Une fiche est une référence à un ensemble de données partagé qu'un éditeur répertorie dans un échange de données. Une fiche peut être de deux types selon la stratégie IAM (Identity and Access Management) définie pour la fiche et pour le type d'échange de données qui la contient :

Avant de commencer

Pour commencer à utiliser Analytics Hub, vous devez activer l'API Analytics Hub dans votre projet Google Cloud.

Autorisations requises

Pour activer l'API Analytics Hub, vous devez disposer des autorisations IAM (Identity and Access Management) suivantes :

  • serviceUsage.services.get
  • serviceUsage.services.list
  • serviceUsage.services.enable

Le rôle IAM prédéfini suivant inclut les autorisations dont vous avez besoin pour activer l'API Analytics Hub :

  • roles/serviceusage.serviceUsageAdmin

Pour en savoir plus sur les rôles IAM dans BigQuery, consultez la page Rôles prédéfinis et autorisations.

Activer l'API Analytics Hub

Pour activer l'API Analytics Hub, procédez comme suit :

Console

Accédez à l'API Analytics Hub pour votre projet Google Cloud et activez-la.

Activer l'API Analytics Hub

gcloud

Exécutez la commande gcloud services enable :

gcloud services enable analyticshub.googleapis.com

Autorisations requises

Pour gérer les listes et les abonnements, vous devez disposer de l'un des rôles Analytics Hub suivants :

  • Le rôle Éditeur Analytics Hub (roles/analyticshub.publisher) vous permet de créer, mettre à jour, supprimer et définir des stratégies IAM sur vos fiches.

  • Le rôle Administrateur de la fiche Analytics Hub (roles/analyticshub.listingAdmin) vous permet de mettre à jour, de supprimer et de définir des stratégies IAM sur vos fiches.

  • Le rôle Administrateur Analytics Hub (roles/analyticshub.Admin) vous permet de créer, mettre à jour, supprimer et définir des stratégies IAM sur toutes les fiches de votre échange de données.

Pour en savoir plus, consultez la section Rôles utilisateur Analytics Hub. Pour savoir comment attribuer ces rôles à d'autres utilisateurs, consultez la section Créer un administrateur de fiche.

En outre, pour créer des fiches, vous devez également disposer des autorisations bigquery.datasets.get et bigquery.datasets.update pour les ensembles de données pour lesquels vous souhaitez créer des fiches. Les rôles prédéfinis BigQuery suivants disposent de l'autorisation bigquery.datasets.update.

  • Rôle Propriétaire de données BigQuery (roles/bigquery.dataOwner)
  • Rôle d'administrateur BigQuery (roles/bigquery.admin)

Pour afficher tous les échanges de données entre les projets d'une organisation à laquelle vous avez accès, vous devez disposer de l'autorisation resourcemanager.organizations.get. Aucun rôle prédéfini BigQuery ne contient cette autorisation. Vous devez donc utiliser un rôle personnalisé IAM.

Afficher les échanges de données

Pour afficher la liste des échanges de données de votre organisation auxquels vous avez accès, consultez la page Afficher les échanges de données. Si l'échange de données se trouve dans une autre organisation, l'administrateur Analytics Hub doit partager un lien vers cet échange de données avec vous.

Création d'une fiche

Une fiche est une référence à un ensemble de données partagé répertorié par un éditeur dans un échange de données.

Pour créer une fiche, procédez comme suit :

Console

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

    Une page qui répertorie tous les échanges de données auxquels vous pouvez accéder s'affiche.

  2. Cliquez sur le nom de l'échange de données dans lequel vous souhaitez créer la fiche.

  3. Cliquez sur Créer une fiche.

  4. Sur la page Créer une fiche, dans Nom à afficher, saisissez le nom de la fiche.

  5. Si vous créez une fiche commerciale, vous devez renseigner le champ Contact pour demander l'accès. Vous devez saisir une adresse e-mail ou une URL du formulaire de participation pour que les abonnés puissent vous contacter.

  6. Facultatif : saisissez les informations suivantes :

    • Contact principal : saisissez une adresse e-mail ou une URL du contact principal pour la fiche.

    • Catégorie : sélectionnez jusqu'à deux catégories qui représentent le mieux votre fiche. Les abonnés peuvent filtrer les fiches en fonction de ces catégories.

    • Fournisseur : développez la section Fournisseur et spécifiez les détails dans les champs suivants :

      • Nom du fournisseur : nom du fournisseur de l'ensemble de données.
      • Contact principal du fournisseur : adresse e-mail ou URL du contact principal du fournisseur d'ensemble de données.

      Les abonnés peuvent filtrer les fiches en fonction des fournisseurs de données.

    • Éditeur : développez la section Éditeur et spécifiez les détails dans les champs suivants :

      • Nom de l'éditeur : nom de l'éditeur qui crée la fiche.
      • Contact principal de l'éditeur : adresse e-mail ou URL du contact principal de l'éditeur de l'ensemble de données.

    • Icône : icône pour votre fiche. Les formats de fichiers PNG et JPEG sont acceptés. Les icônes doivent avoir une taille de fichier inférieure à 512 KiB et des dimensions ne dépassant pas 512 x 512 pixels.

    • Description : brève description de votre fiche. Les abonnés peuvent rechercher des fiches en fonction de la description.

  7. Dans Source dataset (Ensemble de données source), sélectionnez l'ensemble de données que vous souhaitez répertorier dans l'échange de données. L'ensemble de données source doit se trouver dans la même région que l'échange de données. Vous ne pouvez pas mettre à jour ce champ après la création de la fiche.

  8. Dans Sortie de données, sélectionnez l'option appropriée sortie de données. Seuls les abonnés disposant d'offres hors édition ou de l'édition Enterprise Plus peuvent interroger des données avec des restrictions de sortie des données.

    • Pour appliquer des restrictions de sortie des données sur votre ensemble de données partagé, mais pas sur les résultats de requête de votre ensemble de données partagé, sélectionnez Désactiver la copie et l'exportation des données partagées.
    • Pour appliquer des restrictions de sortie des données à votre ensemble de données partagé et des résultats de requête de votre ensemble de données partagé, sélectionnez Désactiver la copie et l'exportation des résultats de requête qui définit également automatiquement Désactiver la copie et l'exportation des données partagées.
    • Pour appliquer des restrictions de sortie de copie et d'exportation de l'API de données à votre ensemble de données partagé, sélectionnez Désactiver la copie et l'exportation de tables via les API, qui définira également automatiquement Désactiver la copie et l'exportation des données partagées.

  9. Facultatif : dans la section Détails de la fiche, cliquez sur le bouton Visibilité publique pour activer la visibilité publique. Vous devez attribuer le rôle Lecteur Analytics Hub (roles/analyticshub.viewer) à allUsers ou allAuthenticatedUsers. Pour en savoir plus, consultez la section Accorder le rôle pour une fiche. Si l'échange est déjà public, les autorisations de fiche sont déjà héritées et aucune autre action n'est requise.

    Les échanges visibles publiquement ne peuvent pas comporter de fiches privées en raison de l'héritage des autorisations. En revanche, les échanges privés peuvent comporter des fiches publiques. Pour que des fiches publiques soient créées, le projet dans lequel se trouvent les fiches de données doit être associé à une organisation et un compte de facturation.

  10. Facultatif : Dans la section Documentation > Markdown, vous pouvez saisir des informations supplémentaires, telles que des exemples de requêtes que vous pouvez exécuter sur l'ensemble de données, ainsi que des liens vers la documentation appropriée et toute information supplémentaire pouvant aider les abonnés à utiliser votre ensemble de données.

  11. Cliquez sur Enregistrer.

API

Exécutez la méthode projects.locations.dataExchanges.listings.create.

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings?listingId=LISTING_ID

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet contenant l'échange de données dans lequel vous souhaitez créer la liste.
  • LOCATION : emplacement de votre échange de données. Pour en savoir plus sur les emplacements compatibles avec Analytics Hub, consultez la page Régions compatibles.
  • DATAEXCHANGE_ID : ID de l'échange de données
  • LISTING_ID : ID de la liste.

Dans le corps de la requête, indiquez les informations détaillées sur la fiche. Si la requête aboutit, le corps de la réponse contient des détails de la fiche.

Pour plus d'informations sur les tâches que vous pouvez effectuer sur des listes à l'aide des API, consultez la documentation sur les méthodes projects.locations.dataExchanges.listings.

Autoriser les utilisateurs à accéder à une fiche

Si vous souhaitez autoriser des utilisateurs à accéder à une fiche privée, vous devez définir une stratégie IAM pour une personne ou un groupe associé à cette fiche. Pour une fiche commerciale, votre échange de données doit être public. Les listes d'un échange de données public apparaissent dans Analytics Hub pour tous les utilisateurs.Utilisateurs Google Cloud (allAuthenticatedUsers). Pour permettre aux utilisateurs de demander l'accès à des fiches commerciales, vous devez leur accorder le rôle Lecteur Analytics Hub.

Si vous souhaitez que votre fiche soit accessible à tous, y compris aux personnes qui n'utilisent pas Google Cloud, vous devez attribuer à allUsers le rôle "Lecteur Analytics Hub" (roles/analyticshub.viewer).

Pour permettre aux utilisateurs d'afficher votre fiche ou de s'y abonner, procédez comme suit:

Console

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

  2. Cliquez sur le nom de l'échange de données contenant la fiche.

  3. Cliquez sur la fiche pour laquelle vous souhaitez ajouter des abonnés.

  4. Cliquez sur Définir les autorisations.

  5. Pour ajouter des comptes principaux, cliquez sur Ajouter un compte principal.

  6. Dans le champ Nouveaux comptes principaux, ajoutez les informations suivantes en fonction du type de fiche :

    • Pour une fiche privée, saisissez les adresses e-mail de l'identité à laquelle vous souhaitez accorder l'accès.

    • Pour une fiche publique, ajoutez allAuthenticatedUsers.

    • Pour une fiche publique visible par tous, y compris les utilisateurs autres que Google Cloud, ajoutez allUsers.

  7. Pour Select a role (Sélectionner un rôle), maintenez le pointeur sur Analytics Hub, puis en fonction du type de fiche, sélectionnez l'un des rôles suivants :

    Pour en savoir plus, consultez la section Rôles d'abonné et de lecteur Analytics Hub.

  8. Cliquez sur Enregistrer.

API

  1. Lisez la stratégie existante à l'aide de la méthode getIamPolicy de la liste en utilisant la méthode projects.locations.dataExchanges.listings.getIamPolicy :

    POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:getIamPolicy

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet, par exemple my-project-1
    • LOCATION : emplacement de l'échange de données contenant la liste
    • DATAEXCHANGE_ID : ID de l'échange de données
    • LISTING_ID : ID de la liste.

    Analytics Hub affiche la stratégie actuelle dans la réponse.

  2. Pour ajouter ou supprimer des membres et les rôles qui leur sont associés, modifiez la stratégie à l'aide d'un éditeur de texte. Utilisez le format suivant pour ajouter des membres :

    • user:test-user@gmail.com
    • group:admins@example.com
    • serviceAccount:test123@example.domain.com
    • domain:example.domain.com

    Par exemple, pour accorder le rôle roles/analyticshub.subscriber à group:subscribers@example.com, ajoutez la liaison suivante à la stratégie :

    {
 "members": [
   "group:subscribers@example.com"
 ],
 "role":"roles/analyticshub.subscriber"
}

  3. Écrivez la stratégie mise à jour à l'aide de la méthode projects.locations.dataExchanges.listings.setIamPolicy. Dans le corps de la requête, indiquez la stratégie IAM mise à jour de l'étape précédente.

    POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:setIamPolicy

    Dans le corps de la requête, indiquez les informations détaillées relatives à la liste demandée. Si la requête aboutit, le corps de la réponse contient des détails de la liste.

Pour plus d'informations sur les tâches que vous pouvez effectuer sur des listes à l'aide des API, consultez la documentation sur les méthodes projects.locations.dataExchanges.listings.

Créer une URL non authentifiée pour une fiche publique

Pour créer une URL de fiche Analytics Hub non authentifiée et visible même par les utilisateurs autres que Google Cloud, procédez comme suit :

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

    Une page qui répertorie tous les échanges de données auxquels vous pouvez accéder s'affiche.

  2. Cliquez sur le nom de l'échange de données contenant la fiche.

  3. Cliquez sur le nom à afficher pour afficher les détails de la fiche. La visibilité publique doit être activée sur la fiche.

  4. Cliquez sur Copier le lien public pour générer une URL de fiche non authentifiée. Assurez-vous que cette fiche accorde à allUsers le rôle "Lecteur Analytics Hub" (roles/analyticshub.viewer).

Créer un administrateur de fiche

Pour permettre aux utilisateurs de gérer les fiches, vous devez créer des administrateurs de fiches Analytics Hub. Pour créer des administrateurs de fiches, vous devez attribuer aux utilisateurs le rôle Éditeur Analytics Hub ou Administrateur des fiches Analytics Hub au niveau de la fiche. Pour savoir comment attribuer ces rôles à une fiche, consultez la page Accorder le rôle pour une fiche.

Voir tous les abonnements

Pour afficher tous les abonnements actuels de votre fiche, sélectionnez l'une des options suivantes :

Console

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

  2. Cliquez sur le nom de l'échange de données contenant la fiche pour laquelle vous souhaitez gérer les abonnements.

  3. Cliquez sur la fiche pour laquelle vous souhaitez répertorier tous les abonnés.

  4. Pour afficher tous les abonnés de votre fiche, cliquez sur Gérer les abonnements.

    Gérer vos abonnés

  5. Facultatif : vous pouvez filtrer les résultats en fonction des informations sur les abonnés.

Si vous avez accès à l'ensemble de données partagé, vous pouvez également suivre la procédure ci-dessous pour répertorier les abonnés :

  1. Accédez à la page BigQuery.

    Accéder à BigQuery

  2. Dans le volet Explorateur, développez votre projet et sélectionnez l'ensemble de données partagé.

  3. Dans la fiche Partage , sélectionnez Gérer les abonnements.

SQL

L'exemple suivant utilise la vue INFORMATION_SCHEMA.SCHEMATA_LINKS pour répertorier tous les ensembles de données associés à un ensemble de données partagé dans myproject situés dans la région us :

SELECT * FROM `myproject`.`region-us`.INFORMATION_SCHEMA.SCHEMATA_LINKS;

Le résultat renvoyé ressemble à ceci : Certaines colonnes sont omises pour simplifier la sortie.

+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
|  catalog_name  | schema_name | linked_schema_catalog_name | linked_schema_catalog_number | linked_schema_name | linked_schema_org_display_name |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
| myproject      | myschema1   | subscriptionproject1       |                 974999999291 | subscriptionld1    | subscriptionorg                |
| myproject      | myschema2   | subscriptionproject2       |                 974999999292 | subscriptionld2    | subscriptionorg                |
| myproject      | myschema3   | subscriptionproject3       |                 974999999293 | subscriptionld3    | subscriptionorg                |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+

API

Utilisez la méthode projects.locations.dataExchanges.listings.listSubscriptions.

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:listSubscriptions

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet de la fiche à laquelle vous souhaitez vous abonner.
  • LOCATION : emplacement de la fiche à laquelle vous souhaitez vous abonner.
  • DATAEXCHANGE_ID : ID d'échange de données contenant la fiche à laquelle vous souhaitez vous abonner.
  • LISTING_ID : ID de la fiche à laquelle vous souhaitez vous abonner.

Supprimer un abonnement

Lorsque vous supprimez de vos fiches un abonnement créé avant le 25 juillet 2023, l'ensemble de données associé est dissocié de l'ensemble de données partagé. Les abonnés peuvent toujours voir les ensembles de données dans leurs projets, mais ils ne sont plus associés à l'ensemble de données partagé.

Pour supprimer un abonnement créé avant le 25 juillet 2023 de vos fiches, procédez comme suit :

  1. Pour répertorier tous les abonnés d'une fiche, suivez les instructions de la console Google Cloud dans Afficher tous les abonnements.

  2. Pour supprimer un abonné d'une fiche, cliquez sur Supprimer. Si vous souhaitez supprimer tous les abonnements, cliquez sur Supprimer tous les abonnements.

  3. Dans la boîte de dialogue Supprimer l'abonnement ?, saisissez remove pour confirmer.

  4. Cliquez sur Supprimer.

Pour supprimer les abonnements créés après le 25 juillet 2023, procédez comme suit :

Console

  1. Pour répertorier tous les abonnés d'une fiche, suivez les instructions de la console Google Cloud dans Afficher tous les abonnements.

  2. Cliquez sur l'onglet Abonnements.

  3. Pour supprimer un abonné d'une fiche, sélectionnez les abonnements que vous souhaitez supprimer, puis cliquez sur Supprimer les abonnements.

  4. Dans la boîte de dialogue Supprimer l'abonnement ?, saisissez remove pour confirmer.

  5. Cliquez sur Supprimer.

API

Utilisez la méthode projects.locations.subscriptions.revoke.

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions/SUBSCRIPTION_ID:revoke

Remplacez les éléments suivants :

  • PROJECT_ID : ID de projet de l'abonnement que vous souhaitez supprimer.
  • LOCATION : emplacement de l'abonnement que vous souhaitez supprimer.
  • SUBSCRIPTION : ID de l'abonnement que vous souhaitez supprimer.

Mettre à jour une fiche

Pour mettre à jour une fiche, procédez comme suit :

Console

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

  2. Cliquez sur le nom de l'échange de données contenant la fiche.

  3. Cliquez sur la fiche que vous souhaitez mettre à jour.

  4. Cliquez sur Modifier la fiche.

  5. Modifiez les valeurs des champs. Vous pouvez modifier toutes les valeurs, sauf l'ensemble de données source de la fiche.

  6. Facultatif :

    • Si vous activez la visibilité publique, accordez à allUsers ou allAuthenticatedUsers le rôle "Lecteur Analytics Hub" (roles/analyticshub.viewer). Pour en savoir plus, consultez la section Accorder le rôle pour une fiche.
    • Si vous désactivez la visibilité publique, supprimez le rôle "Lecteur Analytics Hub" de allUsers et allAuthenticatedUsers. Les échanges publics ne peuvent pas comporter de fiches privées, mais les échanges privés peuvent comporter des fiches privées.

  7. Pour prévisualiser les modifications, cliquez sur Aperçu.

  8. Pour enregistrer les modifications, cliquez sur Save (Enregistrer).

API

Exécutez la méthode projects.locations.dataExchanges.listings.patch.

PATCH https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID?updateMask=UPDATEMASK

Remplacez UPDATEMASK par la liste des champs que vous souhaitez mettre à jour. Pour mettre à jour plusieurs valeurs, utilisez une liste d'éléments séparés par une virgule. Dans le corps de la requête, spécifiez les valeurs mises à jour.

Pour plus d'informations sur les tâches que vous pouvez effectuer sur des listes à l'aide des API, consultez la documentation sur les méthodes projects.locations.dataExchanges.listings.

Supprimer une fiche

Lorsque vous supprimez une fiche, les abonnés ne peuvent plus l'afficher. La suppression d'une fiche supprime également tous les ensembles de données associés (supprime tous les abonnements) des projets de vos abonnés.

Si vous supprimez une fiche, vous ne pouvez pas annuler la suppression. Pour supprimer une fiche, procédez comme suit :

Console

  1. Accédez à la page Analytics Hub.

    Accéder à Analytics Hub

  2. Cliquez sur le nom de l'échange de données contenant la fiche.

  3. Cliquez sur la fiche que vous souhaitez supprimer.

  4. Cliquez sur Supprimer.

  5. Dans la boîte de dialogue Supprimer la fiche ?, confirmez la suppression en saisissant delete.

  6. Cliquez sur Supprimer.

API

Exécutez la méthode projects.locations.dataExchanges.listings.delete.

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID

Pour plus d'informations sur les tâches que vous pouvez effectuer sur des listes à l'aide des API, consultez la documentation sur les méthodes projects.locations.dataExchanges.listings.

Pour améliorer la visibilité et la notoriété de votre fiche dans le catalogue Analytics Hub, les fiches peuvent être affichées dans la section Sélection. Les fiches à la une sont régies par contrat du programme Google Cloud Partner Advantage.

Les partenaires qui souhaitent que leurs fiches apparaissent dans la section Sélection du catalogue Analytics Hub doivent répondre aux critères suivants :

Pour demander que votre fiche apparaisse dans la section Sélection, remplissez et envoyez le formulaire de demande. Pour demander la suppression de votre fiche de la section, envoyez le même formulaire de demande.

Étape suivante