Method: labels.delta

با اعمال مجموعه‌ای از درخواست‌های به‌روزرسانی که منجر به ویرایش پیش‌نویس جدید می‌شود، یک برچسب را به‌روزرسانی می‌کند. به روز رسانی دسته ای همه یا هیچ است: اگر هر یک از درخواست های به روز رسانی نامعتبر باشد، هیچ تغییری اعمال نمی شود. پیش‌نویس بازبینی حاصل باید قبل از استفاده از تغییرات با موارد Drive منتشر شود.

درخواست HTTP

POST https://drivelabels.googleapis.com/v2beta/{name=labels/*}:delta

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

ضروری. نام منبع برچسب برای به‌روزرسانی.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
زمینه های
writeControl

object ( WriteControl )

کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند.

requests[]

object ( Request )

فهرستی از به‌روزرسانی‌هایی که باید برای Label اعمال شوند. درخواست ها به ترتیبی که مشخص شده اند اعمال خواهند شد.

useAdminAccess

boolean

برای استفاده از اعتبارنامه مدیریت کاربر، روی true تنظیم کنید. سرور قبل از اجازه دسترسی، تأیید می‌کند که کاربر یک سرپرست برای Label است.

view

enum ( LabelView )

وقتی مشخص شد، فقط فیلدهای خاصی که به نمای مشخص شده تعلق دارند بازگردانده می شوند.

languageCode

string

کد زبان BCP-47 که برای ارزیابی برچسب های فیلد محلی سازی شده استفاده می شود، زمانی که include_label_in_response true است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پاسخ برای به‌روزرسانی برچسب.

نمایندگی JSON
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
زمینه های
responses[]

object ( Response )

پاسخ به روز رسانی ها این نقشه با به روز رسانی ها 1:1 است، اگرچه ممکن است پاسخ به برخی از درخواست ها خالی باشد.

updatedLabel

object ( Label )

برچسب پس از به‌روزرسانی اعمال شد. این فقط در صورتی تنظیم می‌شود که [BatchUpdateLabelResponse2.include_label_in_response] true باشد و هیچ خطایی وجود نداشته باشد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

درخواست

یک نوع به‌روزرسانی برای اعمال به یک برچسب.

نمایندگی JSON
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
زمینه های
kind میدان اتحادیه . نوع به روز رسانی. دقیقاً یک فیلد مورد نیاز است. kind می تواند تنها یکی از موارد زیر باشد:
updateLabel

object ( UpdateLabelPropertiesRequest )

ویژگی های Label را به روز می کند.

createField

object ( CreateFieldRequest )

یک فیلد جدید ایجاد می کند.

updateField

object ( UpdateFieldPropertiesRequest )

ویژگی های اساسی یک فیلد را به روز می کند.

updateFieldType

object ( UpdateFieldTypeRequest )

گزینه های نوع و/یا نوع فیلد را به روز کنید.

enableField

object ( EnableFieldRequest )

فیلد را فعال می کند.

disableField

object ( DisableFieldRequest )

فیلد را غیرفعال می کند.

deleteField

object ( DeleteFieldRequest )

یک فیلد را از برچسب حذف می کند.

createSelectionChoice

object ( CreateSelectionChoiceRequest )

انتخاب را در یک فیلد انتخاب ایجاد می کند.

updateSelectionChoiceProperties

object ( UpdateSelectionChoicePropertiesRequest )

ویژگی های انتخاب را در یک فیلد انتخاب به روز کنید.

enableSelectionChoice

object ( EnableSelectionChoiceRequest )

یک انتخاب را در یک فیلد انتخاب فعال کنید.

disableSelectionChoice

object ( DisableSelectionChoiceRequest )

انتخاب را در یک فیلد انتخاب غیرفعال کنید.

deleteSelectionChoice

object ( DeleteSelectionChoiceRequest )

یک انتخاب را در یک فیلد انتخاب حذف کنید.

UpdateLabelPropertiesRequest

ویژگی های اساسی یک برچسب را به روز می کند.

نمایندگی JSON
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. ریشه label_properties به صورت ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

properties

object ( Properties )

ضروری. ویژگی ها را برای به روز رسانی برچسب بزنید.

CreateFieldRequest

درخواست ایجاد یک فیلد در یک برچسب.

