Gérer les contacts pour les notifications

De nombreuses offres Google Cloud, telles que Cloud Billing, envoient des notifications pour partager des informations importantes avec les utilisateurs de Google Cloud. Par défaut, ces notifications sont envoyées aux membres disposant de certains rôles IAM (Identity and Access Management). Avec les contacts essentiels, vous pouvez personnaliser les contacts qui reçoivent des notifications en fournissant votre propre liste de contacts.

Avant de commencer

Activez Essential Contacts API.

Activer l'API

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les contacts, demandez à votre administrateur de vous attribuer les rôles IAM suivants sur le projet, le dossier ou l'organisation auxquels le contact est attribué :

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ces rôles prédéfinis contiennent les autorisations requises pour gérer les contacts. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer les contacts:

  • Pour afficher les contacts :
    • essentialcontacts.contacts.get
    • essentialcontacts.contacts.list
  • Pour modifier, supprimer et créer des contacts :
    • essentialcontacts.contacts.create
    • essentialcontacts.contacts.delete
    • essentialcontcts.contacts.update

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Catégories de notifications

Vous pouvez affecter des contacts à plusieurs catégories de notification. Si vous n'ajoutez pas de contact à une catégorie, les notifications de cette catégorie sont transmises au contact de remplacement, qui est sélectionné en fonction des rôles IAM de vos membres. Nous vous recommandons d'ajouter des contacts personnalisés et de ne pas utiliser de contacts de remplacement pour vous assurer que les bonnes personnes reçoivent les notifications pour votre projet, dossier ou organisation.

Vous pouvez ajouter des personnes et des groupes en tant que contacts. Pour réduire l'impact des changements de personnel, nous vous recommandons d'ajouter des groupes en tant que contacts, puis de gérer les membres de ces groupes pour déterminer qui reçoit les notifications. Cette pratique permet de garantir que les notifications sont toujours envoyées aux employés actifs.

Consultez le tableau suivant pour en savoir plus sur les catégories de notifications, les contacts de remplacement et les contacts recommandés. Si vous n'attribuez pas de contact à une catégorie donnée, les notifications sont envoyées au contact de remplacement.

Catégorie Description Examples Contact de remplacement Contact recommandé
Tous Toutes les notifications de l'ensemble des autres catégories Non disponible Non disponible Personnes ou systèmes automatisés responsables du routage ou de la journalisation d'un nombre potentiellement élevé de notifications
Facturation Notifications de facturation et de paiement Informations sur les prix, erreurs et avoirs Administrateur de compte de facturation (roles/billing.admin) Le service financier et les personnes qui gèrent votre relation financière avec Google, y compris celles qui gèrent les budgets, la planification et les comptes liés à l'utilisation de Google Cloud
Juridiques Notifications de conformité légale Mesures d'application, conformité réglementaire, notifications administratives Administrateur de compte de facturation (roles/billing.admin) Conseiller juridique, responsables de la conformité, spécialistes des relations gouvernementales et autres professionnels semblables
Nouveautés produits Modifications apportées aux produits Google Nouvelles versions, mises à jour des conditions des produits et abandons Propriétaire du projet (roles/owner) Chefs de produits, architectes et ingénieurs qui peuvent bénéficier d'informations en temps réel sur les modifications apportées aux produits et services Google
Sécurité Notifications de problèmes de sécurité/confidentialité Failles, incidents liés aux données et attaques Administrateur de l'organisation (roles/resourcemanager.organizationAdmin) Personnel des services de sécurité informatique et sécurité des opérations, et autres personnes dont la tâche consiste à protéger les données de votre entreprise et de vos clients, et à assurer la continuité des opérations
Suspension Notifications liées à la suspension immédiate du compte et du projet Conformité à l'évaluation Apigee, atteinte aux droits d'auteur et minage de cryptomonnaie Propriétaire du projet (roles/owner) Les utilisateurs immédiatement responsables du fonctionnement et de la maintenance de votre infrastructure informatique et de vos applications professionnelles.
Technique Événements techniques et autres problèmes opérationnels Journalisation des erreurs de configuration, des mises à jour de la protection contre la perte de données et de l'état d'Actions on Google Propriétaire du projet (roles/owner) Professionnels de l'IT, ingénieurs de la fiabilité, administrateurs, listes d'astreinte et autres personnes qui ont besoin d'être au courant des événements et problèmes techniques actuels et à venir pour mieux gérer vos ressources informatiques et éviter les interruptions
Incidents techniques Pour les clients de l'assistance Premium, sous-catégorie de la catégorie technique pour les notifications d'indisponibilité Interruptions non planifiées, problèmes de service Non disponible Professionnels de l'informatique, ingénieurs de la fiabilité, administrateurs, listes d'astreinte et autres personnes devant intervenir en cas de panne

