Method: files.modifyLabels

ファイルに適用されているラベルのセットを変更します。追加または変更されたラベルのリストを返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
fileId

string

ラベルが属するファイルの ID。

リクエスト本文

リクエストの本文には 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

変更するラベルの ID。
fieldModifications[]

object (FieldModification)

このラベルのフィールドに対する変更のリスト。
removeLabel

boolean

true の場合、ファイルからラベルが削除されます。
kind

string

常に drive#labelModification です。

FieldModification

ラベルのフィールドの変更。

JSON 表現 
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
フィールド
fieldId

string

変更するフィールドの ID。
kind

string

常に drive#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

このフィールドの値の設定を解除します。