SuperChatEvents: list

지난 30일 동안 채널의 라이브 스트림에서 발생한 Super Chat 이벤트를 표시합니다.

일반적인 사용 사례

요청

HTTP 요청

GET https://www.googleapis.com/youtube/v3/superChatEvents

승인

이 요청에는 다음 범위 중 하나 이상에 대한 승인이 필요합니다. 인증 및 승인에 대해 자세히 알아보려면 OAuth 2.0 인증 구현을 참고하세요.

범위
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

매개변수

다음 표에는 이 쿼리가 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.

매개변수
필수 매개변수
part string
part 매개변수는 API 응답에 포함할 superChatEvent 리소스 부분을 지정합니다. 지원되는 값은 id 및 snippet입니다.
선택적 매개변수
hl string
hl 매개변수는 API 서버에 Super Chat의 구매 금액과 통화를 보여주는 snippet.displayString 속성 값의 형식을 특정 언어의 규칙에 따라 지정하라고 지시합니다. 매개변수 값은 i18nLanguages.list 메서드에서 반환된 목록에 포함된 언어 코드여야 합니다. 기본값은 en입니다. 즉, 기본 동작은 표시 문자열을 영어로 사용할 때와 동일하게 형식을 지정하는 것입니다. 예를 들어 기본적으로 문자열은 $1,00이 아닌 $1.00 형식으로 지정됩니다.
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환해야 하는 최대 항목 수를 지정합니다. 허용되는 값은 1~50입니다. 기본값은 5입니다.
pageToken string
pageToken 매개변수는 반환되어야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 및 prevPageToken 속성은 가져올 수 있는 다른 페이지를 식별합니다.

요청 본문

이 메소드를 호출할 때 요청 본문을 제공하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

속성

다음 표는 이 리소스에 표시되는 속성을 정의합니다.

속성
kind string
API 리소스의 유형을 식별합니다. 값은 youtube#superChatEventListResponse입니다.
etag etag
이 리소스의 Etag입니다.
nextPageToken string
결과 집합의 다음 페이지를 검색하기 위해 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
pageInfo object
pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.
pageInfo.totalResults integer
결과 집합의 총 결과 수입니다.
pageInfo.resultsPerPage integer
API 응답에 포함된 결과 수입니다.
items[] list
요청 기준과 일치하는 Super Chat 구매 목록입니다.

오류

다음 표에는 이 메서드 호출에 대한 응답으로 API에서 반환할 수 있는 오류 메시지가 나와 있습니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.

오류 유형 오류 세부정보 설명
forbidden (403) insufficientPermissions 요청이 Super Chat 이벤트를 검색하도록 적절하게 승인되지 않았습니다.

사용해 보기

APIs Explorer를 사용하여 이 API를 호출하고 API 요청 및 응답을 확인합니다.