Langues disponibles

Dans les contacts essentiels, chaque contact a un paramètre de langue préféré. Les créateurs de notifications peuvent se référer à ce paramètre lorsqu'ils envoient des notifications.

Lorsque vous ajoutez un contact dans la console Google Cloud, celle-ci configure automatiquement la langue préférée du contact en fonction des paramètres de langue préférée du créateur du contact. Lorsque vous ajoutez un contact à l'aide de l'API, vous configurez manuellement sa langue préférée à l'aide d'un code de langue. Ce code de langue peut faire référence à n'importe laquelle des langues acceptées par les contacts essentiels.

Bonnes pratiques pour l'attribution de contacts

Vous pouvez attribuer des contacts au niveau du projet, du dossier ou de l'organisation.

Les contacts sont hérités via la hiérarchie des ressources Google Cloud. Par conséquent, si vous ajoutez un contact au niveau de l'organisation, il reçoit des notifications pour l'organisation, ainsi que pour tous les dossiers et projets de l'organisation. De même, si vous ajoutez un contact au niveau du dossier, il reçoit des notifications pour le dossier et pour tous les projets du dossier.

Le choix de l'emplacement où attribuer des contacts dépend de la structure de votre organisation. Toutefois, nous recommandons généralement d'attribuer les contacts dans les niveaux suivants, en fonction de leur catégorie de notifications :

Niveau recommandé Catégorie de notifications
Niveau Organisation :
  • Facturation
  • Juridique
  • Sécurité1
Niveau dossier/projet
  • Tous
  • Actualités sur les produits
  • Sécurité1
  • Suspension
  • Technique2

1 Le niveau auquel vous attribuez des contacts de sécurité dépend des pratiques de sécurité spécifiques de votre organisation. Par exemple, si des propriétaires individuels de projets sont responsables de la sécurité de leurs propres projets, vous pouvez attribuer vos contacts de sécurité au niveau du projet. Toutefois, si un groupe à l'échelle de l'organisation gère la sécurité pour tous les projets, vous devez attribuer vos contacts de sécurité au niveau de l'organisation.

2 Les contacts de la catégorie "technique" reçoivent un grand nombre de notifications par e-mail. Attribuez ces contacts au niveau du dossier ou du projet pour leur permettre de traiter le flux de notifications entrantes.

Attribuer des contacts pour les notifications d'interruption et de perturbation

Si vous avez souscrit une formule d'assistance Premium, vous pouvez affecter des contacts pour recevoir des notifications d'interruption et d'interruption via la sous-catégorie "Incidents techniques". Cela vous permet de diriger les notifications d'interruptions à fort impact vers les contacts qui doivent se concentrer sur les pannes, sans être distraits d'autres notifications techniques.

Pour vous assurer que les notifications sont envoyées aux contacts appropriés, tenez compte du comportement d'héritage suivant lorsque vous attribuez des contacts à la sous-catégorie "Incidents techniques" :

  • Si vous affectez un contact chargé des incidents techniques sur un projet ou un dossier, les notifications d'indisponibilité ne sont envoyées qu'aux adresses suivantes:

    • Le contact chargé des incidents techniques pour le projet ou le dossier
    • Contacts hérités pour les incidents techniques de l'organisation ou du dossier parent

  • Si vous n'affectez pas de contact pour les incidents techniques au niveau d'un projet ou d'un dossier, les notifications d'indisponibilité ne sont envoyées qu'aux adresses suivantes:

    • Le contact technique du projet ou du dossier
    • Contacts hérités pour les incidents techniques de l'organisation ou du dossier parent

  • Si aucun contact en cas d'incident technique n'est attribué ou hérité, et qu'aucun contact technique n'est attribué, les notifications d'indisponibilité ne sont pas envoyées.

Limiter les domaines autorisés pour les contacts

Pour limiter les domaines d'adresse e-mail que les nouveaux contacts peuvent avoir, définissez la contrainte de règle d'administration constraints/essentialcontacts.allowedContactDomains. Les contacts existants ne sont pas affectés par cette contrainte.

