Membuat dan mengelola penyimpanan persetujuan

Halaman ini menunjukkan cara membuat dan mengelola penyimpanan izin.

Consent Management API adalah alat untuk mencatat izin pengguna, mengelola tindakan berdasarkan izin tersebut, serta mengelola dokumentasi dan catatan terkait.

Organisasi yang menggunakan Consent Management API bertanggung jawab untuk mendapatkan dan mengelola izin yang diperlukan untuk mengizinkan pemrosesan data apa pun melalui Consent Management API.

Consent Management API memenuhi peran titik keputusan kebijakan. Penerapan kebijakan harus diterapkan di aplikasi atau melalui proxy. Untuk mengetahui informasi selengkapnya, lihat Kontrol akses berbasis atribut.

Siapkan izin

Untuk menggunakan fitur dalam panduan ini, Anda harus memiliki peran roles/healthcare.consentStoreAdmin. Namun, untuk melakukan operasi tambahan yang berguna dengan Consent Management API, izin tambahan mungkin diperlukan. Lihat Kontrol akses untuk detail selengkapnya.

Membuat penyimpanan persetujuan

Penyimpanan izin adalah resource tingkat teratas yang berisi semua informasi yang terkait dengan konfigurasi dan operasi Consent Management API. Penyimpanan izin termasuk dalam set data Cloud Healthcare API, yang ditetapkan ke region saat dibuat. Region ini adalah lokasi geografis tempat penyimpanan izin Anda beroperasi.

Di konsol Google Cloud, buka halaman Datasets.

Buka Set Data
Pilih set data tempat Anda ingin membuat penyimpanan izin.
Klik Buat penyimpanan data.
Pilih Izin sebagai jenis penyimpanan data.
Di kolom ID, masukkan nama pilihan Anda yang unik dalam set data Anda. Jika namanya tidak unik, pembuatan toko akan gagal.
Klik Next.
Di Configure your Consent Store, pilih salah satu opsi berikut untuk menentukan kapan masa berlaku izin di toko Anda habis:
- Tidak ada waktu habis masa berlaku default berarti, secara default, izin tidak memiliki masa berlaku.
- Waktu habis masa berlaku default berarti, secara default, masa berlaku izin berakhir setelah jumlah hari yang ditentukan di kolom Waktu habis masa berlaku.
Untuk mengizinkan pembuatan resource izin baru menggunakan consentStores.patch, klik Izinkan pembuatan izin saat pembaruan.
Klik Next.
Klik Add label untuk menetapkan label kunci dan nilai opsional untuk mengatur resource Google Cloud Anda.
Klik Create.

Untuk membuat penyimpanan izin, jalankan perintah gcloud healthcare consent-stores create.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID untuk penyimpanan izin. ID penyimpanan izin harus memiliki hal berikut:
- ID unik dalam set datanya
- String Unicode yang terdiri dari 1-256 karakter yang terdiri dari hal berikut:

Jalankan perintah berikut:

Linux, macOS, atau 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

Anda akan melihat respons seperti berikut:

Respons

Created consentStore [CONSENT_STORE_ID].

Untuk membuat penyimpanan izin, gunakan metode projects.locations.datasets.consentStores.create.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: ID project Google Cloud Anda
LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID untuk penyimpanan izin. ID penyimpanan izin harus memiliki hal berikut:
- ID unik dalam set datanya
- String Unicode yang terdiri dari 1-256 karakter yang terdiri dari hal berikut:
DEFAULT_CONSENT_EXPIRATION_DURATION: waktu default opsional, yang ditentukan dalam detik, hingga masa berlaku izin yang dibuat di toko ini habis. Durasi ini minimal harus 24 jam (86400 detik) dan harus dalam format DEFAULT_CONSENT_EXPIRATION_DURATIONs.
ENABLE_CONSENT_CREATE_ON_UPDATE: boolean opsional yang menentukan apakah permintaan untuk mem-patch resource izin yang tidak ada menggunakan consentStores.patch harus membuat resource tersebut. Default-nya adalah FALSE.

Meminta isi JSON:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke CLI gcloud dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke CLI gcloud. Anda dapat memeriksa akun yang aktif saat ini dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian, jalankan perintah berikut untuk mengirim permintaan REST Anda:

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

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke CLI gcloud dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang aktif saat ini dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

