Gerenciar trocas de dados no Analytics Hub

Como administrador do Analytics Hub, você pode realizar as seguintes tarefas:

  • Crie, atualize, visualize, compartilhe e exclua trocas de dados.
  • Criar, atualizar, excluir e compartilhar listagens.
  • Gerenciar administradores do Analytics Hub, administradores das listagens, editores, assinantes e leitores

Por padrão, uma troca de dados é particular e somente usuários ou grupos que têm acesso a ela podem visualizar ou se inscrever nos dados. No entanto, se você quiser que as listagens sejam descobertas e assinadas por usuáriosGoogle Cloud (allAuthenticatedUsers), solicite a que sua troca de dados se torne pública.

Antes de começar

Para começar a usar o Analytics Hub, você precisa ativar a API Analytics Hub no seu projeto Google Cloud .

Permissões necessárias

Para ativar a API Analytics Hub, você precisa das seguintes permissões de gerenciamento de identidade e acesso (IAM):

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

O papel predefinido do IAM a seguir inclui as permissões necessárias para ativar a API Analytics Hub:

  • roles/serviceusage.serviceUsageAdmin

Para mais informações sobre os papéis do IAM no BigQuery, consulte Papéis e permissões predefinidos.

Ativar a API Analytics Hub

Para ativar a API Analytics Hub, faça o seguinte:

Console

Acesse a API Analytics Hub para seu projeto do Google Cloud e ative-o.

Ativar a API Analytics Hub

gcloud

Execute o comando gcloud services enable:

gcloud services enable analyticshub.googleapis.com

Permissões necessárias

Para gerenciar trocas de dados, é necessário ter o papel de administrador do Analytics Hub (roles/analyticshub.admin). Para mais informações, consulte o papel de administrador do Analytics Hub. Para saber como conceder esse papel a outros usuários, consulte Criar administradores do Analytics Hub.

Criar uma troca de dados

Para criar uma troca de dados, siga estas etapas:

Console

  1. Acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Clique em Criar troca.

  3. Na caixa de diálogo Criar troca, selecione um Projeto e uma Região para a troca de dados. Não é possível atualizar o projeto e a região depois de criar a troca de dados.

  4. Em Nome de exibição, insira um nome para sua troca de dados.

  5. Opcional: insira valores nos campos a seguir:

    • Contato principal: insira o URL ou o endereço de e-mail do contato principal da troca de dados.
    • Descrição: insira uma descrição para a troca de dados.

  6. Para registrar todos os identificadores principais dos usuários que executam jobs e consultas em conjuntos de dados vinculados, clique no botão Gerar registros de e-mails de assinantes (Prévia). Quando você ativa essa opção, todas as listagens na troca de dados têm a geração de registros de e-mails de assinantes ativada.

  7. Para ativar a detecção pública, clique na opção Detecção pública. Quando uma troca pode ser descoberta publicamente, todas as listagens na troca são exibidas e pesquisáveis no catálogo. Se você ativar a descoberta pública, é necessário configurar as permissões de troca. Devido à herança de permissões, todos as listagens serão definidas, por padrão, com o mesmo tipo de descoberta pública da troca. Portanto, as trocas públicas não podem ter listagens privadas, mas as trocas privadas podem ter listagens públicas (por exemplo, é possível definir o tipo de descoberta pública no nível de listagem individual). O projeto em que você está criando a troca de dados precisa ter uma organização e uma conta de faturamento associadas.

  8. Clique em Criar troca.

  9. Opcional: na seção Permissões de troca, siga estas etapas:

    1. Insira os endereços de e-mail nos seguintes campos para conceder papéis do usuário do Analytics Hub:

    2. Para salvar permissões, clique em Definir permissões.

  10. Se você não tiver definido permissões para a troca de dados, clique em Pular.

API

Use o método projects.locations.dataExchanges.create.

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