Pour savoir comment définir des contraintes de règle d'administration, consultez la page Contraintes liées aux règles d'administration.

Répertorier les contacts

Pour répertorier tous les contacts de votre projet, dossier ou organisation, procédez comme suit :

Console

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources vous indique pour quel projet, dossier ou organisation vous gérez actuellement les contacts.

  3. Pour répertorier les contacts par catégorie, sélectionnez Catégorie. Pour répertorier les contacts par ordre alphabétique, sélectionnez Contacts.

gcloud

  1. Dans la console Google Cloud, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Avec la Google Cloud CLI, vous pouvez répertorier les contacts définis sur une ressource, ou répertorier tous les contacts et contacts hérités pour une ressource.

    Lister les contacts définis sur une ressource

    Pour afficher les contacts définis dans un projet, un dossier ou une organisation spécifique, utilisez la commande gcloud essential-contacts list:

    gcloud essential-contacts list --RESOURCE_TYPE="RESOURCE_ID"

    Remplacez les valeurs suivantes :

    • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur project, folder ou organization.
    • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.

    Si vous ne spécifiez pas de type de ressource ni d'ID, la gcloud CLI répertorie les contacts du projet en cours.

    La réponse est semblable à ce qui suit :

    ---
email: my-contact-1@example.com
languageTag: en-US
name: projects/my-projects/contacts/1
notificationCategorySubscriptions:
- ALL
---
email: my-contact-2@example.com
languageTag: en-US
name: projects/my-projects/contacts/2
notificationCategorySubscriptions:
- BILLING
---

    Liste des contacts et des contacts hérités

    Les ressources enfants (dossiers et projets) héritent des contacts de leurs ancêtres (organisations et autres dossiers). Si vous souhaitez répertorier tous les contacts et contacts hérités d'une ressource, exécutez la commande gcloud essential-contacts compute:

    gcloud essential-contacts compute --notification-categories="NOTIFICATION_CATEGORY" \
  --RESOURCE_TYPE="RESOURCE_ID"

    Remplacez les valeurs suivantes :

    Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

    • NOTIFICATION_CATEGORIES: liste des catégories de notifications pour lesquelles vous souhaitez calculer les contacts, séparées par une virgule. La liste peut contenir l'une des valeurs suivantes: all, billing, legal, product-updates, security, suspension, technical, technical-incidents et notification-category-unspecified. Si vous sélectionnez la valeur all, les contacts sont affichés pour toutes les catégories.
    • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur project, folder ou organization.
    • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.

    Si vous ne spécifiez pas de type de ressource ni d'ID, la gcloud CLI répertorie les contacts du projet en cours.

    La réponse répertorie tous les contacts et les contacts hérités de la ressource :

    ---
email: my-contact-1@example.com
languageTag: en-US
name: projects/my-projects/contacts/1
notificationCategorySubscriptions:
- ALL
---
email: my-contact-2@example.com
languageTag: en-US
name: projects/my-projects/contacts/2
notificationCategorySubscriptions:
- BILLING
---
email: my-organization-contact@example.com
languageTag: en-US
name: organizations/my-organization/contacts/1
notificationCategorySubscriptions:
- ALL
---

REST

Avec l'API REST Essential Contacts, vous pouvez répertorier les contacts définis sur une ressource, ou répertorier tous les contacts et contacts hérités pour une ressource.

Lister les contacts définis sur une ressource

Pour afficher les contacts définis dans un projet, un dossier ou une organisation spécifique, utilisez la méthode contacts.list de l'API Essential Contacts.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • PAGE_SIZE : facultatif. Nombre de contacts à inclure dans la réponse. La valeur par défaut est 50 et la valeur maximale est 100. Si le nombre de contacts est supérieur à la taille de la page, la réponse contient un jeton de pagination qui vous permet de récupérer la page de résultats suivante.
  • NEXT_PAGE_TOKEN : facultatif. Jeton de pagination renvoyé dans une réponse précédente de cette méthode. Si spécifié, la liste des contacts commence à la fin de la réponse précédente.

Requête : 

GET essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

exécutez la commande suivante : 

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

PowerShell (Windows)

exécutez la commande suivante : 

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN" | Select-Object -Expand Content

Après avoir envoyé la requête, vous recevez une réponse JSON semblable à celle-ci : 

