Skip to content

キャンペーンリストをエクスポートする

get

/campaigns/list

このエンドポイントを使用して、それぞれに名前、キャンペーン API 識別子、それが API キャンペーンであるかどうか、キャンペーンに関連付けられたタグが含まれたキャンペーンのリストをエクスポートします。

キャンペーンは、作成された時間（デフォルトでは古いものから新しいもの）順にソートされた100のグループで返される。

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

パラメーター required データ型 説明
page オプション 整数 返すキャンペーンのページ、デフォルトは0（最大100の最初のセットを返す）。
include_archived オプション ブール値 アーカイブされたキャンペーンを含めるかどうか。デフォルトはfalse。
sort_direction オプション string - 作成時刻を新しいものから古いものへとソートする: 値 desc を渡す。
- 作成時刻を古いものから新しいものへとソートする: 値 asc を渡す。

sort_direction が含まれていない場合、デフォルトの順序は古いものから新しいものとなる。
last_edit.time[gt] オプション 時刻 結果をフィルタリングし、現在までに指定された時間以上編集されたキャンペーンのみを返す。形式は yyyy-MM-DDTHH:mm:ss です。

リクエスト例

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/campaigns/list?page=0&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "campaigns" : [
        {
            "id" : (string) the Campaign API identifier,
            "last_edited": (ISO 8601 string) the last edited time for the message 
            "name" : (string) the campaign name,
            "is_api_campaign" : (boolean) whether the campaign is an API campaign,
            "tags" : (array) the tag names associated with the campaign formatted as strings
        },
        ...
    ]
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!