Mencari label

Organisasi Anda dapat memiliki beberapa label, dengan label yang memiliki beberapa kolom. Google Drive Labels API menyediakan labels resource untuk mengaktifkan pembacaan label.

Dokumen ini menjelaskan cara menelusuri dan mengambil label menggunakan Drive Labels API.

Metode

Resource labels menyediakan metode berikut untuk membaca nilai label, masing-masing dengan tugas tertentu:

Rentang Metode
Satu label berdasarkan nama resource labels.get
Semua label labels.list

Mendapatkan label berdasarkan nama resource

Untuk mendapatkan satu label berdasarkan nama resource-nya, gunakan metode get pada resource labels.

name resource label diperlukan dan dapat disusun sebagai:

  • labels/{id} atau labels/{id}@latest: Mendapatkan revisi label terbaru.
  • labels/{id}@published: Mendapatkan revisi label yang dipublikasikan saat ini.
  • labels/{id}@{revisionId}: Mendapatkan label pada ID revisi yang ditentukan.

Anda harus menentukan objek LabelView sebagai LABEL_VIEW_FULL untuk menetapkan tampilan resource yang diterapkan ke respons label. LABEL_VIEW_FULL menampilkan semua kolom yang memungkinkan.

Contoh kode berikut menunjukkan cara menggunakan name label untuk mendapatkan satu label berdasarkan nama resource-nya:

Python

# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'

# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'

label = service.labels().get(
    name=name,
    view=view
).execute()

Node.js

// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';

// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';

service.labels.get({
  name: name,
  view: view
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Ganti NAME dengan nama label.

Mencantumkan semua label

Untuk mendapatkan daftar label, gunakan metode list pada resource labels.

Anda juga harus menentukan:

  • Parameter kueri customer untuk mencakup permintaan daftar ini. Jika customer tidak ditetapkan, semua label dalam pelanggan saat ini akan ditampilkan.

  • Objek LabelView sebagai LABEL_VIEW_FULL untuk menetapkan tampilan resource yang diterapkan ke respons label. LABEL_VIEW_FULL menampilkan semua kolom yang memungkinkan.

Contoh kode berikut menunjukkan cara menggunakan parameter kueri customer untuk mendapatkan daftar label:

Python

response = service.labels().list(
    customer='customers/CUSTOMER',
    view='LABEL_VIEW_FULL'
).execute()

Node.js

const params = {
  customer: 'customers/CUSTOMER',
  view: 'LABEL_VIEW_FULL'
};

service.labels.list(params, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  const labels = res.data.labels;
  if (labels) {
    labels.forEach((label) => {
      const name = label.name;
      const title = label.properties.title;
      console.log(`${name}\t${title}`);
    });
  } else {
    console.log('No Labels');
  }
});

Ganti CUSTOMER dengan nama pelanggan.