{
  "contacts": [
    {
      "name": "projects/my-projects/contacts/1",
      "email": "my-contact-1@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "projects/my-projects/contacts/2",
      "email": "my-contact-2@example.com",
      "notificationCategorySubscriptions": [
        "BILLING"
      ],
      "languageTag": "en-US"
    }
  ]
}

Liste des contacts et des contacts hérités

Les ressources enfants (dossiers et projets) héritent des contacts de leurs ancêtres (organisations et autres dossiers). Si vous souhaitez répertorier tous les contacts et les contacts hérités d'une ressource, utilisez la méthode contacts.compute de l'API Contacts essentiels.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • NOTIFICATION_CATEGORY : catégories de notifications pour lesquelles vous souhaitez calculer les contacts. Vous pouvez répéter ce champ pour répertorier les contacts de plusieurs catégories de notifications. NOTIFICATION_CATEGORY peut prendre l'une des valeurs suivantes: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS et NOTIFICATION_CATEGORY_UNSPECIFIED. Si vous sélectionnez la valeur ALL, les contacts sont affichés pour toutes les catégories.
  • PAGE_SIZE : facultatif. Nombre de contacts à inclure dans la réponse. La valeur par défaut est 50 et la valeur maximale est 100. Si le nombre de contacts est supérieur à la taille de la page, la réponse contient un jeton de pagination qui vous permet de récupérer la page de résultats suivante.
  • NEXT_PAGE_TOKEN : facultatif. Jeton de pagination renvoyé dans une réponse précédente de cette méthode. Si spécifié, la liste des contacts commence à la fin de la réponse précédente.

Requête : 

GET essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORY&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

exécutez la commande suivante : 

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORY&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

PowerShell (Windows)

exécutez la commande suivante : 

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORIES&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN" | Select-Object -Expand Content

La réponse répertorie tous les contacts et les contacts hérités de la ressource :

