建立;發布標籤(&P)

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

建立標籤

如要建立標籤,請使用 create 方法 labels 集合。標籤可以 視需要包含 Fields

您也必須指定:

  • LabelType

  • 使用 title 標籤 property 方法。

  • useAdminAccesstrue,將會使用使用者的管理員憑證。 伺服器會驗證使用者是否是具備「管理標籤」的管理員權限 ,然後再授予存取權。

這個範例會建立具有指定標題和一個標題的標準管理員標籤 SelectionOptions敬上 Field,內含 2 個 Choices

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 可設為「長:月份 DD, YYYY」或「短:MM/DD/YY」
TextOptions 在文字方塊中輸入文字 最多可支援 100 個字元
UserOptions 選取一或多位 Google Workspace 聯絡人。 檔案的使用者項目數量上限為 10 個 (如 ListOptions 所設定)

發布標籤

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

如要發布標籤,請使用 publish 方法並指定以下項目:

  • 標籤資源 代表所有標籤其中包含資源 NameID, 是標籤的全域不重複 ID

  • useAdminAccesstrue,將會使用使用者的管理員憑證。 伺服器會驗證使用者是否是具備「管理標籤」的管理員權限 ,然後再授予存取權。

這個範例使用 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 會遞增。使用者就能看到這個標籤 檔案。詳情請參閱「標籤 生命週期

發布標籤的限制

  • 標籤發布後即無法還原為原始草稿狀態。如要 相關資訊,請參閱標籤生命週期

  • 發布標籤時會建立新的修訂版本。所有先前的草稿 就會刪除修訂版本記錄系統會保留先前發布的修訂版本, 並視需求自動刪除。

  • 發布後,部分變更內容將會停用。一般來說,這意味著 任何會導致資料失效或觸發新限制的變更 與標籤相關的中繼資料遭拒。例如,下列 發布標籤後即無法變更標籤:

    • 系統會直接刪除標籤。(您必須先停用這個選項,然後 deleted.)
    • Field.FieldType 已變更。
    • 欄位驗證選項的更新作業拒絕先前的變更 接受。
    • 減少項目數量上限。