Esta página foi traduzida pela API Cloud Translation.

Criar e gerir armazenamentos de consentimento

Esta página mostra como criar e gerir armazenamentos de consentimento.

A API Consent Management é uma ferramenta para registar consentimentos dos utilizadores, gerir ações com base nesses consentimentos e manter a documentação e os registos associados.

A organização que usa a API Consent Management é responsável por obter e manter os consentimentos necessários para permitir o tratamento de quaisquer dados através da API Consent Management.

A API Consent Management cumpre a função de um ponto de decisão de políticas. A aplicação das políticas tem de ser implementada na aplicação ou através de um proxy. Para mais informações, consulte o artigo Controlo de acesso baseado em atributos.

Configure as autorizações

Para usar as funcionalidades neste guia, tem de ter a roles/healthcare.consentStoreAdmin função. No entanto, para realizar operações úteis adicionais com a API Consent Management, podem ser necessárias autorizações adicionais. Consulte o artigo Controlo de acesso para ver mais detalhes.

Criar um arquivo de consentimento

Os arquivos de consentimento são os recursos de nível superior que contêm todas as informações relacionadas com a configuração e o funcionamento da API Consent Management. Os arquivos de consentimento pertencem a um conjunto de dados da API Cloud Healthcare, que é atribuído a uma região quando é criado. Esta região é a localização geográfica na qual a sua loja de consentimento opera.

Na Google Cloud consola, aceda à página Conjuntos de dados.

Aceda aos conjuntos de dados
Selecione o conjunto de dados onde quer criar um armazenamento de consentimento.
Clique em Criar arquivo de dados.
Selecione Consentimento como o tipo de armazenamento de dados.
No campo ID, introduza um nome à sua escolha que seja exclusivo no conjunto de dados. Se o nome não for exclusivo, a criação da loja falha.
Clicar em Seguinte.
Em Configure a sua loja de consentimento, selecione uma das seguintes opções para determinar quando os consentimentos na sua loja expiram:
- Sem tempo de expiração predefinido significa que, por predefinição, os consentimentos não expiram.
- Hora de expiração predefinida significa que, por predefinição, os consentimentos expiram após o número de dias definido no campo Hora de expiração.
Para permitir a criação de novos recursos de consentimento através da API consentStores.patch, clique em Permitir a criação de consentimento na atualização.
Clicar em Seguinte.
Clique em Adicionar etiqueta para definir chaves e valores opcionais etiquetas para organizar os seus Google Cloud recursos.
Clique em Criar.

Para criar uma loja de consentimento, execute o comando gcloud healthcare consent-stores create.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: um identificador para a loja de consentimento. O ID da loja de consentimento tem de ter o seguinte:
- Um ID exclusivo no respetivo conjunto de dados
- Uma string Unicode de 1 a 256 carateres que consiste no seguinte:

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud healthcare consent-stores create CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores create CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores create CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION

Deve receber uma resposta semelhante à seguinte:

Resposta

Created consentStore [CONSENT_STORE_ID].

Para criar um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.create.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

PROJECT_ID: o ID do seu Google Cloud projeto
LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: um identificador para a loja de consentimento. O ID da loja de consentimento tem de ter o seguinte:
- Um ID exclusivo no respetivo conjunto de dados
- Uma string Unicode de 1 a 256 carateres que consiste no seguinte:
DEFAULT_CONSENT_EXPIRATION_DURATION: um tempo predefinido opcional, especificado em segundos, até que os consentimentos criados nesta loja expirem. Esta duração tem de ser de, pelo menos, 24 horas (86 400 segundos) e tem de estar no formato DEFAULT_CONSENT_EXPIRATION_DURATIONs.
ENABLE_CONSENT_CREATE_ON_UPDATE: um valor booleano opcional que determina se os pedidos para aplicar uma correção a um recurso de consentimento inexistente através de consentStores.patch devem criar esse recurso. A predefinição é FALSE.

Corpo JSON do pedido:

{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}

Para enviar o seu pedido, escolha uma destas opções:

curl

Nota: O comando seguinte pressupõe que tem sessão iniciada na CLI gcloud com a sua conta de utilizador executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que inicia automaticamente sessão na CLI gcloud. Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro denominado request.json. Execute o seguinte comando no terminal para criar ou substituir este ficheiro no diretório atual:

