API 식별자 유형

이 참조 가이드에서는 Braze 대시보드에서 찾을 수 있는 다양한 유형의 API 식별자, 용도, 찾을 수 있는 위치, 일반적으로 사용되는 방식에 대해 설명합니다. REST API 키 또는 워크스페이스 API 키에 대한 자세한 내용은 API 개요를 참조하세요.

다음 식별자를 사용하여 Braze 외부 API에서 템플릿, 캔버스, 캠페인, 세그먼트, 전송 또는 카드에 액세스할 수 있습니다. 모든 메시지는 UTF-8 인코딩을 따라야 합니다.

앱 식별자

앱 식별자 또는 app_id는 활동을 워크스페이스의 특정 앱과 연결하는 매개변수입니다. 워크스페이스 내에서 상호 작용하고 있는 앱을 지정합니다. 예를 들어 iOS 앱용 app_id, Android 앱용 app_id, 웹 통합용 app_id가 있습니다. Braze에서 지원하는 다양한 플랫폼 유형에 걸쳐 동일한 플랫폼용 앱이 여러 개 있을 수 있습니다.

어디서 찾을 수 있나요?

다음 두 가지 방법으로 app_id를 찾을 수 있습니다.

• 앱 식별자
• 앱 설정

어떤 용도로 사용할 수 있나요?

Braze의 앱 식별자는 SDK를 통합할 때 사용되며 REST API 호출에서 특정 앱을 참조하는 데에도 사용됩니다. app_id를 사용하면 특정 앱에서 발생한 커스텀 이벤트에 대한 데이터 가져오기, 특정 앱의 제거 통계, 신규 사용자 통계, DAU 통계 및 세션 시작 통계 검색 등 다양한 작업을 수행할 수 있습니다.

여러 앱 식별자

SDK를 설정하는 동안 여러 앱 식별자를 사용하는 가장 일반적인 사용 사례는 디버그 및 릴리스 빌드 배리언트에 대한 식별자를 구분하는 것입니다.

빌드에서 여러 앱 식별자 사이를 쉽게 전환하려면 각 관련 빌드 배리언트에 대해 별도의 braze.xml 파일을 만드는 것이 좋습니다. 빌드 배리언트는 빌드 유형과 제품 버전의 조합입니다. 기본적으로 새 Android 프로젝트는 debug 및 release 빌드 유형으로 구성되며 제품 플레이버는 없습니다.

각 관련 빌드 배리언트에 대해 src/<build variant name>/res/values/에서 새 braze.xml을 생성하세요.

1
2
3
4
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="com_braze_api_key">{YOUR_BUILD_VARIANT_API_KEY}</string>
</resources>

빌드 변형이 컴파일되면 새 식별자를 사용합니다.

템플릿 식별자

템플릿 식별자 또는 템플릿 ID는 대시보드 내에서 특정 템플릿에 대해 Braze가 생성한 임의의 키입니다. 템플릿 ID는 각 템플릿마다 고유하며 API를 통해 템플릿을 참조하는 데 사용할 수 있습니다.

템플릿은 회사에서 캠페인용 HTML 디자인을 계약하는 경우에 유용합니다. 템플릿이 만들어지면 이제 특정 캠페인에 국한되지 않고 뉴스레터와 같은 일련의 캠페인에 적용할 수 있는 템플릿을 갖게 됩니다.

어디서 찾을 수 있나요?

템플릿 ID는 다음 두 가지 방법 중 하나로 찾을 수 있습니다:

• 템플릿
• api 키

어떤 용도로 사용할 수 있나요?

• API를 통한 템플릿 업데이트
• 특정 템플릿에 대한 정보 얻기

캔버스 식별자

캔버스 식별자 또는 캔버스 ID는 대시보드 내의 특정 캔버스에 대해 Braze에서 생성한 임의의 키입니다. 캔버스 ID는 각 캔버스마다 고유하며 API를 통해 캔버스를 참조하는 데 사용할 수 있습니다.

변형 캔버스가 있는 캔버스의 경우 전체 캔버스 ID와 기본 캔버스 아래에 중첩된 개별 변형 캔버스 ID가 있다는 점에 유의하세요.

어디서 찾을 수 있나요?

대시보드에서 Canvas ID를 찾을 수 있습니다. 메시징 > 캔버스로 이동하여 기존 캔버스를 선택합니다. 원하는 캔버스가 아직 존재하지 않으면 캔버스를 만들어 저장하세요. 개별 캔버스 페이지 하단에서 배리언트 분석을 클릭합니다. 하단에 캔버스 API 식별자가 있는 창이 나타납니다.

어떤 용도로 사용할 수 있나요?

