Gerenciar listagens

Como editor do Analytics Hub, é possível realizar as seguintes tarefas:

• Criar listagens em uma troca de dados a que você tenha acesso de publicação.
• Atualizar, excluir, compartilhar e visualizar métricas de uso de listagens.
• Gerenciar papéis diferentes para suas listagens do Analytics Hub, como administradores, assinantes e leitores.
• Ver todos os inscritos que se inscreveram na sua listagem.
• Monitore o uso das suas fichas.
• Remover assinantes da sua listagem.

Uma listagem é uma referência a um conjunto de dados compartilhado que um editor lista em uma troca de dados. Uma listagem pode ser dos dois tipos a seguir com base na política de gerenciamento de identidade e acesso (IAM) definida para a listagem e o tipo de troca de dados que contém a listagem:

• Listagem pública. Ela pode ser descoberta e assinada pelos usuários do Google Cloud (allAuthenticatedUsers). Listagens em uma troca de dados pública são listagens públicas. Essas listagens podem ser referências a um conjunto de dados público gratuito ou a um conjunto de dados comercial. Se a listagem for de um conjunto de dados comercial, os assinantes poderão solicitar acesso à listagem e o provedor de dados entrará em contato com eles.

• Listagem particular. Ela é compartilhada diretamente com indivíduos ou grupos. Por exemplo, uma listagem particular pode fazer referência ao conjunto de dados de métricas de marketing que você compartilha com outras equipes internas da organização. Embora seja possível permitir que allAuthenticatedUsers se inscrevam nas suas listagens, elas permanecerão particulares e não serão exibidas como uma lista pública na página do Analytics Hub. Para compartilhar essas listagens com os usuários, compartilhe o URL com eles. Para tornar detectável uma listagem particular, é necessário tornar a troca pública.

Antes de começar

Para começar a usar o Analytics Hub, você precisa ativar a API Analytics Hub no projeto do 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 listagens e assinaturas, é preciso ter um dos seguintes papéis do Analytics Hub:

• Papel de Editor do Analytics Hub (roles/analyticshub.publisher), que permite criar, atualizar, excluir e definir políticas do IAM nas listagens.

• O papel de Administrador de listagens do Google Analytics (roles/analyticshub.listingAdmin), que permite atualizar, excluir e definir políticas do IAM nas suas listagens.

• Papel de Administrador do Analytics Hub (roles/analyticshub.Admin), que permite criar, atualizar, excluir e definir políticas do IAM em todas as listagens na sua troca de dados.

Para mais informações, consulte as funções do usuário do Analytics Hub. Para saber como conceder esses papéis a outros usuários, consulte Criar um administrador de listagens.

Além disso, para criar listagens, você também precisa ter a permissões bigquery.datasets.get e bigquery.datasets.update nos conjuntos de dados para os quais quer criar listagens. Os papéis predefinidos do BigQuery a seguir têm a permissão bigquery.datasets.update.

• Papel de Proprietário de dados do BigQuery (roles/bigquery.dataOwner)
• Papel de administrador do BigQuery (roles/bigquery.admin)

Para ver todas as trocas de dados nos projetos em uma organização a que você tem acesso, é preciso ter a permissão resourcemanager.organizations.get. Não há papéis predefinidos do BigQuery que contenham essa permissão. Por isso, você precisará usar um papel personalizado do IAM.

Ver trocas de dados

Para ver a lista de trocas de dados na organização a que você tem acesso, consulte Ver trocas de dados. Se a troca de dados estiver em outra organização, o administrador do Analytics Hub precisará compartilhar um link para essa troca de dados com você.

Criar uma listagem

Uma listagem é uma referência a um conjunto de dados compartilhado que um editor lista em uma troca de dados.

Atenção: recomendamos não adicionar conjuntos de dados compartilhados a um projeto com um perímetro do VPC Service Controls. Se fizer isso, você precisará adicionar as regras de entrada e saída apropriadas.