cat > request.json << 'EOF'
{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}
EOF

Em seguida, execute o seguinte comando para enviar o seu pedido REST:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID"

PowerShell

Nota: O comando seguinte pressupõe que iniciou sessão na CLI do Google Cloud com a sua conta de utilizador executando gcloud init ou gcloud auth login .gcloud Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro denominado request.json. Execute o seguinte comando no terminal para criar ou substituir este ficheiro no diretório atual:

@'
{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Em seguida, execute o seguinte comando para enviar o seu pedido REST:

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de APIs

Copie o corpo do pedido e abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Cole o corpo do pedido nesta ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.

Deve receber uma resposta JSON semelhante à seguinte:

Resposta

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID",
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATION",
  "enableConsentCreateOnUpdate": ENABLE_CONSENT_CREATE_ON_UPDATE
}

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const createConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}`;
  const request = {parent, consentStoreId};

  await healthcare.projects.locations.datasets.consentStores.create(request);
  console.log(`Created consent store: ${consentStoreId}`);
};

createConsentStore();

def create_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Creates a new consent store within the parent dataset.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = (
        f"projects/{project_id}/locations/{location}/datasets/{dataset_id}"
    )

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .create(parent=consent_store_parent, body={}, consentStoreId=consent_store_id)
    )

    response = request.execute()
    print(f"Created consent store: {consent_store_id}")
    return response

Editar uma loja de consentimento

Depois de criar um armazenamento de consentimento, pode atualizá-lo. Por exemplo, pode adicionar ou remover etiquetas para organizar as suas lojas de consentimento.

Os exemplos seguintes mostram como editar um armazenamento de consentimento.

Para editar um armazenamento de consentimento, conclua os seguintes passos:

Na Google Cloud consola, aceda à página Conjuntos de dados.
Aceda aos conjuntos de dados
Selecione o conjunto de dados que contém o armazenamento de consentimento que quer editar.
Na lista Armazenamentos de dados, clique no armazenamento de dados que quer editar.
Para editar a configuração do armazenamento de consentimento, clique no ícone de edição junto a Configuração do armazenamento de consentimento.

Para mais informações sobre as opções de configuração do armazenamento de consentimento, consulte o artigo Criar um armazenamento de consentimento.
Para adicionar uma ou mais etiquetas à loja, clique em Etiquetas, clique em Adicionar etiqueta e introduza a etiqueta de chave/valor. Para mais informações sobre etiquetas de recursos, consulte o artigo Usar etiquetas de recursos.
Clique em Guardar.

Para editar um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores update.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento
KEY: a chave num par de chave-valor usado para organizar as lojas de consentimento. Consulte labels para ver os requisitos e as limitações das etiquetas.
VALUE: o valor num par de chave-valor usado para organizar as lojas de consentimento. Consulte labels para ver os requisitos e as limitações das etiquetas.

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud healthcare consent-stores update CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION \
  --update-labels=KEY=VALUE

Windows (PowerShell)

gcloud healthcare consent-stores update CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION `
  --update-labels=KEY=VALUE

Windows (cmd.exe)

gcloud healthcare consent-stores update CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION ^
  --update-labels=KEY=VALUE

Deve receber uma resposta semelhante à seguinte:

Resposta

Updated consentStore [CONSENT_STORE_ID].
labels:
  KEY: VALUE
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID

Para editar um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.patch.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

PROJECT_ID: o ID do seu Google Cloud projeto
LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento
KEY: a chave num par de chave-valor usado para organizar as lojas de consentimento. Consulte labels para ver os requisitos e as limitações das etiquetas.
VALUE: o valor num par de chave-valor usado para organizar as lojas de consentimento. Consulte labels para ver os requisitos e as limitações das etiquetas.

Corpo JSON do pedido:

{
  "labels": {
    "KEY": "VALUE"
  }
}

Para enviar o seu pedido, escolha uma destas opções:

curl

Guarde o corpo do pedido num ficheiro denominado request.json. Execute o seguinte comando no terminal para criar ou substituir este ficheiro no diretório atual:

cat > request.json << 'EOF'
{
  "labels": {
    "KEY": "VALUE"
  }
}
EOF

