YouTube 실시간 채팅 메시지의 상태를 전환하고 새 상태와 연결된 프로세스를 시작합니다. 예를 들어 실시간 투표의 상태를 closed로 전환하면 YouTube에서 해당 메시지의 투표를 종료합니다. 이 메서드를 호출하기 전에 실시간 투표 메시지의 status 속성 값이 active인지 확인해야 합니다.
할당량 영향: 이 메서드를 호출하면 할당량 비용이 20단위입니다.
요청
HTTP 요청
POST https://www.googleapis.com/youtube/v3/liveChat/messages/transition
승인
이 요청에는 다음 범위 중 최소 하나를 사용하여 인증이 필요합니다. (인증 및 승인에 대해 자세히 알아보기)
| 범위 |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
매개변수
다음 표에는 이 쿼리에서 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.
| 매개변수 | ||
|---|---|---|
| 필수 매개변수 | ||
id |
stringid 매개변수는 다른 상태로 전환되는 메시지의 고유 ID를 지정합니다. |
|
status |
enumstatus 매개변수는 메시지가 변경되는 상태를 식별합니다. 메시지를 closed 상태로 전환하려면 메시지가 바인딩된 투표의 status가 active여야 합니다.
closed로만 전환할 수 있습니다. 즉, 투표가 종료됩니다.
|
|
| 선택적 매개변수 | ||
part |
stringpart 매개변수는 API 응답에 포함할 liveChatMessage 리소스 부분을 지정합니다. 지원되는 값은 id, snippet, authorDetails입니다.
응답 본문에서 최종 투표 결과를 가져오려면 파라미터 값을 snippet으로 설정합니다.
|
|
요청 본문
이 메소드를 호출할 때 요청 본문을 제공하지 마세요.
응답
요청에 성공할 경우 이 메서드는 응답 본문에 liveChatMessages 리소스를 반환합니다.
오류
다음 표에서는 이 메서드 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 보여줍니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.
| 오류 유형 | 오류 세부정보 | 설명 |
|---|---|---|
forbidden (403) |
forbidden |
지정된 메시지의 상태를 전환하는 데 필요한 권한이 없습니다. |
required (400) |
idRequired |
필수 id 매개변수는 상태를 전환하려는 메시지를 식별해야 합니다. |
required (400) |
statusRequired |
API 요청은 status 매개변수의 값을 지정해야 합니다. |
notFound (404) |
liveChatMessagesNotFound |
id 매개변수로 지정된 메시지가 없습니다. |
forbidden (403) |
modificationNotAllowed |
지정된 liveChatMessage 리소스의 상태를 전환할 수 없습니다. id 매개변수는 상태를 전환할 수 없는 메시지를 식별할 수 있습니다. |
기능을 사용해 보세요.
APIs Explorer을 사용하여 이 API를 호출하고 API 요청 및 응답을 확인합니다.