Como gerenciar contatos para notificações

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Muitos serviços do Google Cloud, como o Cloud Billing, enviam notificações para compartilhar informações importantes com os usuários do Google Cloud. Por padrão, essas notificações são enviadas para membros com determinados papéis de gerenciamento de identidade e acesso (IAM). Com os contatos essenciais, você pode personalizar quem recebe notificações fornecendo sua própria lista de contatos.

Antes de começar

Ative a Essential Contacts API.

Ative a API

Funções exigidas

Para receber as permissões necessárias para gerenciar contatos, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto, na pasta ou na organização a que o contato está atribuído:

  • Para ver os contatos: Visualizador de contatos essenciais (roles/essentialcontacts.viewer)
  • Para ver, editar, excluir e criar contatos: Essential Contacts Admin (roles/essentialcontacts.admin)

Para mais informações sobre como conceder papéis, consulte Gerenciar o acesso.

Esses papéis predefinidos contêm as permissões necessárias para gerenciar contatos. Para ver as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

  • Para ver os contatos, faça o seguinte:
    • essentialcontacts.contacts.get
    • essentialcontacts.contacts.list
  • Para editar, excluir e criar contatos, faça o seguinte:
    • essentialcontacts.contacts.create
    • essentialcontacts.contacts.delete
    • essentialcontcts.contacts.update

Essas permissões também podem ser concedidas com papéis personalizados ou outros papéis predefinidos.

Categorias de notificação

Você pode atribuir contatos a várias categorias de notificação. Se você não adicionar um contato a uma categoria, as notificações nessa categoria vão para o contato de fallback, que é selecionado com base nos papéis do IAM dos membros. Recomendamos adicionar contatos personalizados, em vez de recorrer a contatos substitutos, para garantir que as pessoas certas recebam notificações sobre seu projeto, pasta ou organização.

Você pode adicionar pessoas e grupos como contatos. Para reduzir o impacto das mudanças na equipe, recomendamos adicionar grupos como contatos e depois gerenciar a associação desses grupos para determinar quem recebe notificações. Essa prática ajuda a garantir que as notificações sempre sejam enviadas para funcionários ativos.

Consulte a tabela a seguir para saber mais sobre categorias de notificações, contatos substitutos e contatos recomendados. Se você não atribuir um contato a uma determinada categoria, as notificações serão enviadas ao contato substituto.

Categoria Descrição Examples Contato substituto Contato recomendado
Tudo Todas as notificações de todas as outras categorias N/A N/A Pessoas ou sistemas automatizados responsáveis por rotear ou registrar um número potencialmente grande de notificações
Faturamento Notificações de pagamento e faturamento Atualizações de preços, erros e créditos Administrador da conta de faturamento (roles/billing.admin) Equipe de departamento financeiro e pessoas que gerenciam sua relação financeira com o Google, incluindo pessoas que gerenciam orçamentos, planejamento e contas relacionadas ao uso do Google Cloud
Jurídico Notificações de conformidade legal Ações de restrição, conformidade regulatória, notificações do governo Administrador da conta de faturamento (roles/billing.admin) Conselho jurídico, gerentes de compliance, especialistas em relações governamentais e outros profissionais do gênero
Atualizações do produto Mudanças nos produtos do Google Novas versões, atualizações de termos do produto, suspensões Proprietário do projeto (roles/owner) Gerentes de produtos, arquitetos e engenheiros que podem se beneficiar de informações oportunas sobre mudanças em produtos e serviços do Google
Segurança Notificações sobre problemas de segurança/privacidade Vulnerabilidades, incidentes de dados e ataques Administrador da organização (roles/resourcemanager.organizationAdmin) Segurança de TI, as operações e de outras pessoas cuja função é proteger os dados da empresa e dos clientes e garantir a continuidade dos negócios
Suspensão Notificações relacionadas à suspensão imediata da conta e do projeto Conformidade da avaliação da Apigee, violações de direitos autorais e mineração de moedas Proprietário do projeto (roles/owner) Pessoas imediatamente responsáveis por manter a infraestrutura de TI e os aplicativos comerciais funcionando
Benefícios técnicos Eventos técnicos e outros problemas operacionais Erros de configuração do Logging, atualizações da Prevenção contra perda de dados e status do Actions on Google Proprietário do projeto (roles/owner) Profissionais de TI, engenheiros de confiabilidade, administradores, listas de plantão e outras pessoas que precisam saber sobre eventos e futuros problemas técnicos para gerenciar melhor seus recursos de TI e evitar interrupções.
Incidentes técnicos Para clientes do Suporte Premium, uma subcategoria da categoria Técnica para notificações de falha temporária Falhas não planejadas, problemas de serviço N/A Profissionais de TI, engenheiros de confiabilidade, administradores, listas de plantão e outras pessoas que precisam reagir às falhas temporárias

