本頁說明如何建立及發布標籤。
建立標籤
如要建立標籤,請在 labels
集合上使用 create
方法。標籤可選擇包含一或多個 Fields
。
您也必須指定下列項目:
透過
property
方法設定的標籤title
。useAdminAccess
是true
,用於使用使用者的管理員憑證。在允許存取權之前,伺服器會先驗證使用者是否為具備「管理標籤」權限的管理員。
這個範例會建立標準管理員標籤,其中包含指定標題和一個 SelectionOptions
Field
,以及 2 個 Choices
。
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()
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 可設為「長格式:<年份> 年 <月份> 月 <日期> 日」或「短格式:<月份>/<日期>/<年份>」 |
TextOptions |
在文字方塊中輸入文字 | 最多可支援 100 個字元 |
UserOptions |
從 Google Workspace 聯絡人中選取一或多位使用者。 | 如同在 ListOptions 中所設定,檔案的使用者項目數上限為 10 個 |
發布標籤
Labels API 可讓您在草稿標籤完成後發布。
如要發布標籤,請使用 publish
方法,並指定:
代表每個標籤的標籤資源。其中包含資源
Name
和ID
,這是標籤的全域專屬 ID。useAdminAccess
是true
,用於使用使用者的管理員憑證。在允許存取權之前,伺服器會先驗證使用者是否為具備「管理標籤」權限的管理員。
這個範例會使用 ID
來識別並發布正確的標籤。
service.labels().publish(
name='labels/ID ',
body={
'use_admin_access': True
}).execute()
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
已變更。- 欄位驗證選項的更新會拒絕先前接受的內容。
- 減少項目數量上限。