{
  "contacts": [
    {
      "name": "projects/my-projects/contacts/1",
      "email": "my-project-contact-1@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "projects/my-projects/contacts/2",
      "email": "my-project-contact-2@example.com",
      "notificationCategorySubscriptions": [
        "BILLING"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "organizations/my-organization/contacts/1",
      "email": "my-organization-contact@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    }
  ]
}

Gérer les contacts essentiels individuels

Vous pouvez ajouter des contacts, les supprimer ou leur attribuer des catégories de notification sur la page Contacts essentiels de la console Google Cloud ou à l'aide de l'API REST.

Ajouter un contact

Pour ajouter un contact, procédez comme suit :

Console

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources vous indique pour quel projet, dossier ou organisation vous gérez actuellement les contacts.

  3. Cliquez sur Ajouter un contact.

  4. Dans les champs Adresse e-mail et Confirmer l'adresse e-mail, saisissez l'adresse e-mail du contact.

  5. Dans le menu déroulant Catégories de notifications, sélectionnez les catégories de notifications pour lesquelles vous souhaitez que le contact reçoive des communications. Pour obtenir la liste des catégories de notifications et des contacts recommandés, consultez la section Identifier des contacts sur cette page.

  6. Cliquez sur Enregistrer.

gcloud

  1. Dans la console Google Cloud, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Pour ajouter un nouveau contact, utilisez la commande gcloud Essentials-contacts create:

    gcloud essential-contacts create --email="EMAIL" \
    --notification-categories="NOTIFICATION_CATEGORIES" \
    --language="LANGUAGE" \
    --RESOURCE_TYPE="RESOURCE_ID"

    Remplacez les valeurs suivantes :

    • EMAIL : adresse e-mail de votre contact. Vous ne pourrez plus modifier ce champ une fois le contact créé.
    • NOTIFICATION_CATEGORIES: liste des catégories de notifications pour lesquelles vous souhaitez que le contact reçoive des communications, séparées par une virgule. La liste peut contenir l'une des valeurs suivantes: all, billing, legal, product-updates, security, suspension, technical, Technical-incidents et notification-category-unspecified. Si vous sélectionnez la valeur all, les contacts sont listés pour toutes les catégories.

      Pour obtenir la liste des contacts recommandés pour chaque catégorie, consultez la section Identifier des contacts sur cette page.

    • LANGUAGE: code de langue de la langue de notification préférée de votre contact. Vous pouvez inclure le code de n'importe quelle langue acceptée.
    • RESOURCE_TYPE: type de ressource pour lequel vous souhaitez créer un contact. Utilisez la valeur project, folder ou organization.
    • RESOURCE_ID: ID de votre projet, organisation ou dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, comme my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.

    Si vous ne spécifiez pas de type de ressource ni d'ID, la gcloud CLI crée un contact dans le projet en cours.

    Si la commande aboutit, aucune réponse n'est renvoyée.

REST

Pour ajouter un contact, utilisez la méthode contacts.create de l'API Contacts essentiels.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • RESOURCE_TYPE: type de ressource pour lequel vous souhaitez créer un contact. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • EMAIL : adresse e-mail de votre contact. Vous ne pouvez pas modifier ce champ après avoir créé le contact.

  • NOTIFICATION_CATEGORY_1 et NOTIFICATION_CATEGORY_2 : les catégories de notifications pour lesquelles vous souhaitez que le contact reçoive les communications. Cette valeur peut être l'une des suivantes: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Pour obtenir la liste des contacts recommandés pour chaque catégorie, consultez la section Identifier des contacts sur cette page.

  • LANGUAGE : code de langue de la langue préférée de notification du contact. Vous pouvez inclure le code de langue de n'importe laquelle des langues acceptées.

Requête : 

POST essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts

Corps de la requête :

{
  "email": "EMAIL",
  "notificationCategorySubscriptions": [
    "NOTIFICATION_CATEGORY_1",
    "NOTIFICATION_CATEGORY_2"
  ],
  "languageTag": "LANGUAGE"
}

Pour envoyer votre requête, développez l'une des options suivantes :

Après avoir envoyé la requête, vous recevez une réponse JSON semblable à celle-ci : 

{
  "name": "projects/my-project/contacts/3",
  "email": "my-new-contact@example.com",
  "notificationCategorySubscriptions": [
    "SUSPENSION",
    "TECHNICAL"
  ],
  "languageTag": "en"
}

Modifier un contact

Pour modifier les catégories auxquelles un contact est attribué, procédez comme suit :

Console

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources vous indique pour quel projet, dossier ou organisation vous gérez actuellement les contacts.

  3. À côté de View by (Afficher par), sélectionnez Contact.

  4. Cliquez sur à côté du contact dont vous souhaitez modifier la catégorie.

  5. Sélectionnez les catégories de notifications de votre choix dans le menu déroulant Catégories de notifications, puis cliquez sur Enregistrer.

gcloud

  1. Dans la console Google Cloud, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Pour mettre à jour un contact existant, utilisez la commande gcloud Essentials-contacts update:

    gcloud essential-contacts update CONTACT_ID \
    --notification-categories="NOTIFICATION_CATEGORIES" \
    --language="LANGUAGE"
    --RESOURCE_TYPE="RESOURCE_ID"

    Remplacez les valeurs suivantes :

    • CONTACT_ID: ID numérique du contact que vous souhaitez mettre à jour. Pour afficher les ID de tous les contacts de votre projet, dossier ou organisation, répertoriez vos contacts. L'ID numérique correspond à tout ce qui suit contacts dans le nom du contact.
    • NOTIFICATION_CATEGORIES: liste des nouvelles catégories de notifications pour lesquelles vous souhaitez que le contact reçoive des communications, séparées par une virgule. Cette liste remplacera la liste existante des catégories de notifications.

      La liste peut contenir l'une des valeurs suivantes: all, billing, legal, product-updates, security, suspension, technical, technical-incidents et notification-category-unspecified. Si vous sélectionnez la valeur all, les contacts sont listés pour toutes les catégories.

      Pour obtenir la liste des contacts recommandés pour chaque catégorie, consultez la section Identifier des contacts sur cette page.

    • LANGUAGE: code de langue de la langue de notification préférée de votre contact. Vous pouvez inclure le code de n'importe quelle langue acceptée.
    • RESOURCE_TYPE: type de ressource sur lequel le contact est défini. Utilisez la valeur project, folder ou organization.
    • RESOURCE_ID: ID du projet, de l'organisation ou du dossier Google Cloud dans lequel le contact est défini. Les ID de projet sont des chaînes alphanumériques, comme my-project. Les ID de dossier et d'organisation sont numériques, comme 123456789012.

    Si vous ne spécifiez pas de type de ressource ni d'ID, la gcloud CLI met à jour le contact avec l'ID spécifié dans le projet en cours. S'il n'existe aucun contact avec l'ID spécifié, la gcloud CLI renvoie une erreur.

    Si la commande aboutit, aucune réponse n'est renvoyée.

REST

Pour modifier les abonnements de notifications ou la langue préférée d'un contact existant, utilisez la méthode contacts.patch de l'API Contacts essentiels.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • CONTACT_ID: ID numérique du contact que vous souhaitez mettre à jour. Pour afficher les ID de tous les contacts de votre projet, dossier ou organisation, répertoriez vos contacts. L'ID numérique correspond à tout ce qui suit contacts dans le nom du contact.
  • UPDATE_MASK : facultatif. Masque décrivant les champs du contact que vous avez modifiés. Le format du masque est une liste de noms de champs complets séparés par une virgule, par exemple : notificationCategorySubscriptions,languageTag.
  • EMAIL : adresse e-mail de votre contact. Ce champ doit correspondre à l'adresse e-mail associée à l'élément CONTACT_ID que vous incluez dans la requête.

  • NOTIFICATION_CATEGORY_1 et NOTIFICATION_CATEGORY_2 : facultatifs. Les catégories de notifications mises à jour pour lesquelles vous souhaitez que le contact reçoive les communications. Cette valeur peut être l'une des suivantes: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Pour obtenir la liste des contacts recommandés pour chaque catégorie, consultez la section Identifier des contacts sur cette page.

  • LANGUAGE : code de langue de la langue préférée de notification du contact. Vous pouvez inclure le code de langue de n'importe laquelle des langues acceptées.

Requête : 

PATCH essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts/CONTACT_ID?updateMask="UPDATE_MASK"

Corps de la requête :

{
  "name": "RESOURCE_TYPE/RESOURCE_ID/contact/CONTACT_ID",
  "email": "EMAIL",
  "notificationCategorySubscriptions": [
    "NOTIFICATION_CATEGORY_1",
    "NOTIFICATION_CATEGORY_2"
  ],
  "languageTag": "LANGUAGE"
}

Pour envoyer votre requête, développez l'une des options suivantes :

Après avoir envoyé la requête, vous recevez une réponse JSON semblable à celle-ci : 

{
  "name": "projects/my-project/contacts/2",
  "email": "my-new-contact@example.com",
  "notificationCategorySubscriptions": [
    "ALL"
  ],
  "languageTag": "en"
}

Supprimer un contact

Pour supprimer un contact, procédez comme suit :

Console

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources vous indique pour quel projet, dossier ou organisation vous gérez actuellement les contacts.

  3. À côté de View by (Afficher par), sélectionnez Contact.

  4. Cliquez sur à côté de l'adresse e-mail du contact que vous souhaitez supprimer. Ensuite, dans la boîte de dialogue, confirmez la suppression du contact.

gcloud

  1. Dans la console Google Cloud, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Pour supprimer un contact existant, utilisez la commande gcloudessential-contacts delete:

    gcloud essential-contacts delete CONTACT_ID \
    --RESOURCE_TYPE="RESOURCE_ID"

    Remplacez les valeurs suivantes :

    • CONTACT_ID: ID numérique du contact que vous souhaitez supprimer. Pour afficher les ID de tous les contacts de votre projet, dossier ou organisation, répertoriez vos contacts. L'ID numérique correspond à tout ce qui suit contacts dans le nom du contact.
    • RESOURCE_TYPE: type de ressource sur lequel le contact est défini. Utilisez la valeur project, folder ou organization.
    • RESOURCE_ID: ID du projet, de l'organisation ou du dossier Google Cloud dans lequel le contact est défini. Les ID de projet sont des chaînes alphanumériques, comme my-project. Les ID de dossier et d'organisation sont numériques, comme 123456789012.

    Si vous ne spécifiez pas de type de ressource ni d'ID, la gcloud CLI supprime le contact avec l'ID spécifié dans le projet en cours. S'il n'existe aucun contact avec l'ID spécifié, la gcloud CLI renvoie une erreur.

    Si la commande aboutit, aucune réponse n'est renvoyée.

REST

Pour supprimer un contact, utilisez la méthode contacts.delete de l'API Contacts essentiels.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • CONTACT_ID : ID numérique de votre contact. Pour afficher les ID de tous les contacts de votre projet, dossier ou organisation, répertoriez vos contacts.

Requête : 

DELETE essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts/CONTACT_ID

Pour envoyer votre requête, développez l'une des options suivantes :

Si la requête aboutit, le corps de la réponse est vide.

Gérer les contacts par catégorie

Dans la console Google Cloud, vous pouvez également gérer les contacts par catégorie en accédant à l'onglet Catégorie de la page Contacts essentiels.

Pour ajouter, modifier ou supprimer des contacts attribués à une seule catégorie, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources vous indique pour quel projet, dossier ou organisation vous gérez actuellement les contacts.

  3. À côté de View by (Afficher par), sélectionnez Category (Catégorie).

  4. Cliquez sur sur la même ligne que la catégorie dont vous souhaitez gérer les contacts.

  5. Gérez les contacts affectés à la catégorie :

    • Pour ajouter un contact, cliquez sur Ajouter un contact, puis suivez la procédure permettant d'ajouter un contact décrite sur cette page.

    • Pour modifier la catégorie à laquelle un contact est attribué, cliquez sur à côté du contact dont vous souhaitez modifier la catégorie. Puis, sélectionnez les catégories de notifications de votre choix dans le menu déroulant Catégories de notifications, puis cliquez sur Enregistrer.

    • Pour supprimer un contact, cliquez sur à côté de son adresse e-mail.

Vérification des transmissions par e-mail

Vous pouvez envoyer un e-mail de test aux contacts de chaque catégorie pour vérifier si les comptes de messagerie peuvent recevoir des e-mails de Google Cloud.

Pour envoyer un e-mail de test aux contacts d'une catégorie spécifique, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Contacts essentiels.

    Accéder à la page "Contacts essentiels"

  2. Assurez-vous que le nom de votre projet, dossier ou organisation apparaît dans le sélecteur de ressources en haut de la page. Le sélecteur de ressources affiche le projet, le dossier ou l'organisation pour lesquels vous gérez actuellement les contacts.

  3. À côté de View by (Afficher par), sélectionnez Category (Catégorie).

  4. Cliquez sur sur la même ligne que la catégorie à laquelle vous souhaitez envoyer des e-mails de test.

  5. Cochez les cases correspondant aux contacts auxquels vous souhaitez envoyer des e-mails.

  6. Cliquez sur Envoyer. Un e-mail de test est envoyé aux contacts sélectionnés.

  7. Communiquez avec chaque contact pour vous assurer qu'il a reçu un e-mail de test de la part de gcp-essential-contacts-noreply@google.com.

Gérer les contacts avec Terraform

Vous pouvez utiliser Terraform pour gérer vos contacts de notification. Les contacts ont le format suivant en langage Terraform:

resource "google_essential_contacts_contact" "contact" {
  parent = "RESOURCE_TYPE/RESOURCE_ID"
  email = "EMAIL"
  language_tag = "LANGUAGE"
  notification_category_subscriptions = NOTIFICATION_CATEGORIES
}

Lorsque vous créez un contact, remplacez les valeurs suivantes:

  • RESOURCE_TYPE : type de ressource pour lequel vous souhaitez répertorier les contacts. Utilisez la valeur projects, folders ou organizations.
  • RESOURCE_ID : ID du projet, de l'organisation ou du dossier Google Cloud. Les ID de projet sont des chaînes alphanumériques, telles que my-project. Les ID de dossier et d'organisation sont numériques, tels que 123456789012.
  • EMAIL : adresse e-mail de votre contact. Vous ne pouvez pas modifier ce champ après avoir créé le contact.
  • LANGUAGE : facultatif. Code de langue correspondant à la langue de notification préférée du contact. Vous pouvez inclure le code de n'importe quelle langue compatible.

  • NOTIFICATION_CATEGORIES: tableau des catégories de notifications pour lesquelles vous souhaitez que le contact reçoive des communications. Exemple : ["BILLING", "LEGAL"].

    Ce tableau peut contenir l'une des valeurs suivantes: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Pour obtenir la liste des contacts recommandés pour chaque catégorie, consultez la section Identifier des contacts sur cette page.

Pour ajouter, modifier ou supprimer un contact, ainsi que pour ajouter, modifier ou supprimer une ressource de contact dans votre fichier de configuration Terraform.

Pour en savoir plus, consultez la documentation sur les contacts essentiels Terraform.

Étapes suivantes