Idiomas compatíveis

Em Contatos essenciais, cada contato tem uma configuração de idioma preferido. Os criadores de notificações podem consultar essa configuração ao enviar notificações.

Quando você adiciona um contato no console do Google Cloud, o console do Google Cloud configura automaticamente o idioma preferido do contato com base nas configurações de idioma preferido do criador do contato. Ao adicionar um contato usando a API, você configura manualmente o idioma de preferência do contato usando um código de idioma. Esse código pode ser qualquer um dos idiomas compatíveis com os contatos essenciais.

Práticas recomendadas para atribuir contatos

Você pode atribuir contatos no nível do projeto, da pasta ou da organização.

Os contatos são herdados por meio da hierarquia de recursos do Google Cloud. Como resultado, se você adicionar um contato no nível da organização, eles receberão notificações sobre a organização e sobre todas as pastas e projetos na organização. Da mesma forma, se você adicionar um contato no nível da pasta, eles receberão notificações sobre a pasta e todos os projetos e pastas dentro dela.

O local a que você decide atribuir contatos depende da estrutura da organização. No entanto, geralmente recomendamos atribuir contatos nos seguintes níveis, com base na respectiva categoria de notificação:

Nível recomendado Categoria da notificação
Nível da organização
  • Faturamento
  • Jurídico
  • Segurança1
Nível de pasta/projeto
  • Tudo
  • Atualizações do produto
  • Segurança1
  • Suspensão
  • Técnicas2

1 O nível em que você atribui contatos de segurança depende das práticas de segurança específicas da sua organização. Por exemplo, se os proprietários de projetos individuais forem responsáveis pela segurança dos próprios projetos, será necessário atribuir contatos de segurança no nível do projeto. No entanto, se um grupo para toda a organização gerencia a segurança de todos os projetos, você atribuirá seus contatos de segurança no nível da organização.

2 Os contatos de categorias técnicas recebem um grande número de notificações por e-mail. Atribua esses contatos no nível da pasta ou do projeto para permitir que eles processem o fluxo de notificação recebida.

Atribuir contatos para notificações de interrupção e interrupção

Se você for um cliente do Suporte Premium, poderá atribuir contatos para receber notificações de falhas temporárias e interrupções com a subcategoria "Incidentes técnicos". Isso permite direcionar notificações de falha temporária de alto impacto para contatos que precisam se concentrar em interrupções, sem a distração de outras notificações técnicas.

Para garantir que as notificações sejam enviadas para os contatos apropriados, lembre-se do seguinte comportamento de herança ao atribuir contatos à subcategoria Incidentes técnicos:

  • Se você atribuir um contato de Incidentes técnicos em um projeto ou uma pasta, as notificações de falha temporária só serão enviadas para:

    • O contato do projeto ou da pasta Incidentes técnicos.
    • Contatos herdados de Incidentes técnicos da organização ou pasta mãe
  • Se você não atribuir um contato de incidentes técnicos em um projeto ou uma pasta, as notificações de falha temporária só serão enviadas para:

    • Contato técnico do projeto ou da pasta
    • Contatos herdados de Incidentes técnicos da organização ou pasta mãe
  • Se um contato técnico de incidente não é atribuído ou herdado, as notificações de falha temporária não são enviadas.

Limitação de domínios permitidos para contatos