• 특정 메시지에 대한 분석 추적
• Canvas 성능에 대한 높은 수준의 집계 통계 보기
• 특정 캔버스에 대한 세부 정보 가져오기
• 캔버스에 대한 ‘빅 픽쳐’ 접근 방식을 위해 사용자 수준의 데이터를 가져오기 위해 Currents 사용
• 트랜잭션 메시지에 대한 통계를 수집하기 위해 API 트리거 전달 사용

캠페인 식별자

캠페인 식별자 또는 캠페인 ID는 대시보드 내에서 특정 캠페인에 대해 Braze가 생성한 임의의 키입니다. 캠페인 ID는 각 캠페인마다 고유하며 API를 통해 캠페인을 참조하는 데 사용할 수 있습니다.

변형이 있는 캠페인이 있는 경우 전체 캠페인 ID와 기본 캠페인 아래에 중첩된 개별 변형 캠페인 ID가 모두 있다는 점에 유의하세요.

어디서 찾을 수 있나요?

캠페인 ID는 다음 두 가지 방법 중 하나로 찾을 수 있습니다:

• 캠페인
• api 키

어떤 용도로 사용할 수 있나요?

• 특정 메시지에 대한 분석 추적
• 캠페인 성과에 대한 높은 수준의 집계 통계를 확인하세요.
• 특정 캠페인에 대한 세부 정보 보기
• 캠페인에 대한 ‘빅 픽쳐’ 접근 방식을 위해 사용자 수준의 데이터를 가져오기 위해 Currents 사용
• 트랜잭션 메시지에 대한 통계를 수집하기 위해 API 트리거 전송을 사용합니다.
• api_id:YOUR_API_ID 필터를 사용하여 캠페인 페이지에서 특정 캠페인을 검색

세그먼트 식별자

세그먼트 식별자 또는 세그먼트 ID는 대시보드 내의 특정 세그먼트에 대해 Braze에서 생성한 임의의 키입니다. 세그먼트 ID는 각 세그먼트마다 고유하며 API를 통해 세그먼트를 참조하는 데 사용할 수 있습니다.

어디서 찾을 수 있나요?

세그먼트 ID는 다음 두 가지 방법 중 하나로 찾을 수 있습니다:

• 세그먼트
• api 키

어떤 용도로 사용할 수 있나요?

• 특정 세그먼트에 대한 세부 정보 보기
• 특정 세그먼트에 대한 분석 검색
• 특정 세그먼트에 대해 사용자 지정 이벤트가 기록된 횟수 가져오기
• API 내에서 세그먼트의 멤버에게 캠페인을 지정하고 전송합니다.

카드 식별자

카드 식별자 또는 카드 ID는 대시보드 내의 특정 뉴스피드 카드에 대해 Braze에서 생성한 임의 키입니다. 카드 ID는 각 뉴스피드 카드마다 고유하며 API를 통해 카드를 참조하는 데 사용할 수 있습니다.

어디서 찾을 수 있나요?

카드 ID는 두 가지 방법 중 하나로 찾을 수 있습니다:

• 뉴스 피드
• api 키

어떤 용도로 사용할 수 있나요?

• 카드에서 관련 정보 검색
• 콘텐츠 카드 및 참여와 관련된 이벤트 추적

발신 식별자

전송 식별자 또는 전송 ID는 분석을 추적해야 하는 특정 메시지 전송에 대해 Braze에서 생성하거나 사용자가 생성한 키입니다. 전송 식별자를 사용하면 /sends/data_series 엔드포인트를 통해 캠페인 전송의 특정 인스턴스에 대한 분석을 다시 가져올 수 있습니다.

어디서 찾을 수 있나요?

브로드캐스트로 전송되는 API 및 API 트리거 캠페인은 전송 식별자가 제공되지 않은 경우 자동으로 전송 식별자를 생성합니다. 고유한 전송 식별자를 지정하려면 먼저 /sends/id/create 엔드포인트를 통해 식별자를 생성해야 합니다. 식별자는 모두 ASCII 문자여야 하며 최대 64자여야 합니다. 동일한 캠페인의 여러 전송에 대한 분석을 그룹화하려는 경우 전송 식별자를 여러 전송에 재사용할 수 있습니다.

어떤 용도로 사용할 수 있나요?

메시지를 전송할 때마다 캠페인을 만들지 않고 프로그래밍 방식으로 메시지 성과를 전송하고 추적할 수 있습니다.

구독 그룹 식별자

구독 그룹 식별자(구독 그룹 ID)는 특정 구독 그룹에 대해 Braze에서 생성한 키입니다. ID는 각 구독 그룹에 고유하며 API를 통해 구독 그룹을 참조하는 데 사용할 수 있습니다.

어디서 찾을 수 있나요?

대상 > 구독으로 이동하여 각 구독 그룹 옆에 있는 ID를 복사합니다.

어떤 용도로 사용할 수 있나요?

• 사용자의 구독 그룹 나열
• 사용자의 구독 그룹 상태 파악하기
• 사용자의 구독 그룹 상태 업데이트