Wyszukaj etykiety

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

Na tej stronie dowiesz się, jak wyszukiwać i pobierać etykiety.

Metody

Kolekcja labels udostępnia te metody odczytywania wartości etykiet, z których każda jest przeznaczona do konkretnego zadania:

Pobieranie etykiety według nazwy zasobu

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

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

• labels/{id} lub labels/{id}@latest – pobiera najnowszą wersję etykiety.
• labels/{id}@published– pobiera bieżącą opublikowaną wersję etykiety.
• labels/{id}@{revisionId}– pobiera etykietę o określonym identyfikatorze wersji.

Musisz też podać:

• LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu zastosowany do odpowiedzi na etykiety. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie użyto Name, aby uzyskać jedną etykietę według jej nazwy zasobu.

# 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()

# 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ć:

• customer, do którego ma być ograniczona ta lista. Jeśli parametr customer nie jest ustawiony, zwracane są wszystkie etykiety w bieżącym kliencie.

• LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu zastosowany do odpowiedzi na etykiety. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie używamy CUSTOMER do pobrania listy etykiet.

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

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