- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- NewMediaItem
- SimpleMediaItem
- NewMediaItemResult
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 試してみる
ユーザーの 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 |
メディア アイテムが追加されるアルバムの識別子。メディア アイテムはユーザーのライブラリにも追加されます。このフィールドは省略できます。 |
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 |
アップロード トークンを使用して作成されたメディア アイテム。エラーが発生せず、メディア アイテムが正常に作成された場合に入力されます。 |