Para criar uma listagem, siga estas etapas:

Console

1. Acesse a página do Analytics Hub.

   Acessar o Analytics Hub

   Será exibida uma página que lista todas as trocas de dados que é possível acessar.

2. Clique no nome da troca de dados na qual você quer criar a listagem.

3. Clique em Criar listagem.

4. Na página Criar listagem, em Nome de exibição, insira o nome da listagem.

5. Se você estiver criando um conjunto de dados comercial, precisará preencher o campo Solicitar contato de acesso. Insira um e-mail ou URL do formulário de entrada para que os assinantes possam entrar em contato com você.

6. Opcional: digite os seguintes detalhes:

   • Contato principal: insira um e-mail ou um URL do contato principal da listagem.

   • Categoria: selecione até duas categorias que melhor representam sua listagem. Os assinantes podem filtrar as listagens com base nessas categorias.

   • Provedor: expanda a seção Provedor e especifique os detalhes nos seguintes campos:

     • Nome do provedor: nome do provedor do conjunto de dados.
     • Contato principal do provedor: um e-mail ou um URL do contato principal do provedor do conjunto de dados.

     Os assinantes podem filtrar listagens com base nos provedores de dados.

   • Editor: expanda a seção Editor e especifique os detalhes nos campos a seguir:

     • Nome do editor: nome do editor que está criando a listagem.
     • Contato principal do editor: um e-mail ou um URL do contato principal do editor do conjunto de dados.

   • Ícone: um ícone para a listagem. Os formatos de arquivo PNG e JPEG são compatíveis. O tamanho do arquivo dos ícones precisa ser inferior a 512 KiB e dimensões de no máximo 512 x 512 pixels.

   • Descrição: uma breve descrição sobre sua listagem. Os assinantes podem pesquisar listagens com base na descrição.

7. Em Conjunto de dados de origem, selecione o conjunto de dados que você quer listar na troca de dados. O conjunto de dados de origem precisa estar na mesma região que a troca de dados. Não é possível atualizar este campo após a criação da listagem.

   Importante: o nome do conjunto de dados de origem e o ID do projeto que contém o conjunto de dados são retornados quando os assinantes visualizam os metadados do conjunto de dados vinculado.

8. Em Saída de dados (visualização), selecione a opção de saída de dados adequada. Somente assinantes com produtos sem edição ou Enterprise Plus podem consultar dados com restrições de saída.

   • Para aplicar restrições de saída de dados ao conjunto de dados compartilhado, mas não aos resultados da consulta desse conjunto, selecione Desativar cópia e exportação de dados compartilhados.
   • Para aplicar restrições de saída de dados ao conjunto de dados compartilhado e aos resultados da consulta desse conjunto, selecione Desativar cópia e exportação dos resultados da consulta. Isso definirá automaticamente a opção Desativar. copiar e exportar dados compartilhados.

9. Opcional: na seção Documentação > seção Markdown, é possível inserir informações adicionais, como exemplos de consultas que podem ser executadas no conjunto de dados, bem como links para qualquer documento relevante e qualquer informação adicional que possa ajudar os assinantes a usar seu conjunto de dados.

10. Clique em Save.

API

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

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

Substitua:

• PROJECT_ID: o ID do projeto que contém a troca de dados em que você quer criar a ficha da empresa.
• 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 troca de dados.
• LISTING_ID: o ID da ficha da empresa.

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

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

Conceder aos usuários acesso a uma listagem

Se você quiser permitir que os usuários acessem uma listagem particular, defina a política do IAM para um indivíduo ou um grupo para essa listagem. No caso de uma listagem comercial, sua troca de dados precisa ser pública. As listagens em uma troca de dados pública aparecem no Analytics Hub para todos os usuários do Google Cloud (allAuthenticatedUsers). Para permitir que os usuários solicitem acesso a listagens comerciais, conceda a eles o Papel de Leitor do Analytics Hub.

