ラベルを検索

組織は複数のラベルを持つことができ、そのラベルには複数のフィールドがあります。 Labels API には labels コレクションで ラベルの読み取りです。

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

メソッド

labels コレクションは、 次のメソッドでは、それぞれが特定のタスクを念頭に置いてラベル値を読み取ることができます。

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

リソース名で単一のラベルを取得するには、次のコマンドを使用します。 labels.get メソッドを使用します。

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

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

次の項目も指定する必要があります。

• LabelView: LABEL_VIEW_FULL は、ラベルの回答に適用するリソースビューを設定します。 LABEL_VIEW_FULL は指定可能なすべてのフィールドを返します。

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

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

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

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

次の項目も指定する必要があります。

• このスコープを設定する customer リクエストできます。customer が設定されていない場合、現在の 顧客が返されます。

• LabelView: LABEL_VIEW_FULL は、ラベルの回答に適用するリソースビューを設定します。 LABEL_VIEW_FULL は指定可能なすべてのフィールドを返します。

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

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