建立；發布標籤(&P)

本頁說明如何建立並發布標籤。

建立標籤

如要建立標籤，請針對 labels 集合使用 create 方法。標籤則可視需要包含一或多個 Fields。

您還必須指定：

  • LabelType。

  • 透過 property 方法提供的標籤 title。

  • useAdminAccess：true，以便使用使用者的管理員憑證。伺服器會先驗證使用者是否為擁有「管理標籤」權限的管理員，然後再授予存取權。

這個範例會建立含有指定標題的標準管理員標籤，以及一個含有 2 個 Choices 的 SelectionOptions Field。

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

系統會在 UNPUBLISHED_DRAFT State 中建立標籤。此值必須為 PUBLISHED 才能用於檔案，且使用者可以看見。詳情請參閱「標籤生命週期」一文。

標籤限制

建立及套用標籤時適用以下限制：

  • 標準標籤：150
  • 每個標籤的欄位數：10
  • 每個檔案的使用者套用標籤 - 5

使用標籤中的欄位

Field Type 使用者可執行的操作 格式註意事項和限制
SelectionOptions 從清單中選取一或多個選項 最多可支援 200 個選項
每個檔案最多只能包含 10 個選項，如 ListOptions 中所設定
IntegerOptions 輸入數值 僅支援整數
DateOptions 選取日曆日期 (選用步驟) Date format 可設為「長：<月份> 日、<日期>」或「短：MM/DD/YY」
TextOptions 在文字方塊中輸入文字 最多可支援 100 個字元
UserOptions 從 Google Workspace 聯絡人中選取一或多位使用者。 檔案的使用者項目數量上限為 10 個，如 ListOptions 中所設定

發布標籤

Labels API 可讓您在標籤完成後發布草稿。

如要發布標籤，請使用 publish 方法並指定：

  • 代表每個標籤的標籤資源。其中包含資源 Name 和 ID，這是標籤的全域專屬 ID。

  • useAdminAccess：true，以便使用使用者的管理員憑證。伺服器會先驗證使用者是否為擁有「管理標籤」權限的管理員，然後再授予存取權。

這個範例使用 ID 來識別並發布正確的標籤。

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

發布標籤後，標籤會移至 PUBLISHED State，且標籤的修訂版本 ID 會增加。如此一來，使用者就能看到標籤，並可將標籤套用至檔案。詳情請參閱「標籤生命週期」一文。

發布標籤時的限制

  • 標籤發布後就無法還原為原始草稿狀態。詳情請參閱「標籤生命週期」。

  • 發布標籤會建立新發布的修訂版本。系統會刪除所有先前的草稿修訂版本。系統會保留先前發布的修訂版本，但會視需要自動刪除。

  • 發布後即無法再變更某些項目。一般而言，這表示任何為標籤相關現有中繼資料作廢或觸發新限制的變更都會遭到拒絕。舉例來說，標籤發布後即不允許對標籤進行以下變更：

    • 標籤會直接刪除。(必須先停用此功能，再予以刪除)。
    • Field.FieldType 已變更。
    • 欄位驗證選項的更新會拒絕先前接受的項目。
    • 項目數量上限減少。