LiveBroadcasts: cuepoint

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

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

요청

HTTP 요청

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

승인

이 요청에는 다음 범위 중 최소 하나를 사용하여 인증이 필요합니다. (인증 및 승인에 대해 자세히 알아보기)

범위
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가 이 메서드에 대한 호출에 응답하여 반환할 수 있는 오류 메시지를 식별합니다. 오류 메시지 문서는 Live Streaming API가 반환할 수 있는 모든 오류를 식별합니다.

오류 유형 오류 세부정보 설명
insufficientPermissions (403) insufficientLivePermissions 실시간 방송에 큐 시점을 삽입할 권한이 없는 요청입니다.
insufficientPermissions (403) liveStreamingNotEnabled 요청을 승인한 사용자가 YouTube에서 실시간 동영상을 스트리밍할 수 없습니다. 자세한 내용은 https://support.google.com/youtube/answer/2474026 및 https://www.youtube.com/features를 참조하세요.
rateLimitExceeded (403) userRequestsExceedRateLimit 지정된 기간에 사용자가 너무 많은 요청을 보냈습니다.
required (400) idRequired 필수 id 매개변수는 큐 시점을 삽입할 방송을 식별해야 합니다.
required (400) cueTypeRequired API 요청 본문에 필수 cueType 필드를 지정해야 합니다.
notFound (404) liveBroadcastNotFound id 매개변수로 지정된 브로드캐스트가 존재하지 않습니다.
invalidValue (400) conflictingTimeFields insertionOffsetTimeMs와 walltimeMs 중 하나만 지정할 수 있습니다. 두 값을 모두 설정하면 오류가 발생합니다. 두 값 중 하나를 설정하지 않으면 YouTube가 기본 insertionOffsetTimeMs 시간(0)을 사용하므로 큐 포인트가 최대한 빨리 삽입됩니다.
invalidValue (400) invalidInsertionOffsetTimeMs cuepoint 리소스가 insertionOffsetTimeMs 속성에 잘못된 값을 지정했습니다. 값은 0 또는 양의 정수여야 합니다.
invalidValue (400) invalidWalltimeMs cuepoint 리소스가 walltimeMs 속성에 잘못된 값을 지정했습니다. 값은 에포크 타임스탬프 (밀리초)를 나타내는 정수여야 합니다.
backendError (5xx) serviceUnavailable 서비스를 사용할 수 없습니다. 몇 분 후에 다시 요청해 주세요.

사용해 보기

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