ラベルを検索

組織には複数のラベルがあり、ラベルには複数のフィールドが設定されている場合があります。Labels API は、ラベルの読み取りを可能にする labels コレクションを提供します。

このページでは、ラベルの検索と取得方法について説明します。

メソッド

labels コレクションには、ラベル値の読み取りを行う次のメソッドがあります。各メソッドは特定のタスクに対応しています。

範囲 参考資料
リソース名による単一ラベル labels.get
すべてのラベル labels.list

リソース名でラベルを取得する

リソース名で 1 つのラベルを取得するには、labels.get メソッドを使用します。

ラベルリソース名は必須で、次のように構成できます。

  • labels/{id} または labels/{id}@latest - 最新のラベル リビジョンを取得します。
  • labels/{id}@published - 現在の公開済みラベルのリビジョンを取得します。
  • labels/{id}@{revisionId} - 指定されたリビジョン ID のラベルを取得します。

また、以下も指定する必要があります。

  • LabelView は LABEL_VIEW_FULL で、レスポンスにラベルを付けるリソースビューを設定します。LABEL_VIEW_FULL は、使用可能なすべてのフィールドを返します。

この例では、Name を使用して、リソース名で単一のラベルを取得します。

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

すべてのラベルを一覧表示する

ラベルのリストを取得するには、labels.list メソッドを使用します。

また、以下も指定する必要があります。

  • このリスト リクエストのスコープを指定するための customer。customer が設定されていない場合、現在のお客様内のすべてのラベルが返されます。

  • LabelView は LABEL_VIEW_FULL で、レスポンスにラベルを付けるリソースビューを設定します。LABEL_VIEW_FULL は、使用可能なすべてのフィールドを返します。

この例では、CUSTOMER を使用してラベルリストを取得します。

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