ユーザーの Google フォト ライブラリに 1 つ以上のメディア アイテムを作成します。
これは、メディア アイテムを作成するための 2 つ目の手順です。ステップ 1(未加工のバイトを Google サーバーにアップロードする)について詳しくは、メディアをアップロードするをご覧ください。
この呼び出しにより、メディア アイテムがライブラリに追加されます。アルバム id
が指定されている場合は、そのアルバムにもメディア アイテムが追加されます。各アルバムには最大 20,000 個のメディア アイテムを含めることができます。デフォルトでは、メディア アイテムはライブラリまたはアルバムの末尾に追加されます。
アルバムの id
と位置の両方が定義されている場合、メディア アイテムはアルバムの指定された位置に追加されます。
呼び出しに複数のメディア アイテムが含まれている場合は、指定した位置にそれらのアイテムが追加されます。自分がオーナーではない共有アルバムにメディア アイテムを作成する場合、そのメディア アイテムの位置決めは行えません。そのようにすると、BAD REQUEST
エラーが発生します。
HTTP リクエスト
POST https://photoslibrary.googleapis.com/v1/mediaItems:batchCreate
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "albumId": string, "newMediaItems": [ { object ( |
フィールド | |
---|---|
albumId |
メディア アイテムが追加されるアルバムの ID。これらのメディア アイテムはユーザーのライブラリにも追加されます。このフィールドは省略できます。 |
newMediaItems[] |
必須。作成するメディア アイテムのリストです。呼び出しあたりのメディア アイテム数は最大 50 個です。 |
albumPosition |
メディア アイテムが追加されるアルバム内の位置。指定しない場合、メディア アイテムはアルバムの最後に追加されます(デフォルト値である |
レスポンスの本文
作成されたメディア アイテムのリスト。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"newMediaItemResults": [
{
object ( |
フィールド | |
---|---|
newMediaItemResults[] |
出力のみ。作成されたメディア アイテムのリスト。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/photoslibrary
https://www.googleapis.com/auth/photoslibrary.appendonly
https://www.googleapis.com/auth/photoslibrary.sharing
NewMediaItem
ユーザーの Google フォト アカウントで作成された新しいメディア アイテム。
JSON 表現 |
---|
{ "description": string, // Union field |
フィールド | |
---|---|
description |
メディア アイテムの説明です。これは、Google フォト アプリのアイテムの情報セクションに表示されます。1,000 文字未満で指定してください。ユーザーが作成したテキストのみを含める。説明文は、ユーザーがメディアの内容を理解できるよう、コンテキストを加えたものにする必要があります。ファイル名、タグ、その他のメタデータなどの自動生成された文字列は含めないでください。 |
共用体フィールド new_media_item_type 。新しいメディア アイテムにはさまざまなタイプを指定できます。これはアップロード パスによって異なります。現在サポートされているアップロードでは、シンプルなメディア アイテムのパスのみが使用されます。new_media_item_type は次のいずれかになります。 |
|
simpleMediaItem |
含まれている |
SimpleMediaItem
アップロード トークンを使用して Google フォトで作成されるシンプルなメディア アイテムです。
JSON 表現 |
---|
{ "uploadToken": string, "fileName": string } |
フィールド | |
---|---|
uploadToken |
Google にアップロードされたメディアバイトを識別するトークン。 |
fileName |
メディア アイテムの拡張子を持つファイル名。Google フォトでユーザーに表示されます。このフィールドが設定されている場合、バイト アップロード処理で指定されたファイル名は無視されます。ファイル名(ファイル拡張子を含む)は 255 文字以下にしてください。このフィールドは省略できます。 |
NewMediaItemResult
新しいメディア アイテムを作成した結果。
JSON 表現 |
---|
{ "uploadToken": string, "status": { object ( |
フィールド | |
---|---|
uploadToken |
この新しい(シンプルな)メディア アイテムの作成に使用されるアップロード トークンです。メディア アイテムがシンプルで、単一のアップロード トークンが必要な場合にのみ入力されます。 |
status |
このメディア アイテムの作成中にエラーが発生した場合、このフィールドにはエラーに関連する情報が入力されます。このフィールドの詳細については、ステータスをご覧ください。 |
mediaItem |
アップロード トークンで作成されたメディア アイテム。エラーが発生せず、メディア アイテムが正常に作成された場合に入力されます。 |