Channel Developers

thumbnail

List of Campaign Users

Campaign Userオブジェクトのリストを取得できます。

URL https://api.channel.io/open/v5/mkt/campaigns/{id}/campaign-usersおよびHTTP GET経由でアクセス可能

パラメータ

要件

説明

タイプ

id

1234

必須

CampaignオブジェクトのID

Path

state

sent

必須

取得するCampaign Userオブジェクトの種類。

- 利用可能な値 : sent, view, goal, click

Query

since

eyJjaGF0S2V5IjoiZ3Jvn0=

任意

取得する最初のCampaign Userのエンコード済みキー。JSONレスポンスのルートオブジェクトに含まれるnext値によるページネーションをサポート。

Query

limit

25

任意

取得するCampaign Userオブジェクトの最大数を制限します。

- 最小値:1

- 最大値:500

- デフォルト値:25

Query

sortOrder

desc

任意

ソート順 - 利用可能な値 : asc, desc, both

- デフォルト値 : desc

Query

GET https://api.channel.io/open/v5/mkt/campaigns/1234/campaign-users?state=click&since=eyJjaGF0S2V5IjoiZ3Jvn0=&limit=25&sortOrder=desc

Campaign Userオブジェクトのリストを返します。

JSON

Campaign Userは統合プロセスの対象となります。つまり、後でログインしたCampaign Userのデータは統合されます。

1年以上前に更新されたCampaign Userオブジェクトは取得されません。