Skip to content

メディアライブラリにアセットをアップロードする

post

/media_library/create

このエンドポイントを使用すると、外部でホストされているURL（asset_url）またはリクエスト本文で送信されたバイナリファイルデータ（asset_file）のいずれかを使用して、Brazeメディアライブラリにアセットを追加できます。このエンドポイントは画像と、画像を含むZIPファイルをサポートしています。

前提条件

このエンドポイントを使用するには、media_library.create 権限を持つAPIキーが必要です。

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエスト本文

asset_urlを含めると、エンドポイントはURLからファイルをダウンロードします。asset_fileを含めると、エンドポイントはリクエスト本文のバイナリデータを使用します。

asset_urlのリクエスト本文の例：

1
2
3
4

{
  "asset_url": "https://cdn.example.com/assets/cat.jpg",
  "name": "Cat Graphic"
}

asset_fileのリクエスト本文の例：

1
2
3
4

{
  "asset_file": <BINARY FILE DATA>,
  "name": "Cat Graphic"
}

リクエスト本文には以下のパラメーターが含まれます。

アップロードされたファイル名

このセクションでは、nameパラメーターを含めるかどうかに基づいて、エンドポイントがアップロードされたファイルに名前を割り当てる方法について説明します。

単一ファイルのアップロード

ZIPファイルのアップロード

リクエスト例

このセクションには2つのcurlリクエスト例が含まれています。1つはURLを使用してアセットを追加する例、もう1つはバイナリファイルデータを使用する例です。

このリクエストは、asset_urlを使用してメディアライブラリにアセットを追加する例を示しています。

1
2
3
4

curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_url": "https://cdn.example.com/assets/cat.jpg", "name": "Cat Graphic"}'

このリクエストは、asset_fileを使用してメディアライブラリにアセットを追加する例を示しています。

1
2
3
4

curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_file":<BINARY FILE DATA>, "name":"Cat Graphic"}'

エラー応答

このセクションでは、発生する可能性のあるエラーとその対応するメッセージおよび説明を一覧にしています。

バリデーションエラー

バリデーションエラーは次のような構造を返します。

1
2
3

{
  "message": (String) Human-readable error description
}

以下の表は、発生する可能性のあるバリデーションエラーの一覧です。

処理エラー

処理エラーはエラーコード付きの異なる応答を返します。

1
2
3
4
5

{
  "message": (String) Human-readable error description,
  "error_code": (String) error code,
  "meta": { }
}

以下の表は、発生する可能性のある処理エラーの一覧です。

応答

このエンドポイントには5つのステータスコード応答があります：200、400、403、429、および500。

以下のJSONは、応答の想定される形式を示しています。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
    "new_assets": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "url": (String) the URL to access the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif")
        }
    ],
    "errors": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif"),
            "error": (String) the error that occurred
        }
    ],
    "dashboard_url": (String) the URL to view this asset in the Braze dashboard
}
New Stuff!