Эта страница переведена с помощью Cloud Translation API.

LiveBroadcasts: cuepoint

Вставляет точку метки в прямую трансляцию. Ключевая точка может вызвать рекламную паузу.

Примечание. Этот метод заменяет метод liveCuepoints.insert , который требовал авторизации запросов со стороны учетной записи, связанной с владельцем контента YouTube. Этот метод не требует такой же авторизации.

Запрос

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, связанный с трансляцией, в которую вставляется ключевая точка. Этот параметр требуется, когда в запросе указано значение параметра `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` . Дополнительные сведения см. в руководстве по началу работы . Примечание. Если у вашей трансляции был этап тестирования, смещение измеряется с момента начала этапа тестирования. API возвращает ошибку, если запрос пытается вставить ключевую точку, которая указывает значение для этого свойства и для свойства `walltimeMs` .
`walltimeMs`	`integer` Значение свойства указывает время настенных часов, в которое должна быть вставлена ключевая точка. Значение представляет собой целое число, представляющее отметку времени эпохи (в миллисекундах). API возвращает ошибку, если запрос пытается вставить ключевую точку, которая указывает значение для этого свойства и для свойства `insertionOffsetTimeMs` .
`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`	Обязательное поле `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` . Значение должно быть целым числом, представляющим отметку времени эпохи (в миллисекундах).
`backendError (5xx)`	`serviceUnavailable`	Сервис недоступен. Повторите запрос через несколько минут.

Попробуй это!

Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.