Organisasi Anda dapat memiliki beberapa label, dengan label yang memiliki beberapa kolom.
Labels API menyediakan koleksi labels
untuk memungkinkan pembacaan label.
Halaman ini menjelaskan cara mencari dan mengambil label.
Metode
Koleksi labels
menyediakan
metode berikut untuk membaca nilai label, masing-masing dengan mempertimbangkan tugas tertentu:
Rentang | Reading |
---|---|
Satu label berdasarkan nama resource | labels.get |
All labels | labels.list |
Mendapatkan label berdasarkan nama resource
Untuk mendapatkan satu label berdasarkan nama resource, gunakan
metode labels.get
.
Nama resource label wajib diisi dan dapat disusun sebagai:
labels/{id}
ataulabels/{id}@latest
—Mendapatkan revisi label terbaru.labels/{id}@published
—Mendapatkan revisi label yang dipublikasikan saat ini.labels/{id}@{revisionId}
—Mendapatkan label di ID revisi yang ditentukan.
Anda juga harus menentukan:
LabelView
adalahLABEL_VIEW_FULL
untuk menetapkan tampilan Resource yang diterapkan ke respons label.LABEL_VIEW_FULL
menampilkan semua kolom yang mungkin.
Contoh ini menggunakan Name
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
name = "labels/NAME@published"
# Label view controls level of data in response
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);
});
Menampilkan daftar semua label
Untuk mendapatkan daftar label, gunakan
metode labels.list
.
Anda juga harus menentukan:
customer
untuk mencakup permintaan daftar ini. Jikacustomer
tidak disetel, semua label dalam pelanggan saat ini akan ditampilkan.LabelView
adalahLABEL_VIEW_FULL
untuk menetapkan tampilan Resource yang diterapkan ke respons label.LABEL_VIEW_FULL
menampilkan semua kolom yang mungkin.
Contoh ini menggunakan CUSTOMER
untuk mengambil 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');
}
});