Configurar a API Enterprise Knowledge Graph

Neste guia, você encontra todas as etapas de configuração necessárias para começar a usar o Enterprise Knowledge Graph.

Sobre o console do Google Cloud

O Google Cloud console é uma UI da Web usada para provisionar, configurar, gerenciar e monitorar sistemas que usam produtos do Google Cloud . Use o console do Google Cloud para configurar e gerenciar recursos do Enterprise Knowledge Graph.

Criar um projeto

Para usar os serviços fornecidos pelo Google Cloud, crie um projeto.

Um projeto organiza todos os seus recursos do Google Cloud . Um projeto consiste nos seguintes componentes:

  • Um grupo de colaboradores
  • APIs ativadas (e outros recursos)
  • Ferramentas de monitoramento
  • Informações de faturamento
  • Autenticação e controles de acesso

É possível criar um projeto ou vários projetos. É possível usar seus projetos para organizar os recursos do Google Cloud em uma hierarquia de recursos. Para mais informações sobre projetos, consulte a documentação do Resource Manager.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

  • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
  • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Ativar a API

Ative a API Enterprise Knowledge Graph para seu projeto. Saiba mais sobre a ativação de APIs na documentação do Service Usage.

Enable the Enterprise Knowledge Graph API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Configurar a autenticação

Qualquer aplicativo cliente que usa a API precisa ser autenticado e ter acesso aos recursos solicitados. Nesta seção, você verá importantes conceitos de autenticação e etapas para a configuração. Para mais informações, consulte a Visão geral da autenticação.

Sobre contas de serviço

Há várias opções de autenticação, mas indicamos as contas de serviço para autenticação e controle de acesso. Uma conta de serviço fornece credenciais para aplicativos, e não para usuários finais. Os projetos são proprietários das contas de serviço. É possível criar várias contas de serviço para um projeto. Para mais informações, consulte Contas de serviço.

Sobre os papéis

Ao chamar uma API, o Google Cloud exige que a identidade que faz a chamada (qualquer pessoa, entidade ou processo aplicável e os respectivos atributos definidos) tenha as permissões apropriadas. É possível conceder permissões ao atribuir papéis a uma conta de serviço. Para mais informações, consulte a documentação do Gerenciamento de identidade e acesso (IAM, na sigla em inglês).

Para testar a API Enterprise Knowledge Graph, use o papel Projeto > Proprietário nas etapas a seguir. O papel Projeto > Proprietário concede à conta de serviço permissão total para os recursos em seu projeto. Se a conta de serviço não exigir permissões completas, especifique um papel mais restritivo usando o console doGoogle Cloud . Para uma lista de permissões e papéis do Enterprise Knowledge Graph, consulte Permissões do Enterprise Knowledge Graph e Papéis do Enterprise Knowledge Graph. Para informações sobre o gerenciamento de permissões usando papéis do IAM, consulte Como atribuir papéis a contas de serviço.

Sobre as chaves da conta de serviço

As contas de serviço estão associadas a um ou mais pares de chaves públicas ou privadas. Ao criar um novo par de chaves, você faz o download da chave privada. A CLI do Google Cloud usa sua chave privada para gerar credenciais ao chamar a API.

Criar uma conta de serviço e fazer o download do arquivo de chave privada

Create a service account:

  1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.
  2. In the Google Cloud console, go to the Create service account page.

    Go to Create service account
  3. Select your project.
  4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

    In the Service account description field, enter a description. For example, Service account for quickstart.

  5. Click Create and continue.
  6. Grant the Project > Owner role to the service account.

    To grant the role, find the Select a role list, then select Project > Owner.

  7. Click Continue.
  8. Click Done to finish creating the service account.

    Do not close your browser window. You will use it in the next step.

Create a service account key:

  1. In the Google Cloud console, click the email address for the service account that you created.
  2. Click Keys.
  3. Click Add key, and then click Create new key.
  4. Click Create. A JSON key file is downloaded to your computer.
  5. Click Close.

Usar o arquivo de chave da conta de serviço no seu ambiente

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. This variable applies only to your current shell session. If you want the variable to apply to future shell sessions, set the variable in your shell startup file, for example in the ~/.bashrc or ~/.profile file.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.