Para conceder aos usuários acesso para ver ou se inscrever na sua listagem, siga estas etapas:

Console

1. Acesse a página do Analytics Hub.

   Acessar o Analytics Hub

2. Clique no nome da troca de dados que contém a ficha da empresa.

3. Clique na ficha que você quer adicionar inscritos.

4. Clique em Definir permissões.

5. Para adicionar participantes, clique em Adicionar participante.

6. No campo Novos participantes, adicione os seguintes detalhes com base no tipo da listagem:

   • Para uma listagem particular, insira e-mails da identidade a quem você quer conceder acesso.

   • Para uma ficha pública, adicione allAuthenticatedUsers.

7. Em Selecionar papel, mantenha o ponteiro sobre o Analytics Hub e, com base o tipo de ficha, selecione um dos seguintes papéis:

   • Para uma listagem comercial, selecione a função Leitor do Analytics Hub. Com esse papel, os usuários podem ver a listagem e solicitar acesso.

   • Para uma listagem particular ou pública não comercial, selecione o papel de Assinante do Analytics Hub. Com esse papel, os usuários podem fazer inscrição na listagem.

   Para mais informações, consulte os papéis de Assinante e Leitor do Analytics Hub.

8. Clique em Save.

API

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

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

   Substitua:

   • PROJECT_ID: o ID do projeto, por exemplo, my-project-1
   • LOCATION: a localização da troca de dados que contém a listagem.
   • DATAEXCHANGE_ID: o ID da troca de dados.
   • LISTING_ID: o ID da ficha da empresa.

   O Analytics Hub retorna a política atual na resposta.

2. Para adicionar ou remover membros e os papéis associados, edite a política com um editor de texto. Use o seguinte formato para adicionar membros:

   • user:[e-mail]
   • group:[e-mail]
   • serviceAccount:[e-mail]
   • domain:example.domain.com

   Por exemplo, para conceder o papel roles/analyticshub.subscriber a group:[e-mail], adicione a seguinte vinculação à política:

   {
    "members": [
      "group:[e-mail]"
    ],
    "role":"roles/analyticshub.subscriber"
   }
   

3. Grave a política atualizada usando o método projects.locations.dataExchanges.listings.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/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_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.

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

Observação: depois de conceder licenças aos usuários para acessar suas listagens comerciais, é possível criar uma listagem privada para esses usuários ou conceder a eles o papel Assinante do Analytics Hub para sua listagem comercial.

Criar um administrador da listagem

Para permitir que os usuários gerenciem as listagens, você precisa criar administradores de fichas do Analytics Hub. Para criar administradores de listagens, você precisa conceder aos usuários o papel de editor do Analytics Hub ou administrador da listagem do Analytics Hub no nível da listagem. Para mais informações sobre como conceder esses papéis a uma listagem, consulte este link.

Ver todas as assinaturas

Para ver todas as assinaturas atuais da sua listagem da empresa, selecione uma das seguintes opções:

Console

1. Acesse a página do Analytics Hub.

   Acessar o Analytics Hub

2. Clique no nome da troca de dados que contém a listagem para que você quer gerenciar as assinaturas.

3. Clique na listagem para que você quer listar todos os assinantes.

4. Para ver todos os assinantes da sua listagem, clique em Gerenciar assinaturas.

   

5. Opcional: você pode filtrar os resultados por detalhes do assinante.

Como alternativa, se você tiver acesso ao conjunto de dados compartilhado, siga estas etapas para listar os assinantes:

1. Acessar a página do BigQuery.

   Ir para o BigQuery

2. No painel do Explorer, expanda seu projeto e selecione o conjunto de dados compartilhado.

3. Na lista de Compartilhamento, selecione Gerenciar assinaturas.

SQL

