LiveBroadcasts: control

Uwaga: metoda liveBroadcasts.control została wycofana i przestanie działać 1 października 2020 r. Po tej dacie wszystkie wywołania tej metody będą zwracać błąd zabroniony (403). Ta metoda zostanie później usunięta.

Klienci nadal mogą implementować własne zmienne, dodając nakładkę do filmu wysyłanego na serwery przetwarzania danych YouTube. Zobacz ogłoszenie o wycofaniu

Określa ustawienia planszy, która może być wyświetlana w transmisji.

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji z co najmniej jednym z poniższych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

Zakres
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parametry

W poniższej tabeli podano parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
id string
Parametr id określa identyfikator transmisji na żywo w YouTube, który jednoznacznie identyfikuje transmisję, w której jest aktualizowana plansza.
part string
Parametr part określa rozdzieloną przecinkami listę co najmniej jednej właściwości zasobu liveBroadcast, która będzie uwzględniona w odpowiedzi interfejsu API. Nazwy parametrów part, które możesz umieszczać w wartościach parametrów, to id, snippet, contentDetails i status.
Parametry opcjonalne
displaySlate boolean
Parametr displaySlate określa, czy plansza jest włączona lub wyłączona.
offsetTimeMs unsigned long
Parametr offsetTimeMs określa dodatnie przesunięcie czasu, gdy nastąpi zmiana określonej planszy. Wartość jest mierzona w milisekundach od początku strumienia monitorowania transmisji, czyli w tym samym momencie, w którym rozpoczęła się faza testowania transmisji. Mimo że wartość ta jest określona w milisekundach, jest to wartość przybliżona, a YouTube wykonuje wymagane działanie w jak najkrótszym czasie.

Jeśli nie określisz wartości tego parametru, YouTube podejmie działanie tak szybko, jak to możliwe. Więcej informacji znajdziesz w przewodniku Pierwsze kroki.

Ważne: wartość tego parametru należy podać tylko wtedy, gdy transmisja jest opóźniona.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów w sieci reklamowej YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane logowania żądania autoryzacji to użytkownik YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie tylko raz oraz dostęp do wszystkich filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik się uwierzytelni, musi być połączone z określonym właścicielem treści w YouTube.
onBehalfOfContentOwnerChannel string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Tego parametru można używać tylko w odpowiednim autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony tylko dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego jest dodawany film. Ten parametr jest wymagany, gdy żądanie określa wartość parametru onBehalfOfContentOwner i można go używać tylko w połączeniu z tym parametrem. Dodatkowo żądanie musi być autoryzowane za pomocą konta CMS połączonego z właścicielem treści, które jest określone w parametrze onBehalfOfContentOwner. Na koniec kanał, który określa parametr onBehalfOfContentOwnerChannel, musi być powiązany z właścicielem treści, który jest określony przez parametr onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie raz i wykonywanie działań w imieniu kanału określonego w wartości parametru, bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna.
walltime datetime
Parametr walltime określa czas zegara ściennego, w którym ma nastąpić zmiana planszy. Wartość ma format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się powiedzie, metoda zwróci zasób LiveBroadcast w treści odpowiedzi.

Błędy

W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
backendError errorDisplaySlate Podczas wykonywania żądanego działania wystąpił błąd.
forbidden (403) liveBroadcastControlNotAllowed Żądane działanie jest dozwolone tylko wtedy, gdy stan transmisji to live.
insufficientPermissions insufficientLivePermissions Użytkownik nie jest upoważniony do wykonania żądanej operacji, prawdopodobnie dlatego, że nie ma uprawnień do transmitowania na żywo.
insufficientPermissions liveStreamingNotEnabled Użytkownik, który autoryzował żądanie, nie ma dostępu do transmisji na żywo w YouTube. Więcej informacji użytkownik może znaleźć na stronie https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Możesz podać tylko jedną wartość offsetTimeMs i walltime.
invalidValue (400) invalidOffsetTimeMs Wartość parametru offsetTimeMs jest nieprawidłowa. Wartość parametru musi być dodatnia, ale można ją określić tylko wtedy, gdy włączony jest strumień monitorowania transmisji.
invalidValue (400) invalidWalltime Wartość parametru walltime jest nieprawidłowa.
notFound (404) liveBroadcastNotFound Komunikat określony przez parametr id nie istnieje.
required (400) actionRequired Żądanie do interfejsu API musi określać co najmniej jedno działanie. Obecnie jedynym obsługiwanym działaniem jest możliwość włączenia lub wyłączenia planszy.
required (400) idRequired Wymagany parametr id musi identyfikować transmisję, która jest aktualizowana.

Wypróbuj

Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.