Para restringir os domínios de endereço de e-mail que novos contatos podem ter, defina a restrição da política da organização como constraints/essentialcontacts.allowedContactDomains. Os contatos existentes não são afetados por essa restrição.

Para saber como definir restrições de políticas da organização, consulte Restrições da política da organização.

Como listar contatos

Para listar todos os contatos do seu projeto, pasta ou organização, faça o seguinte:

Console

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos informa a você para qual projeto, pasta ou organização você está gerenciando contatos.

  3. Para listar os contatos por categoria, selecione Categoria. Para listar os contatos em ordem alfabética, selecione Contatos.

gcloud CLI

Com a Google Cloud CLI, é possível listar os contatos que estão definidos em um recurso ou listar todos os contatos e os contatos herdados de um recurso.

Como listar os contatos definidos em um recurso

Para ver os contatos que foram definidos em um projeto, uma pasta ou uma organização específica, use o comando gcloud essential-contacts list:

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

Substitua os seguintes valores:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer listar os contatos. Use o valor project, folder ou organization.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.

Como alternativa, se você não especificar um tipo de recurso ou ID, a CLI gcloud lista contatos para o projeto atual.

A resposta é semelhante a:

---
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
---

Como listar contatos e contatos herdados

Os recursos filhos (pastas e projetos) herdam os contatos dos ancestrais (organizações e outras pastas). Se você quiser listar todos os contatos e os contatos herdados de um recurso, use o comando gcloud essential-contacts compute:

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

Substitua os seguintes valores:

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • NOTIFICATION_CATEGORIES: uma lista separada por vírgulas das categorias de notificações que você quer computar para contatos. A lista pode conter qualquer um dos seguintes valores: all, billing, legal, product-updates, security, suspension, technical, technical-incidents e notification-category-unspecified. A escolha de um valor de all lista os contatos de todas as categorias.
  • RESOURCE_TYPE: o tipo de recurso para os qual você quer calcular os contatos. Use o valor project, folder ou organization.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.

Se você não especificar um tipo de recurso e um ID, a CLI gcloud listará os contatos do projeto atual.

A resposta lista todos os contatos e os contatos herdados do recurso:

---
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

Com a API REST do Contatos essenciais, você pode listar os contatos definidos em um recurso ou listar todos os contatos e os contatos herdados de um recurso.

Como listar os contatos definidos em um recurso

Para ver os contatos que foram definidos em um projeto, uma pasta ou uma organização específica, use o método contacts.list da API Essential Contacts.

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer listar os contatos. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • PAGE_SIZE: opcional. O número de contatos a serem incluídos na resposta. O valor padrão é 50, e o valor máximo é 100. Se o número de contatos for maior que o tamanho da página, a resposta conterá um token de paginação que pode ser usado para recuperar a próxima página de resultados.
  • NEXT_PAGE_TOKEN: opcional. O token de paginação retornado em uma resposta anterior usando esse método. Se especificada, a lista de contatos começa onde a resposta anterior foi finalizada.

Solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

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)

execute o seguinte comando:

$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
  

Após enviar a solicitação, você receberá uma resposta JSON semelhante a esta:

{
  "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"
    }
  ]
}

Como listar contatos e contatos herdados

Os recursos filhos (pastas e projetos) herdam os contatos dos ancestrais (organizações e outras pastas). Se quiser listar todos os contatos e contatos herdados de um recurso, use o método contacts.compute da API Corees Contacts.

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso para os qual você quer calcular os contatos. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • NOTIFICATION_CATEGORY: as categorias de notificações para as quais você quer calcular contatos. Você pode repetir esse campo para listar contatos de várias categorias de notificação. O NOTIFICATION_CATEGORY pode ser qualquer um dos seguintes valores: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS e NOTIFICATION_CATEGORY_UNSPECIFIED. A escolha de um valor de ALL lista os contatos de todas as categorias.
  • PAGE_SIZE: opcional. O número de contatos a serem incluídos na resposta. O valor padrão é 50, e o valor máximo é 100. Se o número de contatos for maior que o tamanho da página, a resposta conterá um token de paginação que pode ser usado para recuperar a próxima página de resultados.
  • NEXT_PAGE_TOKEN: opcional. O token de paginação retornado em uma resposta anterior usando esse método. Se especificada, a lista de contatos começa onde a resposta anterior foi finalizada.

Solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

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)

execute o seguinte comando:

$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

A resposta lista todos os contatos e os contatos herdados do recurso:

{
  "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"
    }
  ]
}

Gerenciar contatos essenciais individuais

É possível adicionar contatos, removê-los ou atribuir categorias de notificação para eles na página Contatos essenciais no console do Google Cloud ou usando a API REST.

Como adicionar um contato

Para adicionar um contato, faça o seguinte:

Console

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos informa a você para qual projeto, pasta ou organização você está gerenciando contatos.

  3. Clique em Adicionar contato.

  4. Nos campos E-mail e Confirmar e-mail, insira o endereço de e-mail do contato.

  5. No menu suspenso Categorias de notificação, selecione as categorias de notificação das quais você quer que o contato receba comunicações. Para ver uma lista de categorias de notificação e contatos recomendados, consulte Como identificar contatos nesta página.

  6. Clique em Save.

gcloud CLI

Para adicionar um novo contato, use o comando gcloud essential-contacts create:

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

Substitua os seguintes valores:

  • EMAIL: o endereço de e-mail do seu contato. Não é possível alterar esse campo depois de criar o contato.
  • NOTIFICATION_CATEGORIES: uma lista separada por vírgulas das categorias de notificação que você quer que seu contato receba as comunicações. A lista pode conter qualquer um dos seguintes valores: all, billing, legal, product-updates, security, suspension, technical, technical-incidents e notification-category-unspecified. A escolha de um valor de all lista os contatos de todas as categorias.

    Se quiser ver uma lista de contatos recomendados para cada categoria, consulte Como identificar contatos nesta página.

  • LANGUAGE: o código para o idioma de notificação preferencial do contato. É possível incluir o código de um dos idiomas compatíveis.

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer criar um contato. Use o valor project, folder ou organization.

  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.

Se você não especificar um tipo de recurso e ID, a CLI gcloud criará um contato no projeto atual.

Se o comando for bem-sucedido, nenhuma resposta será retornada.

REST

Para adicionar um novo contato, use o método contacts.create da API Essential Contacts.

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer criar um contato. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • EMAIL: o endereço de e-mail do seu contato. Não é possível alterar esse campo depois de criar o contato.
  • NOTIFICATION_CATEGORY_1 e NOTIFICATION_CATEGORY_2: as categorias de notificação das quais você quer que o contato receba comunicações. Esse valor pode ser qualquer uma das seguintes: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Se quiser ver uma lista de contatos recomendados para cada categoria, consulte Como identificar contatos nesta página.

  • LANGUAGE: o código para o idioma de notificação preferencial do contato. É possível incluir o código de um dos idiomas compatíveis.

Solicitação:

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

Corpo da solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Após enviar a solicitação, você receberá uma resposta JSON semelhante a esta:

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

Como alterar um contato

Para alterar as categorias atribuídas a um contato, faça o seguinte:

Console

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos informa a você para qual projeto, pasta ou organização você está gerenciando contatos.

  3. Ao lado de Visualizar por, selecione Contato.

  4. Clique em ao lado do contato cuja categoria você quer alterar.

  5. Selecione as categorias de notificação que você quer no menu suspenso Categorias de notificação e clique em Salvar.

gcloud CLI

Para atualizar um contato existente, use o comando gcloud essential-contacts update:

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