Substitua:

  • PROJECT_ID: o ID do projeto em que você quer criar a troca de dados.
  • LOCATION: o local da troca de dados. Para mais informações sobre locais que aceitam o Analytics Hub, consulte Regiões compatíveis.
  • DATAEXCHANGE_ID: o ID da sua troca de dados.

No corpo da solicitação, forneça os detalhes da troca de dados. Se a solicitação for bem-sucedida, o corpo da resposta conterá os detalhes da troca de dados. Se você tiver ativado o registro de e-mails de assinantes (Pré-lançamento), a resposta de troca de dados conterá log_linked_dataset_query_user_email: true.

Para mais informações sobre as tarefas que podem ser executadas em trocas de dados usando APIs, consulte Métodos projects.locations.dataExchanges.

Atualizar uma troca de dados

Para atualizar uma troca de dados, siga estas etapas:

Console

  1. Acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Na lista de trocas de dados, clique em uma troca de dados que você quer atualizar.

  3. Clique em Editar troca.

  4. Na caixa de diálogo Editar troca, atualize os seguintes campos:

    • Nome de exibição
    • Contato principal
    • Descrição
    • Descoberta pública
      • Se você ativar a descoberta pública, conceda o papel de Leitor do Analytics Hub (roles/analyticshub.viewer) para allUsers ou allAuthenticatedUsers:
      • Se você desativar a descoberta pública, remova o papel de Leitor do Analytics Hub (roles/analyticshub.viewer) de allUsers ou allAuthenticatedUsers. As trocas públicas não podem ter listagens privadas, mas trocas privadas podem ter listagens públicas.

    • Registro de e-mails de assinantes (pré-lançamento)

  5. Clique em Salvar.

API

Use o método projects.locations.dataExchanges.patch.

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

Substitua UPDATEMASK pela lista de campos que você quer atualizar. Para atualizar vários valores, use uma lista separada por vírgulas. Por exemplo, para atualizar o nome de exibição e o contato principal de uma troca de dados, insira displayName,primaryContact.

No corpo da solicitação, especifique os valores atualizados dos seguintes campos:

  • Nome de exibição
  • Descrição
  • Documentação
  • Ícone
  • Contato principal
  • Descoberta pública
  • Registro de e-mails de assinantes (pré-lançamento)

Para detalhes sobre esses campos, consulte Recurso: DataExchange.

Para mais informações sobre as tarefas que podem ser executadas em trocas de dados usando APIs, consulte Métodos projects.locations.dataExchanges.

Ver trocas de dados

Para ver todas as trocas de dados na sua organização a que você tem acesso, siga estas etapas:

Console

  1. Acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Confira a lista de trocas de dados na sua Google Cloud organização.

API

Use o método organizations.locations.dataExchanges.list.

GET https://analyticshub.googleapis.com/v1/organizations/ORGANIZATION_ID/location/LOCATION/dataExchanges

Substitua:

  • ORGANIZATION_ID: o ID da organização. Para mais informações, consulte Como conseguir o ID da organização.
  • LOCATION: o local para o qual você quer listar as trocas de dados.

Compartilhar uma troca de dados

Se o editor do Analytics Hub pertencer a uma organização diferente da organização que contém a troca de dados, o editor não poderá acessar sua troca de dados no Analytics Hub. Você precisa compartilhar um link para a troca de dados com o editor.

  1. Acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Na lista de trocas de dados, clique em Mais opções.

  3. Clique em Copiar link de compartilhamento.

Conceder aos usuários acesso a uma troca de dados

Para conceder aos usuários acesso a uma troca de dados, é preciso definir a política do IAM para essa troca. Para mais informações sobre os papéis do usuário do IAM predefinidas, consulte Papéis do usuário do Analytics Hub. Para fazer isso, siga estas etapas:

