Method: files.modifyLabels

مجموعه ای از برچسب های اعمال شده روی یک فایل را تغییر می دهد. لیستی از برچسب هایی را که اضافه یا اصلاح شده اند برمی گرداند.

درخواست HTTP

POST https://www.googleapis.com/drive/v3/files/{fileId}/modifyLabels

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

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

پارامترها
fileId

string

شناسه فایلی که برچسب ها به آن تعلق دارند.

درخواست بدن

بدنه درخواست شامل یک نمونه از ModifyLabelsRequest است.

بدن پاسخگو

پاسخ به درخواست files.modifyLabels. این فقط شامل آن دسته از برچسب هایی است که با درخواست اضافه یا به روز شده اند.

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

نمایندگی JSON 
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
فیلدها
modifiedLabels[]

object ( Label )

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

kind

string

این همیشه drive#modifyLabelsResponse است

محدوده مجوز

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

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

ModifyLabelsRequest

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

نمایندگی JSON 
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
فیلدها
labelModifications[]

object ( LabelModification )

لیستی از تغییرات برای اعمال بر روی برچسب های روی فایل.

kind

string

این همیشه drive#modifyLabelsRequest است.

LabelModification

اصلاح یک برچسب روی یک فایل. LabelModification می‌تواند برای اعمال یک برچسب به یک فایل، به‌روزرسانی برچسب موجود روی یک فایل، یا حذف یک برچسب از یک فایل استفاده شود.

نمایندگی JSON 
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
فیلدها
labelId

string

شناسه برچسب برای تغییر.

fieldModifications[]

object ( FieldModification )

لیستی از تغییرات در فیلدهای این برچسب.

removeLabel

boolean

اگر درست باشد، برچسب از فایل حذف خواهد شد.

kind

string

این همیشه درایو#labelModification است.

FieldModification

تغییر در فیلد یک برچسب.

نمایندگی JSON 
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
فیلدها
fieldId

string

شناسه فیلدی که باید اصلاح شود.

kind

string

این همیشه درایو#labelFieldModification است.

setDateValues[]

string

مقدار فیلد date را با این مقادیر جدید جایگزین می کند. رشته باید در قالب RFC 3339 با تاریخ کامل باشد: YYYY-MM-DD.

setTextValues[]

string

مقدار یک فیلد text را تنظیم می کند.

setSelectionValues[]

string

یک فیلد selection را با این مقادیر جدید جایگزین می کند.

setIntegerValues[]

string ( int64 format)

مقدار یک فیلد integer را با این مقادیر جدید جایگزین می کند.

setUserValues[]

string

یک فیلد user را با این مقادیر جدید جایگزین می کند. مقادیر باید آدرس ایمیل معتبر باشند.

unsetValues

boolean

مقادیر این فیلد را از حالت تنظیم خارج می کند.