نمایندگی JSON
{
  "field": {
    object (Field)
  }
}
زمینه های
field

object ( Field )

ضروری. زمینه برای ایجاد.

UpdateFieldPropertiesRequest

درخواست به روز رسانی ویژگی های فیلد.

نمایندگی JSON
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. properties ریشه به صورت ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

id

string

ضروری. زمینه به روز رسانی.

properties

object ( Properties )

ضروری. ویژگی های پایه پایه

UpdateFieldTypeRequest

درخواست تغییر نوع یک فیلد.

نمایندگی JSON
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. ریشه type_options ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

id

string

ضروری. زمینه به روز رسانی.

فیلد اتحادیه type_options .

type_options فقط می تواند یکی از موارد زیر باشد:

textOptions

object ( TextOptions )

فیلد را به متن به روز کنید.

longTextOptions

object ( LongTextOptions )

فیلد را به Long Text به روز کنید.

integerOptions

object ( IntegerOptions )

فیلد را به عدد صحیح به روز کنید.

dateOptions

object ( DateOptions )

به روز رسانی فیلد به تاریخ.

selectionOptions

object ( SelectionOptions )

فیلد را به Selection به روز کنید.

userOptions

object ( UserOptions )

فیلد را به کاربر به روز کنید.

LongTextOptions

نوع فیلد Long Text را انتخاب می کند.

نمایندگی JSON
{
  "minLength": integer,
  "maxLength": integer
}
زمینه های
minLength

integer

فقط خروجی حداقل طول معتبر مقادیر برای فیلد متنی.

maxLength

integer

فقط خروجی حداکثر طول معتبر مقادیر برای فیلد متنی.

EnableFieldRequest

درخواست فعال کردن فیلد.

نمایندگی JSON
{
  "id": string
}
زمینه های
id

string

ضروری. شناسه فیلد برای فعال کردن

DisableFieldRequest

درخواست غیرفعال کردن فیلد.

نمایندگی JSON
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. ریشه disabledPolicy ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

id

string

ضروری. کلید فیلد برای غیرفعال کردن

disabledPolicy

object ( DisabledPolicy )

ضروری. خط مشی غیرفعال کردن فیلد.

DeleteFieldRequest

درخواست حذف فیلد

نمایندگی JSON
{
  "id": string
}
زمینه های
id

string

ضروری. شناسه فیلد برای حذف

CreateSelectionChoiceRequest

درخواست ایجاد انتخاب انتخاب.

نمایندگی JSON
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
زمینه های
fieldId

string

ضروری. فیلد انتخاب که در آن یک انتخاب ایجاد می شود.

choice

object ( Choice )

ضروری. انتخاب برای ایجاد.

UpdateSelectionChoicePropertiesRequest

درخواست به‌روزرسانی ویژگی‌های Choice.

نمایندگی JSON
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. properties ریشه به صورت ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

fieldId

string

ضروری. فیلد انتخاب برای به روز رسانی.

id

string

ضروری. انتخاب برای به روز رسانی.

properties

object ( Properties )

ضروری. ویژگی های Choice برای به روز رسانی.

EnableSelectionChoiceRequest را فعال کنید

درخواست برای فعال کردن یک انتخاب.

نمایندگی JSON
{
  "fieldId": string,
  "id": string
}
زمینه های
fieldId

string

ضروری. فیلد انتخاب که در آن یک انتخاب فعال خواهد شد.

id

string

ضروری. انتخاب برای فعال کردن

DisableSelectionChoiceRequest

درخواست غیرفعال کردن یک انتخاب.

نمایندگی JSON
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
زمینه های
updateMask

string ( FieldMask format)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. ریشه disabledPolicy ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد، می‌توان از یک * به‌عنوان علامت کوتاه استفاده کرد.

fieldId

string

ضروری. فیلد انتخاب که در آن یک انتخاب غیرفعال می شود.

id

string

ضروری. انتخاب برای غیرفعال کردن

disabledPolicy

object ( DisabledPolicy )

ضروری. خط مشی غیرفعال برای به روز رسانی.

DeleteSelectionChoiceRequest

درخواست حذف یک انتخاب.

نمایندگی JSON
{
  "fieldId": string,
  "id": string
}
زمینه های
fieldId

string

ضروری. فیلد انتخابی که یک انتخاب از آن حذف خواهد شد.

id

string

