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 表現 
{
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "labelId": string,
  "removeLabel": boolean,
  "kind": string
}
フィールド
fieldModifications[]

object (FieldModification)

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

string

変更するラベルの ID。
removeLabel

boolean

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

string

これは常に "drive#labelModification" です。

FieldModification

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

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

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

string

これは常に "drive#labelFieldModification" です。
unsetValues

boolean

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