캠페인 세부 정보 내보내기
get
/campaigns/details
이 엔드포인트를 사용하여 지정된 캠페인에 대한 관련 정보를 검색할 수 있으며, 이 정보는
campaign_id에서 확인할 수 있습니다.
캔버스 데이터를 검색하려면 캔버스 세부 정보 내보내기 엔드포인트를 참조하세요.
Prerequisites
이 엔드포인트를 사용하려면 campaigns.details 권한이 있는 API 키가 필요합니다.
사용량 제한
이 엔드포인트에는 API 속도 제한 설명서에 명시된 대로 기본값 Braze 속도 제한인 시간당 250,000개의 요청이 적용됩니다.
요청 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
campaign_id |
Required | 문자열 | 캠페인 API 식별자를 참조하세요. API 캠페인용 campaign_id 은 대시보드 내의 API 키 페이지와 캠페인 세부정보 페이지에서 찾을 수 있으며, 캠페인 목록 내보내기 엔드포인트를 사용할 수도 있습니다. |
post_launch_draft_version |
선택 사항 | 부울 | 출시 후 초안이 있는 메시지의 경우 이 값을 true 으로 설정하면 사용 가능한 모든 초안 변경 사항이 표시됩니다. 기본값은 다음과 같습니다. false |
요청 예시
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/campaigns/details?campaign_id={{campaign_identifier}}' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
응답
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"created_at" : (string) the date created as ISO 8601 date,
"updated_at" : (string) the date last updated as ISO 8601 date,
"archived": (boolean) whether this campaign is archived,
"draft": (boolean) whether this campaign is a draft,
"enabled": (boolean) whether this campaign is active or not,
"has_post_launch_draft": (boolean) whether this campaign has a post-launch draft,
"name" : (string) the campaign name,
"description" : (string) the campaign description,
"schedule_type" : (string) the type of scheduling action,
"channels" : (array) the list of channels to send via,
"first_sent" : (string) the date and hour of first sent as ISO 8601 date,
"last_sent" : (string) the date and hour of last sent as ISO 8601 date,
"tags" : (array) the tag names associated with the campaign,
"teams" : (array) the names of the Teams associated with the campaign,
"messages": {
"message_variation_id": (string) { // <=This is the actual id
"channel": (string) the channel type of the message, must be either email, ios_push, webhook, content_cards, trigger_in_app_message, or sms,
"name": (string) the name of the message in the dashboard (eg., "Variation 1")
... channel-specific fields for this message, see the following messages section ...
}
},
"conversion_behaviors": (array) the conversion event behaviors assigned to the campaign, see the following conversions behavior section.
}
채널별 메시지
messages 응답에는 각 메시지에 대한 정보가 포함됩니다. 다음은 각 채널에 대한 메시지 응답 예시입니다:
1
2
3
4
5
{
"channel": "content_cards",
"name": (string) the name of variant,
"extras": (hash) any key-value pairs provided; only present if at least one key-value pair has been set
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"channel": "email",
"name": (string) the name of the variant,
"extras": (array) the email extras,
"subject": (string) the subject,
"body": (string) the HTML body,
"from": (string) the from address and display name,
"reply_to": (string) the reply-to for message, if different than "from" address,
"title": (string) the name of the email,
"amp_body": (string) the AMP HTML body,
"preheader": (string) the preheader,
"custom_plain_text": (string) the custom plain text,
"should_inline_css": (boolean) whether there should be inline CSS,
"should_whitespace_header": (boolean) whether there should be a whitespace header,
"email_headers": (array) list of email headers
}
1
2
3
4
5
6
7
8
9
10
{
"channel": (string) the description of the channel, such as "ios_push" or "android_push",
"name": (string) the name of the variant,
"alert": (string) the alert body text,
"extras": (hash) any key-value pairs provided,
"title": (string) the alert title text,
"action": (string) action link from click,
"image_url": (string) the image URL for an Android notification image, an iOS notification image, or a Web push icon image,
"large_image_url": (string) the web notification image URL for Android Chrome and Windows web push actions; null in other cases
}
1
2
3
4
5
6
{
"channel": "sms",
"body": (string) the payload body,
"from": (string) the list of numbers associated with the subscription group,
"subscription_group_id": (string) the API id of the subscription group targeted in the SMS message
}
1
2
3
4
5
6
7
8
{
"channel": "webhook",
"url": (string) the URL for webhook,
"body": (string) the payload body,
"type": (string) the body content type,
"headers": (hash) the specified request headers,
"method": (string) the HTTP method, either POST or GET
}
템플릿 메시지
1
2
3
4
5
6
7
8
9
10
{
"channel": "whats_app",
"subscription_group_id": (string) the API ID of the subscription group selected in the WhatsApp message
"from": (array) the list of strings of the numbers associated with the subscription group,
"template_name": (string) the name of the WhatsApp template being sent,
"template_language_code": (string) the language code of the WhatsApp template being sent,
"header_variables": (array) the list of strings, if present, of Liquid variables being inserted into header of WhatsApp template being sent,
"body_variables": (array) the list of strings, if present, of Liquid variables being inserted into body of WhatsApp template being sent,
"button_variables": (array) the list of strings, if present, of Liquid variables being inserted into buttons of WhatsApp template being sent
}
응답 메시지
1
2
3
4
5
6
7
8
9
10
{
"channel": "whats_app",
"subscription_group_id": (string) the API ID of the subscription group selected in the WhatsApp message,
"from": (array) list of strings of the numbers associated with the subscription group,
"layout": (string) the name of the WhatsApp template being sent (text or media or quick-reply),
"header_text": (string, optional) the text, if present, of the header of the message being sent,
"body_text": (string, optional) the text, if present, of the body of the message being sent,
"footer_text": (string, optional) the text, if present, of the footer of the message being sent,
"buttons": (array) list of button objects in the message being sent ({"text": (string) the text of the button})
}
전환 행동
conversion_behaviors 배열은 캠페인에 설정된 각 전환 이벤트 행동에 대한 정보를 포함합니다. 이러한 행동은 캠페인에서 설정한 순서대로 진행됩니다. 예를 들어, 전환 이벤트 A는 배열의 첫 번째 항목이고, 전환 이벤트 B는 두 번째 항목이며, 계속해서 그렇습니다. 다음은 전환 이벤트 동작 응답의 예시입니다:
1
2
3
4
{
"type": "Clicks Email",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours
}
1
2
3
4
{
"type": "Opens Email",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours
}
1
2
3
4
{
"type": "Makes Any Purchase",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours
}
1
2
3
4
5
{
"type": "Makes Specific Purchase",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours,
"product": (string) the name of the product, such as "Feline Body Armor"
}
1
2
3
4
5
{
"type": "Performs Custom Event",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours,
"custom_event_name": (string) the name of the event, such as "Used Feline Body Armor"
}
1
2
3
4
5
{
"type": "Upgrades App",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours,
"app_ids": (array or null) array of app ids, such as ["12345", "67890"], or `null` if "Track sessions for any app" is selected in the UI
}
1
2
3
4
5
{
"type": "Starts Session",
"window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours,
"app_ids": (array or null) array of app ids, such as ["12345", "67890"], or `null` if "Track sessions for any app" is selected in the UI
}
tip:
CSV 및 API 내보내기 문제 해결에 대한 도움은 내보내기 문제 해결를 방문하세요.
GitHub 에서 이 페이지를 편집합니다.
New Stuff!