Method: files.modifyLabels

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

HTTP リクエスト

POST https://www.googleapis.com/drive/v2/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 を使用すると、ファイルにラベルを適用したり、ファイルの既存のラベルを更新したり、ファイルからラベルを削除したりできます。

JSON 表現 
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
フィールド
labelId

string

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

object (FieldModification)

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

boolean

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

string

これは常に drive#labelModification です。

フィールドの変更

ラベルのフィールドに対する変更。

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

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