Console

  1. No Console do Google Cloud, acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Clique no nome da troca de dados para que você quer definir permissões.

  3. Clique em Definir permissões.

  4. Para adicionar participantes, clique em Adicionar participante.

  5. No campo Novos participantes, adicione os e-mails a quem você quer conceder acesso.

  6. Em Selecionar papel, mantenha o ponteiro sobre Hub do Analytics e selecione um dos seguintes papéis de gerenciamento de identidade e acesso (IAM, na sigla em inglês):

    • Administrador do Analytics Hub
    • Editor do Analytics Hub
    • Administrador de listagens do Analytics Hub
    • Assinante do Analytics Hub
    • Leitor do Analytics Hub

  7. Clique em Salvar.

API

  1. Leia a política atual com o método getIamPolicy da ficha da empresa usando o método projects.locations.dataExchanges.getIamPolicy:

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

    Substitua:

    • PROJECT_ID: o ID do projeto, por exemplo, my-project-1
    • LOCATION: o local da troca de dados.
    • DATAEXCHANGE_ID: o ID da troca de dados.

    O Analytics Hub retorna a política atual.

  2. Para adicionar ou remover membros e os papéis do Identity and Access Management (IAM) associados, edite a política com um editor de texto. Use o seguinte formato para adicionar membros:

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

    Por exemplo, para conceder o papel roles/analyticshub.subscriber a group:subscribers@example.com, adicione a seguinte vinculação à política:

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

  3. Grave a política atualizada usando o método projects.locations.dataExchanges.setIamPolicy. No corpo da solicitação, forneça a política de IAM atualizada da etapa anterior.

    POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID:setIamPolicy

    No corpo da solicitação, forneça os detalhes da ficha. Se a solicitação for bem-sucedida, o corpo da resposta conterá detalhes da ficha.

Criar administradores do Analytics Hub

Para gerenciar trocas de dados, você precisa criar administradores do Analytics Hub. Para criar administradores de troca, você precisa conceder aos usuários o papel de administrador do Analytics Hub (roles/analyticshub.admin) no nível do projeto ou da troca de dados.

Se você quiser que os administradores gerenciem todas as trocas de dados em um projeto, conceda o papel de administrador do Analytics Hub nesse projeto. Se você quiser que os administradores gerenciem uma troca de dados específica, conceda o papel de administrador do Analytics Hub para essa troca de dados.

Tornar uma troca de dados pública

Por padrão, uma troca de dados é particular e somente usuários ou grupos que têm acesso a essa troca podem visualizar ou se inscrever nas listagens. No entanto, é possível optar por tornar pública uma troca de dados. As listagens em trocas de dados públicas podem ser descobertas e assinadas por usuáriosGoogle Cloud (allAuthenticatedUsers).

Para tornar uma troca de dados pública, siga estas etapas:

  1. Para permitir que allAuthenticatedUsers visualizem as listagens, você precisa conceder a eles o papel de Leitor do Analytics Hub no nível da troca de dados.

  2. Para permitir que allAuthenticatedUsers se inscrevam nas listagens, você precisa conceder a eles o papel de Assinante do Analytics Hub no nível da troca de dados.

  3. Ative a descoberta pública ao criar ou atualizar uma troca de dados. Especifique as configurações quando você torna pública uma troca de dados.

Excluir uma troca de dados

Quando uma troca de dados é excluída, todas as listagens nela também são excluídas. No entanto, os conjuntos de dados compartilhados e vinculados não são excluídos. Além disso, quando um projeto é excluído, as trocas de dados nele não são excluídas. É necessário excluir essas trocas de dados antes de excluir o projeto. Se você excluir uma troca de dados, não poderá desfazer essa ação.

Para excluir uma troca de dados, siga estas etapas:

Console

  1. Acesse a página do Analytics Hub.

    Acessar o Analytics Hub

  2. Na lista de trocas de dados, clique na troca de dados que você quer excluir.

  3. Clique em Excluir troca.

  4. Na caixa de diálogo Excluir troca?, confirme a exclusão digitando Excluir.

  5. Clique em Excluir.

API

Use o método projects.locations.dataExchanges.delete.

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID

Para mais informações sobre as tarefas que podem ser executadas em trocas de dados usando APIs, consulte Métodos projects.locations.dataExchanges.

A seguir