- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- בקשה
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- תשובה
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- רוצים לנסות?
מעדכן תווית אחת על ידי החלת קבוצה של בקשות עדכון, שהתוצאה שלה היא טיוטה חדשה של טיוטה. עדכון בכמות גדולה הוא הכול או כלום: אם בקשה כלשהי לעדכון לא חוקית, לא יחולו שינויים. יש לפרסם את גרסת הטיוטה שהתקבלה לפני שניתן יהיה להשתמש בשינויים עם פריטים ב-Drive.
בקשת HTTP
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
חובה. שם המשאב של התווית שיש לעדכן. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "writeControl": { object ( |
שדות | |
---|---|
writeControl |
שליטה על האופן שבו בקשות כתיבה מבוצעות. |
requests[] |
רשימה של עדכונים שיחולו על התווית. הבקשות יוחלו לפי הסדר שבו הן מפורטות. |
useAdminAccess |
כדי להשתמש בפרטי הכניסה של האדמין של המשתמש צריך להגדיר את הערך |
view |
כאשר המאפיין מוגדר, יוחזרו רק שדות מסוימים ששייכים לתצוגה המפורטת שצוינה. |
languageCode |
קוד השפה BCP-47 שבו יש להשתמש כדי להעריך תוויות שדות שמותאמות לשוק המקומי כשהערך של |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
תשובה לגבי עדכון התווית.
ייצוג JSON |
---|
{ "responses": [ { object ( |
שדות | |
---|---|
responses[] |
התשובה לגבי העדכונים. זהו מיפוי אחד על אחד עם העדכונים, אף על פי שהתשובות לבקשות מסוימות עשויות להיות ריקות. |
updatedLabel |
התווית לאחר החלת העדכונים. היא מוגדרת רק אם [BatchUpdateLabelResponse2.include_label_in_response] הוא |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/drive.labels
https://www.googleapis.com/auth/drive.admin.labels
למידע נוסף, עיינו במדריך ההרשאות.
בקשה
סוג אחד של עדכון שניתן להחיל על תווית.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד kind . סוג העדכון. רק שדה אחד הוא שדה חובה. kind יכול להיות רק אחד מהבאים: |
|
updateLabel |
עדכון המאפיינים של התווית. |
createField |
יצירת שדה חדש. |
updateField |
עדכון מאפיינים בסיסיים של שדה. |
updateFieldType |
עדכון האפשרויות של סוג ו/או סוג השדה. |
enableField |
הפעלת השדה. |
disableField |
משבית את השדה. |
deleteField |
מחיקת שדה מהתווית. |
createSelectionChoice |
יוצר בחירה בשדה 'בחירה'. |
updateSelectionChoiceProperties |
עדכון מאפיינים של בחירה בשדה בחירה. |
enableSelectionChoice |
הפעלת בחירה בשדה בחירה. |
disableSelectionChoice |
להשבית בחירה בשדה בחירה. |
deleteSelectionChoice |
מחיקת בחירה בשדה בחירה. |
UpdateLabelPropertiesRequest
עדכון מאפיינים בסיסיים של תווית.
ייצוג JSON |
---|
{
"updateMask": string,
"properties": {
object ( |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש |
properties |
חובה. יש להוסיף תוויות למאפיינים שרוצים לעדכן. |
CreateFieldRequest
מבקשים ליצור שדה בתוך תווית.
ייצוג JSON |
---|
{
"field": {
object ( |
שדות | |
---|---|
field |
חובה. שדה ליצירה. |
UpdateFieldPropertiesRequest
בקשה לעדכון מאפייני שדה.
ייצוג JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש |
id |
חובה. השדה לעדכון. |
properties |
חובה. מאפייני שדה בסיסיים. |
UpdateFieldTypeRequest
בקשה לשינוי הסוג של שדה.
ייצוג JSON |
---|
{ "updateMask": string, "id": string, // Union field |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש של |
id |
חובה. השדה לעדכון. |
שדה איחוד
|
|
textOptions |
עדכון השדה ל'טקסט'. |
longTextOptions |
מעדכנים את השדה ל'טקסט ארוך'. |
integerOptions |
מעדכנים את השדה ל'מספר שלם'. |
dateOptions |
עדכון השדה ל'תאריך'. |
selectionOptions |
מעדכנים את השדה ל'בחירה'. |
userOptions |
עדכון השדה ל'משתמש'. |
LongTextOptions
אפשרויות: סוג השדה 'טקסט ארוך'.
ייצוג JSON |
---|
{ "minLength": integer, "maxLength": integer } |
שדות | |
---|---|
minLength |
פלט בלבד. האורך המינימלי החוקי של הערכים בשדה הטקסט. |
maxLength |
פלט בלבד. האורך המקסימלי של הערכים החוקיים בשדה הטקסט. |
EnableFieldRequest
צריך לשלוח בקשה להפעלת השדה.
ייצוג JSON |
---|
{ "id": string } |
שדות | |
---|---|
id |
חובה. מזהה השדה שיש להפעיל. |
DisableFieldRequest
בקשה להשבית את השדה.
ייצוג JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש |
id |
חובה. מפתח השדה להשבתה. |
disabledPolicy |
חובה. מדיניות השבתת שדה. |
DeleteFieldRequest
בקשה למחיקת השדה.
ייצוג JSON |
---|
{ "id": string } |
שדות | |
---|---|
id |
חובה. מזהה השדה למחיקה. |
CreateSelectionChoiceRequest
יש לשלוח בקשה ליצירת אפשרות בחירה.
ייצוג JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
שדות | |
---|---|
fieldId |
חובה. שדה הבחירה שבו תיווצר בחירה. |
choice |
חובה. הבחירה ליצור. |
UpdateSelectionChoicePropertiesRequest
שליחת בקשה לעדכון נכסים של בחירה.
ייצוג JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש |
fieldId |
חובה. שדה הבחירה לעדכון. |
id |
חובה. הבחירה לעדכן. |
properties |
חובה. המאפיינים 'בחירה' לעדכון. |
EnableSelectionChoiceRequest
שליחת בקשה להפעלה של אפשרות בחירה.
ייצוג JSON |
---|
{ "fieldId": string, "id": string } |
שדות | |
---|---|
fieldId |
חובה. שדה הבחירה שבו תופעל בחירה. |
id |
חובה. בוחרים להפעיל. |
DisableSelectionChoiceRequest
שליחת בקשה להשבתה של אפשרות.
ייצוג JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
שדות | |
---|---|
updateMask |
השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש |
fieldId |
חובה. שדה הבחירה שבו הבחירה תושבת. |
id |
חובה. יש לבחור את האפשרות להשבית. |
disabledPolicy |
חובה. המדיניות המושבתת שצריך לעדכן. |
DeleteSelectionChoiceRequest
שליחת בקשה למחיקה של אפשרות.
ייצוג JSON |
---|
{ "fieldId": string, "id": string } |
שדות | |
---|---|
fieldId |
חובה. שדה הבחירה שממנו תימחק הבחירה. |
id |
חובה. אפשרות למחוק. |
תשובה
תשובה אחת מעדכון.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד response . התשובה לבקשה התואמת. response יכול להיות רק אחד מהבאים: |
|
updateLabel |
מאפיינים בסיסיים של תווית עודכנו. |
createField |
יצירת שדה חדש. |
updateField |
עדכון מאפיינים בסיסיים של שדה. |
updateFieldType |
עדכון האפשרויות של סוג ו/או סוג השדה. |
enableField |
הפעלת שדה. |
disableField |
השבתת השדה. |
deleteField |
מחיקת שדה מהתווית. |
createSelectionChoice |
יצירת אפשרות חדשה של רשימת בחירות להוספה לשדה בחירה. |
updateSelectionChoiceProperties |
מעדכן בחירה בשדה בחירה. |
enableSelectionChoice |
מפעיל בחירה בשדה בחירה. |
disableSelectionChoice |
משביתה בחירה בשדה בחירה. |
deleteSelectionChoice |
מחיקת בחירה משדה בחירה. |
UpdateLabelPropertiesResponse
התשובה שהתקבלה לאחר עדכון של מאפייני תווית.
CreateFieldResponse
התקבלה תגובה בעקבות 'יצירת שדה'.
ייצוג JSON |
---|
{ "id": string, "priority": integer } |
שדות | |
---|---|
id |
השדה של השדה שנוצר. אם השדה יישאר ריק בבקשת יצירה, ייווצר מפתח באופן אוטומטי ואפשר יהיה לזהות אותו כאן. |
priority |
העדיפות של השדה שנוצר. העדיפות עשויה להשתנות ממה שצוין כדי להבטיח רציפות בסדר העדיפויות בין השדות (1-n). |
UpdateFieldPropertiesResponse
התשובה שהתקבלה לאחר עדכון של מאפייני שדה.
ייצוג JSON |
---|
{ "priority": integer } |
שדות | |
---|---|
priority |
העדיפות של השדה המעודכן. העדיפות עשויה להשתנות ממה שצוין כדי להבטיח רציפות בסדר העדיפויות בין השדות (1-n). |
UpdateFieldTypeResponse
התשובה שהתקבלה לאחר עדכון לסוג השדה.
EnableFieldResponse
התשובה 'הפעלת שדה'.
DisableFieldResponse
השבתה של התשובה אחרי השדה 'שדה'.
DeleteFieldResponse
התשובה שהתקבלה לאחר 'מחיקה של השדה'.
CreateSelectionChoiceResponse
התשובה שנוצרה לאחר יצירת האפשרות שנבחרה.
ייצוג JSON |
---|
{ "fieldId": string, "id": string } |
שדות | |
---|---|
fieldId |
המזהה של השדה שנוצר על ידי השרת. |
id |
המזהה שנוצר על ידי השרת של הבחירה שנוצרה בשדה |
UpdateSelectionChoicePropertiesResponse
התשובה שתוצג אחרי עדכון המאפיינים של האפשרות שנבחרה.
ייצוג JSON |
---|
{ "priority": integer } |
שדות | |
---|---|
priority |
העדיפות של הבחירה המעודכנת. רמת העדיפות עשויה להשתנות מהערך שהוגדר כדי להבטיח סדר עדיפויות עקבי בין האפשרויות (1-n). |
EnableSelectionChoiceResponse
התשובה שאחרי האפשרות 'בחירה' מופעלת.
DisableSelectionChoiceResponse
הושבתה התשובה אחרי האפשרות 'בחירה'.
DeleteSelectionChoiceResponse
התשובה אחרי המחיקה של האפשרות שנבחרה.