Wyszukaj etykiety

Twoja organizacja może mieć wiele etykiet, a każda z nich może mieć kilka pól. Interfejs Labels API udostępnia kolekcję labels, która umożliwia odczytywanie etykiet.

Z tej strony dowiesz się, jak wyszukiwać i pobierać etykiety.

Metody

Kolekcja labels udostępnia te metody odczytywania wartości etykiet, z których każda ma określone zadanie:

Zakres Czytanie
Pojedyncza etykieta według nazwy zasobu labels.get
Wszystkie etykiety labels.list

Pobieranie etykiety według nazwy zasobu

Aby pobrać pojedynczą etykietę według jej nazwy zasobu, użyj metody labels.get.

Wymagana jest nazwa zasobu etykiety, która może mieć taką strukturę:

  • labels/{id} lub labels/{id}@latest – pobiera najnowszą wersję etykiety.
  • labels/{id}@published – pobiera aktualną opublikowaną wersję etykiety.
  • labels/{id}@{revisionId} – pobiera etykietę z określonym identyfikatorem wersji.

Musisz też podać:

  • LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu stosowany do odpowiedzi etykiet. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie używamy Name, aby pobrać pojedynczą etykietę według jej nazwy zasobu.

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);
});

Wyświetlanie listy wszystkich etykiet

Aby uzyskać listę etykiet, użyj metody labels.list.

Musisz też podać:

  • A customer, aby ograniczyć zakres tego żądania listy. Jeśli customer nie jest ustawiony, zwracane są wszystkie etykiety w ramach bieżącego klienta.

  • LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu stosowany do odpowiedzi etykiet. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie używamy CUSTOMER, aby pobrać listę etykiet.

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');
  }
});