O exemplo a seguir usa a INFORMATION_SCHEMA.SCHEMATA_LINKS visualização para relacionar todos os conjuntos de dados vinculados a um conjunto de dados compartilhado no myproject que estejam na região us:

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

A resposta será semelhante a esta: Algumas colunas são omitidas para simplificar a saída.

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

Use o método projects.locations.dataExchanges.listings.listSubscriptions.

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

Substitua:

• PROJECT_ID: o ID do projeto da ficha da empresa em que você quer se inscrever.
• LOCATION: o local da ficha em que você quer se inscrever.
• DATAEXCHANGE_ID: o ID da troca de dados que contém a ficha em que você quer se inscrever.
• LISTING_ID: o ID da ficha da empresa em que você quer se inscrever.

Remover uma inscrição

Quando você remove uma assinatura criada antes de 25 de julho de 2023 das suas fichas, o conjunto de dados vinculado é desvinculado do conjunto de dados compartilhado. Os assinantes ainda podem ver os conjuntos de dados nos projetos deles, mas eles não estão mais vinculados ao conjunto de dados compartilhado.

Para remover uma assinatura criada antes de 25 de julho de 2023 das suas informações do produto, siga estas etapas:

1. Para relacionar todos os assinantes de uma listagem, siga as instruções do console do Google Cloud em Ver todas as assinaturas.

2. Para remover um assinante de uma listagem, clique em Excluir. Se você quiser remover todas as assinaturas, clique em Remover todas as assinaturas.

3. Na caixa de diálogo Remover assinatura?, insira remove para confirmar.

4. Clique em Remover.

Para remover assinaturas criadas após 25 de julho de 2023, siga estas etapas:

Console

1. Para relacionar todos os assinantes de uma listagem, siga as instruções do console do Google Cloud em Ver todas as assinaturas.

2. Clique na guia Assinaturas.

3. Para remover um assinante de uma ficha, selecione as assinaturas que você quer remover e clique em Remover assinaturas.

4. Na caixa de diálogo Remover assinatura?, insira remove para confirmar.

5. Clique em Remover.

API

Use o método projects.locations.subscriptions.revoke (prévia).

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

Substitua:

• PROJECT_ID: o ID do projeto da assinatura que você quer remover.
• LOCATION: o local da assinatura que você quer remover.
• SUBSCRIPTION: o ID da assinatura que você quer remover.

Atualizar uma listagem

Para isso, siga estas etapas:

Console

1. Acesse a página do Analytics Hub.

   Acessar o Analytics Hub

2. Clique no nome da troca de dados que contém a ficha da empresa.

3. Clique na listagem que você quer atualizar.

4. Clique em Editar listagem.

5. Modifique os valores nos campos. É possível modificar todos os valores, exceto o conjunto de dados de origem da listagem.

6. Para visualizar as alterações, clique em Visualizar.

7. Para salvar as alterações, clique em Salvar.

API

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

PATCH https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_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. No corpo da solicitação, especifique os valores atualizados.

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

Excluir uma listagem

Quando você exclui uma ficha, os assinantes não podem mais visualizá-la. Excluir uma listagem também exclui todos os conjuntos de dados vinculados (remove todas as assinaturas) dos projetos dos assinantes.

Se você excluir uma listagem, não poderá desfazer essa ação. Para excluir uma listagem, siga estas etapas:

Console

1. Acesse a página do Analytics Hub.

   Acessar o Analytics Hub

2. Clique no nome da troca de dados que contém a ficha da empresa.

3. Clique na listagem que você quer excluir.

4. Clique em Excluir.

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

6. Clique em Excluir.

API

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

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

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

A seguir

• Saiba mais sobre a arquitetura do Analytics Hub.
• Saiba como ver e assinar listagens.
• Saiba mais sobre as funções dos usuários do Analytics Hub.
• Saiba mais sobre como criar conjuntos de dados.
• Saiba mais sobre a geração de registros de auditoria do Analytics Hub.
• Saiba como monitorar fichas.