$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

APIs Explorer

Salin isi permintaan dan buka halaman referensi metode. Panel APIs Explorer akan terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.

Anda akan melihat respons JSON seperti berikut:

Respons

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

Mengedit penyimpanan izin

Setelah membuat penyimpanan persetujuan, Anda dapat memperbaruinya. Misalnya, Anda dapat menambahkan atau menghapus label untuk mengatur penyimpanan izin.

Contoh berikut menunjukkan cara mengedit penyimpanan izin.

Untuk mengedit penyimpanan persetujuan, selesaikan langkah-langkah berikut:

Di konsol Google Cloud, buka halaman Datasets.
Buka Set Data
Pilih set data yang berisi penyimpanan izin yang ingin Anda edit.
Di daftar Penyimpanan data, klik penyimpanan data yang ingin diedit.
Untuk mengedit konfigurasi penyimpanan izin, klik ikon edit di samping Konfigurasi Penyimpanan Izin.

Untuk mengetahui informasi selengkapnya tentang opsi konfigurasi penyimpanan izin, lihat Membuat penyimpanan izin.
Untuk menambahkan satu atau beberapa label ke toko, klik Label, klik Tambahkan label, lalu masukkan label kunci/nilai. Untuk mengetahui informasi selengkapnya tentang label resource, lihat Menggunakan label resource.
Klik Save.

Untuk mengedit penyimpanan izin, jalankan perintah gcloud healthcare consent-stores update.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin
KEY: kunci dalam pasangan nilai kunci yang digunakan untuk mengelola penyimpanan izin. Lihat labels untuk mengetahui persyaratan dan batasan label.
VALUE: nilai dalam pasangan nilai kunci yang digunakan untuk mengelola penyimpanan izin. Lihat labels untuk mengetahui persyaratan dan batasan label.

Jalankan perintah berikut:

Linux, macOS, atau 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

Anda akan melihat respons seperti berikut:

Respons

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

Untuk mengedit penyimpanan izin, gunakan metode projects.locations.datasets.consentStores.patch.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: ID project Google Cloud Anda
LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin
KEY: kunci dalam pasangan nilai kunci yang digunakan untuk mengelola penyimpanan izin. Lihat labels untuk mengetahui persyaratan dan batasan label.
VALUE: nilai dalam pasangan nilai kunci yang digunakan untuk mengelola penyimpanan izin. Lihat labels untuk mengetahui persyaratan dan batasan label.

Meminta isi JSON:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian, jalankan perintah berikut untuk mengirim permintaan REST Anda:

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

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

$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

APIs Explorer

Anda akan melihat respons JSON seperti berikut:

Respons

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

Mendapatkan detail Consent Store

Contoh berikut menunjukkan cara mendapatkan detail tentang penyimpanan izin.

Untuk melihat detail app store:

Di konsol Google Cloud, buka halaman Datasets.
Buka Set Data
Pilih set data yang berisi penyimpanan izin yang ingin Anda lihat.
Klik nama penyimpanan persetujuan.

Halaman Detail datastore menampilkan detail penyimpanan izin yang dipilih.

Untuk mendapatkan detail tentang penyimpanan izin, jalankan perintah gcloud healthcare consent-stores describe.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin

Jalankan perintah berikut:

Linux, macOS, atau 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

Jika Anda mengonfigurasi kolom apa pun dalam resource ConsentStore, kolom tersebut juga akan muncul dalam respons.

Respons

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

Untuk mendapatkan detail tentang penyimpanan izin, gunakan metode projects.locations.datasets.consentStores.get.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: ID project Google Cloud Anda
LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Jalankan perintah berikut:

$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

APIs Explorer

Buka halaman referensi metode. Panel APIs Explorer akan terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.

Jika Anda mengonfigurasi kolom apa pun dalam resource ConsentStore, kolom tersebut juga akan muncul dalam respons.

Respons

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

Mencantumkan penyimpanan persetujuan dalam set data

Contoh berikut menunjukkan cara mencantumkan penyimpanan izin dalam set data.

Untuk melihat penyimpanan data dalam sebuah {i>dataset<i}:

Di konsol Google Cloud, buka halaman Datasets.
Buka Set Data
Pilih {i>dataset<i} berisi penyimpanan data yang ingin Anda lihat.

Untuk mencantumkan penyimpanan izin dalam set data, jalankan perintah gcloud healthcare consent-stores list.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

DATASET_ID: set data induk penyimpanan izin
LOCATION: lokasi set data

Jalankan perintah berikut:

Linux, macOS, atau 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

Jika Anda mengonfigurasi kolom apa pun dalam resource ConsentStore, kolom tersebut juga akan muncul dalam respons.

ID               LABELS  LOCATION
CONSENT_STORE_ID           LOCATION

Untuk mencantumkan penyimpanan izin dalam set data, gunakan metode projects.locations.datasets.consentStores.list.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: ID project Google Cloud Anda
DATASET_ID: set data induk penyimpanan izin
LOCATION: lokasi set data

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Jalankan perintah berikut:

$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

APIs Explorer

Jika Anda mengonfigurasi kolom apa pun dalam resource ConsentStore, kolom tersebut juga akan muncul dalam respons.

Respons

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

Menghapus penyimpanan izin

Contoh berikut menunjukkan cara menghapus penyimpanan izin.

Untuk menghapus penyimpanan data:

Di konsol Google Cloud, buka halaman Datasets.
Buka Set Data
Pilih set data berisi penyimpanan data yang ingin Anda hapus.
Pilih Hapus dari menu drop-down Tindakan untuk penyimpanan data yang ingin Anda hapus.
Untuk mengonfirmasi, ketik nama penyimpanan data, lalu klik Hapus.

Untuk menghapus penyimpanan izin, jalankan perintah gcloud healthcare consent-stores delete.

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin

Jalankan perintah berikut:

Linux, macOS, atau 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

Untuk mengonfirmasi, ketik Y. Anda akan menerima respons seperti berikut.

Deleted consentStore [CONSENT_STORE_ID].

Untuk menghapus penyimpanan izin, gunakan metode projects.locations.datasets.consentStores.delete.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: ID project Google Cloud Anda
LOCATION: lokasi set data
DATASET_ID: set data induk penyimpanan izin
CONSENT_STORE_ID: ID penyimpanan izin

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Jalankan perintah berikut:

$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

APIs Explorer

Anda akan melihat respons JSON seperti berikut:

Respons

{}

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

Logging audit

Consent Management API menulis jenis log audit berikut:

Aktivitas Admin: merekam operasi yang mengubah konfigurasi atau metadata resource. Anda tidak dapat menonaktifkan log audit Aktivitas Admin.
Akses Data: berisi panggilan API yang membaca konfigurasi atau metadata resource, serta panggilan API eksternal yang membuat, mengubah, atau membaca data resource yang disediakan pelanggan. Log ini harus diaktifkan. Misalnya, log audit Akses Data dapat digunakan untuk mencatat layanan yang membuat permintaan penentuan akses, informasi yang diberikan dalam permintaan tersebut, dan cara API merespons permintaan tersebut. Untuk informasi selengkapnya tentang log audit Akses Data, lihat Mengonfigurasi log audit Akses Data. Untuk informasi selengkapnya tentang logging audit di Cloud Healthcare API, buka Melihat Cloud Audit Logs.

Untuk mengetahui informasi selengkapnya tentang log audit untuk Consent Management API, lihat artikel Melihat Log Audit Cloud.

Membuat dan mengelola penyimpanan persetujuan

Siapkan izin

Membuat penyimpanan persetujuan

Konsol

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Respons

REST

curl

PowerShell

APIs Explorer

Respons

Node.js

Python

Mengedit penyimpanan izin

Konsol

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Respons

REST

curl

PowerShell

APIs Explorer

Respons

Node.js

Python

Mendapatkan detail Consent Store

Konsol

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Respons

REST

curl

PowerShell

APIs Explorer

Respons

Node.js

Python

Mencantumkan penyimpanan persetujuan dalam set data

Konsol

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

APIs Explorer

Respons

Node.js

Python

Menghapus penyimpanan izin

Konsol

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

APIs Explorer

Respons

Node.js

Python

Logging audit