ضروری. انتخاب برای حذف

واکنش

یک پاسخ واحد از یک به روز رسانی.

نمایندگی JSON
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
زمینه های
response میدانی اتحادیه پاسخ به درخواست مربوطه response فقط می تواند یکی از موارد زیر باشد:
updateLabel

object ( UpdateLabelPropertiesResponse )

ویژگی های اساسی یک برچسب به روز شده است.

createField

object ( CreateFieldResponse )

یک فیلد جدید ایجاد می کند.

updateField

object ( UpdateFieldPropertiesResponse )

ویژگی های اساسی یک فیلد را به روز می کند.

updateFieldType

object ( UpdateFieldTypeResponse )

گزینه های نوع و/یا نوع فیلد را به روز کنید.

enableField

object ( EnableFieldResponse )

فیلد را فعال می کند.

disableField

object ( DisableFieldResponse )

فیلد را غیرفعال می کند.

deleteField

object ( DeleteFieldResponse )

یک فیلد را از برچسب حذف می کند.

createSelectionChoice

object ( CreateSelectionChoiceResponse )

یک گزینه لیست انتخاب جدید برای افزودن به یک قسمت انتخاب ایجاد می کند.

updateSelectionChoiceProperties

object ( UpdateSelectionChoicePropertiesResponse )

انتخاب را در یک فیلد انتخابی به روز می کند.

enableSelectionChoice

object ( EnableSelectionChoiceResponse )

یک انتخاب را در یک فیلد انتخاب فعال می کند.

disableSelectionChoice

object ( DisableSelectionChoiceResponse )

انتخاب را در یک فیلد انتخاب غیرفعال می کند.

deleteSelectionChoice

object ( DeleteSelectionChoiceResponse )

یک انتخاب را از یک فیلد انتخاب حذف می کند.

UpdateLabelPropertiesResponse

پس از به‌روزرسانی ویژگی‌های Label، پاسخ دهید.

CreateFieldResponse

پاسخ زیر ایجاد فیلد.

نمایندگی JSON
{
  "id": string,
  "priority": integer
}
زمینه های
id

string

فیلد فیلد ایجاد شده. وقتی در یک درخواست ایجاد خالی بماند، یک کلید به طور خودکار تولید می‌شود و در اینجا قابل شناسایی است.

priority

integer

اولویت فیلد ایجاد شده اولویت ممکن است از آنچه مشخص شده است برای اطمینان از اولویت های پیوسته بین فیلدها (1-n) تغییر کند.

UpdateFieldPropertiesResponse

پاسخ پس از به روز رسانی به خواص فیلد.

نمایندگی JSON
{
  "priority": integer
}
زمینه های
priority

integer

اولویت فیلد به روز شده اولویت ممکن است از آنچه مشخص شده است برای اطمینان از اولویت های پیوسته بین فیلدها (1-n) تغییر کند.

UpdateFieldTypeResponse

پس از به‌روزرسانی به نوع فیلد پاسخ دهید.

EnableFieldResponse

پاسخ زیر فیلد را فعال کنید.

DisableFieldResponse

پاسخ زیر فیلد را غیرفعال کنید.

DeleteFieldResponse

پاسخ زیر حذف فیلد.

CreateSelectionChoiceResponse

پاسخ زیر انتخاب انتخاب ایجاد کنید.

نمایندگی JSON
{
  "fieldId": string,
  "id": string
}
زمینه های
fieldId

string

شناسه فیلد ایجاد شده توسط سرور.

id

string

شناسه ایجاد شده توسط سرور انتخاب ایجاد شده در فیلد

UpdateSelectionChoicePropertiesResponse

پس از به‌روزرسانی به ویژگی‌های Selection Choice پاسخ دهید.

نمایندگی JSON
{
  "priority": integer
}
زمینه های
priority

integer

اولویت انتخاب به روز شده. اولویت ممکن است از آنچه که مشخص شده بود تغییر کند تا از اولویت های پیوسته بین انتخاب ها اطمینان حاصل شود (1-n).

EnableSelectionChoiceResponse را فعال کنید

پاسخ پس از انتخاب را فعال کنید.

DisableSelectionChoiceResponse

پاسخ به دنبال انتخاب غیرفعال شود.

DeleteSelectionChoiceResponse

پاسخ پس از انتخاب حذف.