superChatEvent
리소스는 YouTube 실시간 스트림 중에 팬이 구매한 Super Chat 메시지를 나타냅니다. YouTube 실시간 채팅 스트림에서 Super Chat은 다음과 같은 두 가지 면에서 다른 메시지와 차별화됩니다.
- Super Chat은 색상으로 강조표시됩니다.
- Super Chat은 일정 시간 동안 티커에 고정됩니다.
Super Chat의 색상, 티커에 고정되는 시간, 최대 메시지 길이는 모두 구매 금액에 따라 결정됩니다. Super Chat에 대한 자세한 내용은 YouTube 고객센터를 참조하세요.
방법
API는 superChatEvents
리소스에 다음 메서드를 지원합니다.
리소스 표현
다음 JSON 구조는 superChatEvent
리소스의 형식을 보여줍니다.
{ "kind": "youtube#superChatEvent", "etag": etag, "id": string, "snippet": { "channelId": string, "supporterDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "commentText": string, "createdAt": datetime, "amountMicros": unsigned long, "currency": string, "displayString": string, "messageType": unsigned integer, "isSuperStickerEvent": boolean, "superStickerMetadata": { "stickerId": string, "altText": string, "language": string } } }
속성
다음 표는 이 리소스에 표시되는 속성을 정의합니다.
속성 | |
---|---|
kind |
string API 리소스의 유형을 식별합니다. 값은 youtube#superChatEvent 입니다. |
etag |
etag 이 리소스의 Etag입니다. |
id |
string YouTube가 Super Chat 이벤트를 고유하게 식별하기 위해 할당하는 ID입니다. |
snippet |
object snippet 객체에는 Super Chat 이벤트에 대한 기본 세부정보가 포함됩니다. |
snippet.channelId |
string Super Chat 이벤트와 관련된 실시간 스트림을 방송하는 채널을 식별하는 YouTube 채널 ID입니다. |
snippet.supporterDetails |
object 후원자의 채널에 대한 세부정보입니다. |
snippet.supporterDetails.channelId |
string 후원자의 YouTube 채널 ID입니다. |
snippet.supporterDetails.channelUrl |
string 후원자의 채널 URL입니다. |
snippet.supporterDetails.displayName |
string 후원자 채널의 표시 이름입니다. |
snippet.supporterDetails.profileImageUrl |
string 후원자 채널의 아바타 URL입니다. |
snippet.commentText |
string 후원자의 댓글 텍스트 콘텐츠입니다. |
snippet.createdAt |
datetime Super Chat을 구매한 날짜와 시간입니다. 값은 ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) 형식으로 지정됩니다. |
snippet.amountMicros |
unsigned long 구매 금액(마이크로 단위)입니다. 예를 들어 구매 금액이 1달러인 경우 snippet.amountMicros 속성 값은 1000000 입니다. |
snippet.currency |
string 구매에 사용된 통화입니다. 값은 ISO 4217 통화 코드입니다. |
snippet.displayString |
string 구매 금액과 통화를 표시하는 문자열(예: $1.00 )입니다. 표시 문자열은 hl 요청 매개변수에서 지정한 언어의 규칙에 따라 형식이 지정됩니다. 기본적으로 표시 문자열은 영어와 같은 형식으로 지정됩니다. 예를 들어 기본적으로 문자열은 $1,00 가 아닌 $1.00 형식으로 지정됩니다. |
snippet.messageType |
unsigned integer 유료 메시지의 등급입니다. liveChatMessage 리소스가 Super Chat 메시지를 식별하는 경우 snippet.superChatDetails.tier 속성에 이 값이 포함됩니다.등급은 메시지 구매에 지출한 금액을 기준으로 합니다. 실시간 채팅 UI에서 메시지를 강조표시하는 데 사용되는 색상, 최대 메시지 길이, 메시지가 티커에 고정되는 시간도 결정합니다. Super Chat 등급은 YouTube 고객센터에 설명되어 있습니다. Super Chat 구매 세부정보를 펼칠 수 있는 섹션을 참조하세요. 이 목록에서 구매 금액이 가장 낮은 계층은 계층 1이고 다음으로 낮은 금액은 계층 2입니다. |
snippet.isSuperStickerEvent |
boolean 리소스가 관련 이미지가 있는 특정 유형의 Super Chat 메시지인 Super Sticker인지 여부를 나타냅니다. 이 필드의 값이 true 이면 superStickerMetadata 필드에 이미지를 표시하는 데 사용할 수 있는 정보가 포함됩니다. |
snippet.superStickerMetadata |
object Super Sticker 세부정보입니다. 이 객체는 snippet.isSuperStickerEvent 필드의 값이 true 인 경우에만 반환됩니다. |
snippet.superStickerMetadata.stickerId |
string 스티커 이미지를 식별하는 고유 ID입니다. 이미지는 사용자가 YouTube에서 채팅 창을 볼 때만 Super Sticker 메시지의 일부로 표시됩니다. 하지만 API를 통해서는 이미지 URL을 사용할 수 없습니다. 참고로 이 CSV 파일에서 어떤 스티커 ID와 어떤 Super Sticker와 연결되어 있는지 확인할 수 있습니다. |
snippet.superStickerMetadata.altText |
string 스티커를 설명하는 텍스트 문자열입니다. snippet.superStickerMetadata.language 필드는 텍스트의 언어를 나타냅니다. superChatEvents.list 메서드를 호출할 때 hl 매개변수 값을 원하는 텍스트 언어로 설정합니다. |
snippet.superStickerMetadata.language |
string snippet.superStickerMetadata.altText 속성 값의 언어입니다. Super Sticker에 텍스트도 표시되는 경우 텍스트도 이 언어로 된 것입니다. |