ニュースフィードカードのエクスポート一覧
get
/feed/list
このエンドポイントを使用して、ニュースフィードカードの一覧をエクスポートします。それぞれの一覧には、名前とカード API 識別子が含まれます。
カードs は、作成時刻(デフォルトで最も古いものから最新のもの) でソートされた100 の集合で返されます。
note:
ニュースフィードは非推奨になります。Braze では、News Feed ツールを使用するお客様は、コンテンツカードメッセージングチャネルに移動することを推奨しています。これは、より柔軟でカスタマイズ可能で、信頼性が高いチャネルです。詳しくはマイグレーションガイドをご覧ください。
前提条件
このエンドポイントを使用するには、API キーとfeed.list
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
page |
オプション | 整数 | 返されるカードのページ。デフォルトは0です (最大100の最初のセットを返す)。 |
include_archived |
オプション | ブール値 | アーカイブされたカードを含めるかどうか、デフォルトは false です。 |
sort_direction |
オプション | 文字列 | - 作成時刻を新しいものから古いものへと並べ替える: 値 desc を渡します。- 作成時刻を古いものから新しいものへと並べ替える: 値 asc を渡します。sort_direction が含まれていない場合、デフォルトの順序は古いものから新しいものとなる。 |
例のリクエスト
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/feed/list?page=1&include_archived=true&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"cards" : [
{
"id" : (string) the card API identifier,
"type" : (string) type of the card - NewsItem (classic cards), CaptionedImage, Banner
"title" : (string) the title of the card,
"tags" : (array) the tag names associated with the card
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!