Em seguida, execute o seguinte comando para enviar o seu pedido REST:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels"

PowerShell

Guarde o corpo do pedido num ficheiro denominado request.json. Execute o seguinte comando no terminal para criar ou substituir este ficheiro no diretório atual:

@'
{
  "labels": {
    "KEY": "VALUE"
  }
}
'@  | Out-File -FilePath request.json -Encoding utf8

Em seguida, execute o seguinte comando para enviar o seu pedido REST:

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

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels" | Select-Object -Expand Content

Explorador de APIs

Deve receber uma resposta JSON semelhante à seguinte:

Resposta

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const patchConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  // const defaultConsentTtl = '172800s' Must be at least 24 hours, specified
  // in seconds, appended with 's' character.
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {
    name,
    updateMask: 'defaultConsentTtl',
    resource: {
      defaultConsentTtl: defaultConsentTtl,
    },
  };

  await healthcare.projects.locations.datasets.consentStores.patch(request);
  console.log(
    `Patched consent store ${consentStoreId} with default consent time-to-live ${defaultConsentTtl}`
  );
};

patchConsentStore();

def patch_consent_store(
    project_id: str,
    location: str,
    dataset_id: str,
    consent_store_id: str,
    default_consent_ttl,
):
    """Updates the consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    # default_consent_ttl = '172800s'  # replace with a default TTL
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    # Updates the default time-to-live (TTL) of consents in the consent store.
    # Updating the TTL does not affect the expiration time of existing consents.
    # Specify as a duration in seconds with up to nine fractional digits,
    # terminated by "s", for example "172800s".
    # Minimum value is 24 hours, or "86400s" in seconds.
    patch = {"defaultConsentTtl": default_consent_ttl}

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .patch(name=consent_store_name, updateMask="defaultConsentTtl", body=patch)
    )

    response = request.execute()
    print(
        "Patched consent store {} with new default consent TTL: {}".format(
            consent_store_id, default_consent_ttl
        )
    )

    return response

A obter detalhes da loja de consentimento

Os exemplos seguintes mostram como obter detalhes sobre um armazenamento de consentimento.

Para ver os detalhes de uma loja de consentimento:

Na Google Cloud consola, aceda à página Conjuntos de dados.
Aceda aos conjuntos de dados
Selecione o conjunto de dados que contém o armazenamento de consentimento que quer ver.
Clique no nome da loja de consentimento.

A página Detalhes do arquivo de dados apresenta os detalhes do arquivo de dados de consentimento selecionado.

Para obter detalhes sobre um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores describe.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud healthcare consent-stores describe CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores describe CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores describe CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION

Se configurou campos no recurso ConsentStore, estes também aparecem na resposta.

Resposta

name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID

Para obter detalhes sobre um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.get.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

PROJECT_ID: o ID do seu Google Cloud projeto
LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"

PowerShell

Execute o seguinte comando:

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de APIs

Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.

Se configurou campos no recurso ConsentStore, estes também aparecem na resposta.

Resposta

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
}

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const getConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {name};

  const consentStore =
    await healthcare.projects.locations.datasets.consentStores.get(request);
  console.log(consentStore.data);
};

getConsentStore();

def get_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Gets the specified consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    # Imports Python's built-in "json" module
    import json

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    consent_stores = client.projects().locations().datasets().consentStores()
    consent_store = consent_stores.get(name=consent_store_name).execute()

    print(json.dumps(consent_store, indent=2))
    return consent_store

Apresentar em lista os arquivos de consentimento num conjunto de dados

Os exemplos seguintes mostram como listar as lojas de consentimento num conjunto de dados.

Para ver os arquivos de dados num conjunto de dados:

Na Google Cloud consola, aceda à página Conjuntos de dados.
Aceda aos conjuntos de dados
Selecione o conjunto de dados que contém o arquivo de dados que quer ver.

Para listar os arquivos de consentimento num conjunto de dados, execute o comando gcloud healthcare consent-stores list.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
LOCATION: a localização do conjunto de dados

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud healthcare consent-stores list --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores list --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores list --dataset=DATASET_ID ^
  --location=LOCATION

Se configurou campos no recurso ConsentStore, estes também aparecem na resposta.

ID               LABELS  LOCATION
CONSENT_STORE_ID           LOCATION

Para apresentar os armazenamentos de consentimento num conjunto de dados, use o método projects.locations.datasets.consentStores.list.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

PROJECT_ID: o ID do seu Google Cloud projeto
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
LOCATION: a localização do conjunto de dados

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores"

PowerShell

Execute o seguinte comando:

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores" | Select-Object -Expand Content

Explorador de APIs

Se configurou campos no recurso ConsentStore, estes também aparecem na resposta.

Resposta

{
  "consentStores": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
    },
    {
      ...
    }
  ]
}

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const listConsentStores = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}`;
  const request = {parent};

  const consentStores =
    await healthcare.projects.locations.datasets.consentStores.list(request);
  console.log(JSON.stringify(consentStores.data));
};

listConsentStores();

def list_consent_stores(project_id, location, dataset_id):
    """Lists the consent stores in the given dataset.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )

    consent_stores = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .list(parent=consent_store_parent)
        .execute()
        .get("consentStores", [])
    )

    for consent_store in consent_stores:
        print(consent_store)

    return consent_stores