Substitua os seguintes valores:

  • CONTACT_ID: o ID numérico do contato que você quer atualizar. Para ver os IDs de todos os contatos no projeto, na pasta ou na organização, liste seus contatos. O ID numérico é tudo o que vem depois de contacts no nome do contato.
  • NOTIFICATION_CATEGORIES: uma lista separada por vírgulas das novas categorias de notificação para o contato que receberá as comunicações. Essa lista substituirá a lista existente de categorias de notificações.

    A lista pode conter qualquer um dos seguintes valores: all, billing, legal, product-updates, security, suspension, technical, technical-incidents e notification-category-unspecified. A escolha de um valor de all lista os contatos de todas as categorias.

    Se quiser ver uma lista de contatos recomendados para cada categoria, consulte Como identificar contatos nesta página.

  • LANGUAGE: o código para o idioma de notificação preferencial do contato. É possível incluir o código de um dos idiomas compatíveis.

  • RESOURCE_TYPE: o tipo de recurso em que o contato está definido. Use os valores project, folder ou organization.

  • RESOURCE_ID: o ID do projeto, da organização ou da pasta do Google Cloud em que o contato está definido. Os IDs do projeto são strings alfanuméricas, como my-project. Os IDs de pastas e organizações são numéricos, como 123456789012.

Se você não especificar um tipo de recurso e um ID, a CLI gcloud atualizará o contato com o ID especificado no projeto atual. Se não houver nenhum contato com o ID especificado, a CLI gcloud retornará um erro.

Se o comando for bem-sucedido, nenhuma resposta será retornada.

REST

Para alterar as assinaturas de notificação ou o idioma preferido de um contato existente, use o método contacts.patch da API Essential Contacts.

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer listar os contatos. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • CONTACT_ID: o ID numérico do contato que você quer atualizar. Para ver os IDs de todos os contatos no projeto, na pasta ou na organização, liste seus contatos. O ID numérico é tudo o que vem depois de contacts no nome do contato.
  • UPDATE_MASK: opcional. Uma máscara que descreve os campos do contato que você alterou. O formato da máscara é uma lista separada por vírgulas de nomes de campos totalmente qualificados, por exemplo: notificationCategorySubscriptions,languageTag.
  • EMAIL: o endereço de e-mail do seu contato. Este campo precisa corresponder ao endereço de e-mail associado ao CONTACT_ID que você inclui na solicitação.
  • NOTIFICATION_CATEGORY_1 e NOTIFICATION_CATEGORY_2: opcional. As categorias de notificação atualizadas que você quer que o contato receba. Esse valor pode ser qualquer uma das seguintes opções: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Se quiser ver uma lista de contatos recomendados para cada categoria, consulte Como identificar contatos nesta página.

  • LANGUAGE: o código para o idioma de notificação preferencial do contato. É possível incluir o código de um dos idiomas compatíveis.

Solicitação:

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

Corpo da solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Após enviar a solicitação, você receberá uma resposta JSON semelhante a esta:

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

Como excluir um contato

Para excluir um contato, faça o seguinte:

Console

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos informa a você para qual projeto, pasta ou organização você está gerenciando contatos.

  3. Ao lado de Visualizar por, selecione Contato.

  4. Clique em ao lado do endereço de e-mail do contato que você quer excluir. Em seguida, na caixa de diálogo, confirme se você quer excluir o contato.

gcloud CLI

Para excluir um contato existente, use o comando gcloud essential-contacts delete:

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

Substitua os seguintes valores:

  • CONTACT_ID: o ID numérico do contato que você quer excluir. Para ver os IDs de todos os contatos no projeto, na pasta ou na organização, liste seus contatos. O ID numérico é tudo o que vem depois de contacts no nome do contato.
  • RESOURCE_TYPE: o tipo de recurso em que o contato está definido. Use os valores project, folder ou organization.
  • RESOURCE_ID: o ID do projeto, da organização ou da pasta do Google Cloud em que o contato está definido. Os IDs do projeto são strings alfanuméricas, como my-project. Os IDs de pastas e organizações são numéricos, como 123456789012.

Se você não especificar um tipo de recurso e um ID, a CLI gcloud excluirá o contato com o ID especificado no projeto atual. Se não houver nenhum contato com o ID especificado, a CLI gcloud retornará um erro.

Se o comando for bem-sucedido, nenhuma resposta será retornada.

REST

Para excluir um contato, use o método contacts.delete da API Essential Contacts.

Antes de usar algum dos dados de solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer listar os contatos. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • CONTACT_ID: o ID numérico do contato. Para ver os códigos de todos os contatos no seu projeto, pasta ou organização, liste seus contatos.

Solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Se a solicitação for bem-sucedida, o corpo da resposta estará vazio.

Como gerenciar contatos por categoria

No Console do Google Cloud, também é possível gerenciar contatos por categoria acessando a guia Categoria na página Contatos essenciais.

Para adicionar, alterar ou excluir os contatos atribuídos a uma única categoria, faça o seguinte:

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos informa a você para qual projeto, pasta ou organização você está gerenciando contatos.

  3. Ao lado de Visualizar por, selecione Categoria.

  4. Clique em na mesma linha da categoria com os contatos que você quer gerenciar.

  5. Gerencie os contatos atribuídos à categoria:

    • Para adicionar um novo contato, clique em Adicionar contato e siga as etapas para adicionar um contato descrito nesta página.
    • Para alterar a categoria a que um contato é atribuído, clique em ao lado do contato cuja categoria você quer alterar. Em seguida, selecione as categorias de notificação que você quer no menu suspenso Categorias de notificação e clique em Salvar.

    • Para excluir um contato, clique em ao lado do endereço de e-mail do contato.

Verificando transmissões de e-mail

É possível enviar um e-mail de teste aos contatos em cada categoria para verificar se as contas de e-mail podem receber e-mails do Google Cloud.

Para enviar um e-mail de teste aos contatos de uma categoria específica, faça o seguinte:

  1. No Console do Google Cloud, acesse a página Contatos essenciais.

    Acessar a página "Contatos essenciais"

  2. Verifique se o nome do seu projeto, pasta ou organização aparece no seletor de recursos na parte superior da página. O seletor de recursos exibe o projeto, a pasta ou a organização em que você está gerenciando os contatos.

  3. Ao lado de Visualizar por, selecione Categoria.

  4. Clique em na mesma linha da categoria em que os contatos receberão os e-mails de teste.

  5. Marque as caixas de seleção ao lado dos contatos para quem você quer enviar e-mails.

  6. Clique em Enviar. Um e-mail de teste é enviado aos contatos selecionados.

  7. Fale com cada contato para garantir que ele recebeu um e-mail de teste de gcp-essential-contacts-noreply@google.com.

Como gerenciar contatos com o Terraform

É possível usar o Terraform para gerenciar seus contatos de notificação. Os contatos têm o seguinte formato na linguagem do Terraform:

resource "google_essential_contacts_contact" "contact" {
  provider = google-beta
  parent = "<var>RESOURCE_TYPE</var>/<var>RESOURCE_ID</var>"
  email = "<var>EMAIL</var>"
  language_tag = "<var>LANGUAGE</var>"
  notification_category_subscriptions = <var>NOTIFICATION_CATEGORIES</var>
}

Ao criar um contato, substitua os seguintes valores:

  • RESOURCE_TYPE: o tipo de recurso para o qual você quer listar os contatos. Use o valor projects, folders ou organizations.
  • RESOURCE_ID: seu projeto do Google Cloud, a organização ou o ID da pasta. Os IDs do projeto são strings alfanuméricas, como my-project. Os códigos de pastas e organizações são numéricos, como 123456789012.
  • EMAIL: o endereço de e-mail do seu contato. Não é possível alterar esse campo depois de criar o contato.
  • LANGUAGE: opcional. O código do idioma de notificação preferido. É possível incluir o código de qualquer um dos idiomas compatíveis.
  • NOTIFICATION_CATEGORIES: uma matriz das categorias de notificação das quais você quer que o contato receba as comunicações. Por exemplo, ["BILLING", "LEGAL"].

    Essa matriz pode conter qualquer um dos seguintes valores: ALL, BILLING, LEGAL, PRODUCT_UPDATES, SECURITY, SUSPENSION, TECHNICAL, TECHNICAL_INCIDENTS.

    Se quiser ver uma lista de contatos recomendados para cada categoria, consulte Como identificar contatos nesta página.

Para adicionar, modificar ou remover um contato, adicione, modifique ou remova um recurso de contato no seu arquivo de configuração do Terraform.

Para mais detalhes, consulte a documentação dos Contatos essenciais do Terraform.

A seguir