Skip to content

API 캠페인

이 참조 문서에서는 API 호출에 포함할 campaign_id를 생성하는 방법과 해당 캠페인을 구성하는 방법에 대해 설명합니다.

API 캠페인은 일반적으로 트랜잭션 메시징에 사용됩니다. API 캠페인(API 트리거 캠페인이 아닌)을 생성할 때, Braze 대시보드는 캠페인 보고를 위한 분석을 추적할 수 있는 campaign_id를 생성하는 데만 사용됩니다. 캠페인의 각 배리언트마다 다른 메시지 배리언트 ID를 생성할 수도 있습니다.

그런 다음 해당 정보를 개발팀에 전달하여 API 요청에 사용할 수 있도록 합니다. 전달할 정보는 다음과 같습니다.

  • 캠페인 카피
  • 오디언스 멤버십
  • 자산

캠페인이 시작되면 대시보드에서 결과를 확인할 수 있습니다. API 캠페인은 대시보드를 통해 완전히 생성된 캠페인과 동일한 세부 보고 및 리타겟팅 옵션이 있는 Braze 메시징 API를 사용합니다.

새 캠페인 만들기

메시징 > Campaigns로 이동하여 캠페인 만들기를 선택한 다음 API Campaigns를 선택합니다. 이제 API 캠페인 구성을 진행할 수 있습니다.

API 트리거 캠페인은 API 캠페인과 다릅니다.

캠페인 구성하기

캠페인을 구성하려면 다음 단계를 수행합니다:

  1. 메시지를 보낸 후 Campaigns 페이지에서 결과를 찾을 수 있도록 설명이 포함된 제목을 추가합니다.
  2. 메시지 추가를 선택하고 API 캠페인에 포함할 메시지 유형을 추가합니다. 이렇게 하면 campaign_id와 메시지 배리언트 ID가 생성되며, 포함하는 각 채널마다 다른 값이 부여됩니다.
  3. 선택 사항으로, 특정 액션이나 캠페인 목표에 대한 사용자 전환을 추적하기 위해 전환 이벤트를 추가할 수 있습니다.
  4. 캠페인 저장을 선택하면 API 캠페인이 시작됩니다.

API 호출

API 캠페인을 저장한 후 API 요청에 다음을 포함합니다:

  • 메시지 전송 엔드포인트에 명시된 대로 생성된 campaign_id 필드를 API 요청에 포함합니다.
  • 캠페인에 포함된 각 플랫폼에 대한 메시지 오브젝트를 포함합니다. 메시지 오브젝트에서 메시지 배리언트 ID를 제공합니다. 이렇게 하면 해당 배리언트 아래에 통계가 수집되고 표시됩니다. 지원되는 메시지 오브젝트는 Android, Content Cards, 이메일, iOS, Kindle, SMS/MMS, 웹 푸시, 웹훅입니다.

API 캠페인에 원클릭 목록 수신 거부 추가

기본적으로 Braze는 API 캠페인에 원클릭 목록 수신 거부 헤더를 추가하지 않습니다. API 요청의 이메일 헤더 필드에 {{${set_user_to_one_click_list_unsubscribe}}} Liquid 태그를 포함하면 개별 API 캠페인 발송에 이 헤더를 추가할 수 있습니다.

원클릭 목록 수신 거부에 대한 RFC 8058을 준수하려면 API 요청에 List-Unsubscribe 및 List-Unsubscribe-Post 헤더를 모두 포함하세요:

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

{
  "external_user_ids": ["user_id"],
  "messages": {
    "email": {
      "app_id": "your_app_id",
      "subject": "Your Subject",
      "from": "Sender Name <[email protected]>",
      "body": "<p>Email body content</p>",
      "headers": {
        "List-Unsubscribe": "<{{${set_user_to_one_click_list_unsubscribe}}}>",
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
      }
    }
  }
}

이메일 첨부 파일 추가

API 캠페인 이메일에 첨부 파일을 추가하려면 이메일 오브젝트에 attachments 배열을 포함합니다. 드래그 앤 드롭 또는 HTML 편집기에서 생성한 이메일 템플릿을 참조하려면 이메일 오브젝트에 email_template_id를 제공한 다음 API 호출을 통해 첨부 파일을 추가할 수 있습니다.

첨부 파일 세부 정보, 크기 제한 및 모범 사례에 대해서는 첨부 파일이 포함된 이메일 오브젝트 예시를 참조하세요.
New Stuff!