LiveBroadcasts: cuepoint

실시간 방송에 큐포인트를 삽입합니다. 이 시점은 광고 시점을 트리거할 수 있습니다.

참고: 이 메서드는 YouTube 콘텐츠 소유자와 연결된 계정에서 요청을 승인해야 하는 liveCuepoints.insert 메서드를 대체합니다. 이 메서드에는 동일한 승인 요구사항이 없습니다.

요청

HTTP 요청

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

승인

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

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

매개변수

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

매개변수
필수 매개변수
id string
id 매개변수는 큐포인트가 삽입되는 브로드캐스트를 식별합니다. 큐포인트를 삽입할 때 방송이 활발하게 스트리밍 중이어야 합니다.
선택적 매개변수
onBehalfOfContentOwner string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다.
참고: 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너만 사용할 수 있습니다. 이를 통해 콘텐츠 소유자는 한 번 인증하고 매개변수 값에 지정된 채널을 대신하여 작업을 실행할 수 있으며, 개별 채널마다 다른 인증 사용자 인증 정보를 제공할 필요가 없습니다. 사용자가 인증하는 계정이 지정된 YouTube 콘텐츠 소유자와 연결되어 있어야 합니다.
onBehalfOfContentOwner 매개변수는 요청의 승인 사용자 인증 정보가 매개변수 값에 지정된 YouTube 콘텐츠 소유자를 대신하는 YouTube 사용자를 식별함을 나타냅니다. 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위해 마련되었습니다.
onBehalfOfContentOwnerChannel string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다.
참고: 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너만 사용할 수 있습니다. 이를 통해 콘텐츠 소유자는 매개변수 값에 지정된 채널을 대신하여 한 번 인증하고 각 채널에 대한 인증 사용자 인증 정보를 제공하지 않고도 작업을 실행할 수 있습니다.
onBehalfOfContentOwnerChannel 매개변수는 큐포인트가 삽입되는 방송과 연결된 채널의 YouTube 채널 ID를 지정합니다. 이 매개변수는 요청에서 onBehalfOfContentOwner 매개변수의 값을 지정하는 경우에 필요하며 이 매개변수와 함께만 사용할 수 있습니다. 다음 요구사항도 적용됩니다.
  • 요청은 onBehalfOfContentOwner 매개변수가 지정하는 콘텐츠 소유자에 연결된 사용자 계정으로 승인되어야 합니다.
  • onBehalfOfContentOwnerChannel 매개변수 값이 지정하는 채널은 onBehalfOfContentOwner 매개변수에서 지정하는 콘텐츠 소유자와 연결되어야 합니다.

요청 본문

요청 본문에 cuepoint 리소스를 제공합니다. 다음 JSON 구조는 cuepoint 리소스의 형식을 보여줍니다.

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }
 요청 본문에서 cueType 필드는 필수이며 cueTypeAd로 설정해야 합니다. 다음 속성의 값을 설정할 수도 있습니다.
  • durationSecs
  • insertionOffsetTimeMs (walltimeMs가 설정된 경우 설정하면 안 됨)
  • walltimeMs (insertionOffsetTimeMs가 설정된 경우 설정하면 안 됨)

속성

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

속성
id string
YouTube에서 큐포인트를 고유하게 식별하기 위해 할당하는 값입니다. 이 값은 브로드캐스트를 식별하는 필수 id 매개변수와 다릅니다. 이 값은 큐포인트 삽입 요청을 보낼 때 생략할 수 있습니다. 값이 API 응답에 채워집니다.
insertionOffsetTimeMs long
속성 값은 큐포인트를 삽입해야 하는 시간 오프셋(밀리초)을 나타냅니다. 이 값은 모니터 스트림의 시작 부분부터 측정되며 기본값은 0로, 큐포인트를 최대한 빨리 삽입해야 함을 나타냅니다. 브로드캐스트에 모니터 스트림이 없는 경우 이 매개변수의 값을 지정해서는 안 됩니다.

밀리초 단위로 측정되지만 이 값은 실제로는 근사치이며 YouTube는 이 시간에 최대한 근접하게 큐포인트를 삽입합니다.

이 필드의 0이 아닌 값은 브로드캐스트 스트림이 지연된 경우에만 지원됩니다. 브로드캐스트 스트림이 지연되지 않으면 0만 유효한 값입니다. 자세한 내용은 시작하기를 참고하세요.

참고: 방송에 테스트 단계가 있는 경우 오프셋은 테스트 단계가 시작된 시점부터 측정됩니다.

요청에서 이 속성과 walltimeMs 속성의 값을 지정하는 큐포인트를 삽입하려고 하면 API에서 오류를 반환합니다.
walltimeMs integer
속성 값은 큐포인트를 삽입해야 하는 실제 시간을 지정합니다. 값은 에포크 타임스탬프 (밀리초)를 나타내는 정수입니다.

요청에서 이 속성과 insertionOffsetTimeMs 속성의 값을 지정하는 큐포인트를 삽입하려고 하면 API에서 오류를 반환합니다.
durationSecs unsigned integer
큐포인트의 재생 시간입니다(단위: 초). 값은 양의 정수여야 합니다. 기본값은 30입니다.
cueType string
큐포인트의 유형입니다. 속성 값을 cueTypeAd로 설정해야 합니다.

응답

이 메서드는 요청에 성공하면 응답 본문에서 삽입된 cuepoint 리소스를 반환합니다.

오류

다음 표에는 이 메서드 호출에 대한 응답으로 API에서 반환할 수 있는 오류 메시지가 나와 있습니다. 자세한 내용은 YouTube 라이브 스트리밍 API - 오류를 참고하세요.

오류 유형 오류 세부정보 설명
insufficientPermissions (403) insufficientLivePermissions 요청에 라이브 방송에 큐포인트를 삽입할 권한이 없습니다.
insufficientPermissions (403) liveStreamingNotEnabled 요청을 승인한 사용자가 YouTube에서 라이브 스트리밍을 할 수 없습니다. 사용자는 라이브 스트리밍 시작하기 및 기능 자격 요건에서 자세한 내용을 확인할 수 있습니다.
rateLimitExceeded (403) userRequestsExceedRateLimit 사용자가 특정 기간에 너무 많은 요청을 보냈습니다.
required (400) idRequired 필수 id 매개변수는 큐포인트를 삽입할 방송을 식별해야 합니다.
required (400) cueTypeRequired 필수 cueType 필드는 API 요청 본문에 지정되어야 합니다.
notFound (404) liveBroadcastNotFound id 매개변수로 지정된 브로드캐스트가 존재하지 않습니다.
invalidValue (400) conflictingTimeFields insertionOffsetTimeMs 및 walltimeMs 중 하나만 지정할 수 있습니다. 두 값을 모두 설정하면 오류가 발생합니다. 두 값 중 하나를 설정하지 않으면 YouTube에서 기본 insertionOffsetTimeMs 시간(0)을 사용합니다. 즉, 최대한 빨리 큐포인트가 삽입됩니다.
invalidValue (400) invalidInsertionOffsetTimeMs cuepoint 리소스에 insertionOffsetTimeMs 속성의 잘못된 값이 지정되었습니다. 값은 0 또는 양의 정수여야 합니다.
invalidValue (400) invalidWalltimeMs cuepoint 리소스에 walltimeMs 속성의 잘못된 값이 지정되었습니다. 값은 epoch 타임스탬프 (밀리초)를 나타내는 정수여야 합니다.
backendError (5xx) serviceUnavailable 서비스를 사용할 수 없습니다. 몇 분 후에 다시 요청해 보세요.

사용해 보기

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