Method: files.modifyLabels
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
مجموعه ای از برچسب های اعمال شده روی یک فایل را تغییر می دهد. لیستی از برچسب هایی را که اضافه یا اصلاح شده اند برمی گرداند.
درخواست HTTP
POST https://www.googleapis.com/drive/v2/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 |
|---|
{
"fieldModifications": [
{
object (FieldModification)
}
],
"labelId": string,
"removeLabel": boolean,
"kind": string
} |
| فیلدها |
|---|
fieldModifications[] | object ( FieldModification ) لیستی از تغییرات در فیلدهای این برچسب. |
labelId | string شناسه برچسب برای تغییر. |
removeLabel | boolean اگر درست باشد، برچسب از فایل حذف خواهد شد. |
kind | string این همیشه drive#labelModification است. |
فیلد اصلاح
| نمایندگی JSON |
|---|
{
"setDateValues": [
string
],
"setTextValues": [
string
],
"setSelectionValues": [
string
],
"setIntegerValues": [
string
],
"setUserValues": [
string
],
"fieldId": string,
"kind": string,
"unsetValues": boolean
} |
| فیلدها |
|---|
setDateValues[] | string مقدار فیلد date را با این مقادیر جدید جایگزین می کند. رشته باید در قالب RFC 3339 با تاریخ کامل باشد: YYYY-MM-DD. |
setTextValues[] | string مقدار یک فیلد text را تنظیم می کند. |
setSelectionValues[] | string یک فیلد selection با این مقادیر جدید جایگزین می کند. |
setIntegerValues[] | string ( int64 format) مقدار یک فیلد integer را با این مقادیر جدید جایگزین می کند. |
setUserValues[] | string یک فیلد user را با این مقادیر جدید جایگزین می کند. مقادیر باید آدرس ایمیل معتبر باشند. |
fieldId | string شناسه فیلدی که باید اصلاح شود. |
kind | string این همیشه drive#labelFieldModification است. |
unsetValues | boolean مقادیر این فیلد را از حالت تنظیم خارج می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: files.modifyLabels\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ModifyLabelsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [ModifyLabelsRequest](#ModifyLabelsRequest)\n - [JSON representation](#ModifyLabelsRequest.SCHEMA_REPRESENTATION)\n- [LabelModification](#LabelModification)\n - [JSON representation](#LabelModification.SCHEMA_REPRESENTATION)\n- [FieldModification](#FieldModification)\n - [JSON representation](#FieldModification.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nModifies the set of labels applied to a file. Returns a list of the labels that were added or modified.\n\n### HTTP request\n\n`POST https://www.googleapis.com/drive/v2/files/{fileId}/modifyLabels`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------|\n| `fileId` | `string` The ID of the file to which the labels belong. |\n\n### Request body\n\nThe request body contains an instance of [ModifyLabelsRequest](/workspace/drive/api/reference/rest/v2/files/modifyLabels#ModifyLabelsRequest).\n\n### Response body\n\nResponse to a files.modifyLabels request. This contains only those labels which were added or updated by the request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------|\n| ``` { \"modifiedLabels\": [ { object (/workspace/drive/api/reference/rest/v2/Label) } ], \"kind\": string } ``` |\n\n| Fields ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `modifiedLabels[]` | `object (`[Label](/workspace/drive/api/reference/rest/v2/Label)`)` The list of labels which were added or updated by the request. |\n| `kind` | `string` This is always `drive#modifyLabelsResponse` |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n\nSome scopes are restricted and require a security assessment for your app to use them. For more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nModifyLabelsRequest\n-------------------\n\nA request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"labelModifications\": [ { object (/workspace/drive/api/reference/rest/v2/files/modifyLabels#LabelModification) } ], \"kind\": string } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `labelModifications[]` | `object (`[LabelModification](/workspace/drive/api/reference/rest/v2/files/modifyLabels#LabelModification)`)` The list of modifications to apply to the labels on the file. |\n| `kind` | `string` This is always `drive#modifyLabelsRequest`. |\n\nLabelModification\n-----------------\n\nA modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"fieldModifications\": [ { object (/workspace/drive/api/reference/rest/v2/files/modifyLabels#FieldModification) } ], \"labelId\": string, \"removeLabel\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fieldModifications[]` | `object (`[FieldModification](/workspace/drive/api/reference/rest/v2/files/modifyLabels#FieldModification)`)` The list of modifications to this label's fields. |\n| `labelId` | `string` The ID of the label to modify. |\n| `removeLabel` | `boolean` If true, the label will be removed from the file. |\n| `kind` | `string` This is always `drive#labelModification`. |\n\nFieldModification\n-----------------\n\nA modification to a label's field.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"setDateValues\": [ string ], \"setTextValues\": [ string ], \"setSelectionValues\": [ string ], \"setIntegerValues\": [ string ], \"setUserValues\": [ string ], \"fieldId\": string, \"kind\": string, \"unsetValues\": boolean } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `setDateValues[]` | `string` Replaces the value of a `date` field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD. |\n| `setTextValues[]` | `string` Sets the value of a `text` field. |\n| `setSelectionValues[]` | `string` Replaces a `selection` field with these new values. |\n| `setIntegerValues[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Replaces the value of an `integer` field with these new values. |\n| `setUserValues[]` | `string` Replaces a `user` field with these new values. The values must be valid email addresses. |\n| `fieldId` | `string` The ID of the field to be modified. |\n| `kind` | `string` This is always `drive#labelFieldModification`. |\n| `unsetValues` | `boolean` Unsets the values for this field. |"]]