Eliminar uma loja de consentimento

Os exemplos seguintes mostram como eliminar um armazenamento de consentimento.

Para eliminar um arquivo de dados:

Na Google Cloud consola, aceda à página Conjuntos de dados.
Aceda aos conjuntos de dados
Selecione o conjunto de dados que contém o arquivo de dados que quer eliminar.
Escolha Eliminar na lista pendente Ações para o arquivo de dados que quer eliminar.
Para confirmar, escreva o nome do arquivo de dados e, de seguida, clique em Eliminar.

Para eliminar um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores delete.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud healthcare consent-stores delete CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores delete CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores delete CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION

Para confirmar, escreva Y. Deve receber uma resposta semelhante à seguinte.

Deleted consentStore [CONSENT_STORE_ID].

Para eliminar um arquivo de consentimento, use o método projects.locations.datasets.consentStores.delete.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

PROJECT_ID: o ID do seu Google Cloud projeto
LOCATION: a localização do conjunto de dados
DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"

PowerShell

Execute o seguinte comando:

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

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de APIs

Deve receber uma resposta JSON semelhante à seguinte:

Resposta

{}

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const deleteConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {name};

  await healthcare.projects.locations.datasets.consentStores.delete(request);
  console.log(`Deleted consent store: ${consentStoreId}`);
};

deleteConsentStore();

def delete_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Deletes the specified consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .delete(name=consent_store_name)
    )

    response = request.execute()
    print(f"Deleted consent store: {consent_store_id}")
    return response

Registo de auditoria

A API Consent Management escreve os seguintes tipos de registos de auditoria:

Atividade de administrador: registe operações que modificam a configuração ou os metadados de um recurso. Não pode desativar os registos de auditoria da atividade do administrador.
Acesso aos dados: contêm chamadas API que leem a configuração ou os metadados dos recursos, bem como chamadas API externas que criam, modificam ou leem dados de recursos fornecidos pelo cliente. Estes registos têm de estar ativados. Por exemplo, os registos de auditoria de acesso a dados podem ser usados para registar que serviço fez um pedido de determinação de acesso, que informações foram fornecidas nesse pedido e como a API respondeu a esse pedido. Para mais informações sobre os registos de auditoria de acesso a dados, consulte o artigo Configurar registos de auditoria de acesso a dados. Para mais informações sobre o registo de auditoria na Cloud Healthcare API, visite o artigo Visualizar registos de auditoria do Cloud.

Para mais informações sobre os registos de auditoria da API Consent Management, consulte o artigo Ver registos de auditoria do Cloud.

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

Configure as autorizações

Criar um arquivo de consentimento

Consola

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

Explorador de APIs

Resposta

Node.js

Python

Editar uma loja de consentimento

Consola

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

Explorador de APIs

Resposta

Node.js

Python

A obter detalhes da loja de consentimento

Consola

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

Explorador de APIs

Resposta

Node.js

Python

Apresentar em lista os arquivos de consentimento num conjunto de dados

Consola

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

Explorador de APIs

Resposta

Node.js

Python

Eliminar uma loja de consentimento

Consola

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

Explorador de APIs

Resposta

Node.js

Python

Registo de auditoria

Criar e gerir armazenamentos de consentimento