Skip to content

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

post

/media_library/create

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

前提条件

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

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

Request body

を含めると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
}
Github   GitHub でこのページを編集
New Stuff!