- درخواست 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/v2beta/{name=labels/*}:delta
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
name | ضروری. نام منبع برچسب برای بهروزرسانی. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "writeControl": { object ( |
زمینه های | |
---|---|
writeControl | کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند. |
requests[] | فهرستی از بهروزرسانیهایی که باید برای Label اعمال شوند. درخواست ها به ترتیبی که مشخص شده اند اعمال خواهند شد. |
useAdminAccess | برای استفاده از اعتبارنامه مدیریت کاربر، روی |
view | وقتی مشخص شد، فقط فیلدهای خاصی که به نمای مشخص شده تعلق دارند بازگردانده می شوند. |
languageCode | کد زبان BCP-47 که برای ارزیابی برچسب های فیلد محلی سازی شده استفاده می شود، زمانی که |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پاسخ برای بهروزرسانی برچسب.
نمایندگی JSON |
---|
{ "responses": [ { object ( |
زمینه های | |
---|---|
responses[] | پاسخ به روز رسانی ها این نقشه با به روز رسانی ها 1:1 است، اگرچه ممکن است پاسخ به برخی از درخواست ها خالی باشد. |
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 | ویژگی های Label را به روز می کند. |
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 | فیلد را به Long Text به روز کنید. |
integerOptions | فیلد را به عدد صحیح به روز کنید. |
dateOptions | به روز رسانی فیلد به تاریخ. |
selectionOptions | فیلد را به Selection به روز کنید. |
userOptions | فیلد را به کاربر به روز کنید. |
LongTextOptions
نوع فیلد Long Text را انتخاب می کند.
نمایندگی 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
درخواست بهروزرسانی ویژگیهای Choice.
نمایندگی JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
زمینه های | |
---|---|
updateMask | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. |
fieldId | ضروری. فیلد انتخاب برای به روز رسانی. |
id | ضروری. انتخاب برای به روز رسانی. |
properties | ضروری. ویژگی های Choice برای به روز رسانی. |
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
پس از بهروزرسانی ویژگیهای Label، پاسخ دهید.
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
پس از بهروزرسانی به ویژگیهای Selection Choice پاسخ دهید.
نمایندگی JSON |
---|
{ "priority": integer } |
زمینه های | |
---|---|
priority | اولویت انتخاب به روز شده. اولویت ممکن است از آنچه که مشخص شده بود تغییر کند تا از اولویت های پیوسته بین انتخاب ها اطمینان حاصل شود (1-n). |
EnableSelectionChoiceResponse را فعال کنید
پاسخ پس از انتخاب را فعال کنید.
DisableSelectionChoiceResponse
پاسخ به دنبال انتخاب غیرفعال شود.
DeleteSelectionChoiceResponse
پاسخ پس از انتخاب حذف.