LiveBroadcasts: control

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

Klienci mogą zaimplementować własną planszę, dodając nakładkę do filmu wysyłanego na serwery przetwarzania YouTube. Zobacz ogłoszenie o wycofaniu tej funkcji

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych 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 tabeli poniżej znajdziesz 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 aktualizujesz planszę.
part string
Parametr part określa rozdzieloną przecinkami listę właściwości zasobu liveBroadcast, która będzie zawarta w odpowiedzi interfejsu API. Nazwy elementu part, które możesz uwzględnić w wartości parametru, to id, snippet, contentDetails i status.
Parametry opcjonalne
displaySlate boolean
Parametr displaySlate określa, czy plansza jest włączona czy wyłączona.
offsetTimeMs unsigned long
Parametr offsetTimeMs określa dodatnią przesunięcie czasu po wystąpieniu określonej zmiany planszy. Wartość jest mierzona w milisekundach od początku strumienia monitorowania transmisji, czyli od momentu rozpoczęcia fazy testowania transmisji. Mimo że jest ona określona w milisekundach, w rzeczywistości jest to wartość przybliżona, a YouTube wykonuje żądane działanie tak szybko, jak to możliwe.

Jeśli nie określisz wartości tego parametru, YouTube wykona działanie tak szybko, jak to możliwe. Więcej informacji znajdziesz w przewodniku dla początkujących.

Ważne: wartość tego parametru należy określić tylko wtedy, gdy transmisja jest opóźniona.
onBehalfOfContentOwner string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądanie identyfikują użytkownika YouTube CMS działającego w imieniu właściciela treści określonego w wartości parametru. Jest on przeznaczony dla dostawców treści w YouTube, którzy mają wiele różnych kanałów w YouTube i nimi zarządzają. Dzięki niej właściciele treści mogą jednorazowo uwierzytelnić się i uzyskiwać dostęp do wszystkich swoich filmów oraz danych dotyczących kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik uwierzytelnia się, musi być powiązane z określonym właścicielem treści YouTube.
onBehalfOfContentOwnerChannel string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału w YouTube, do którego jest dodawany film. Ten parametr jest wymagany, gdy w żądaniu określona jest wartość parametru onBehalfOfContentOwner i można go używać tylko w połączeniu z tym parametrem. Prośba musi być dodatkowo autoryzowana za pomocą konta CMS połączonego z właścicielem treści określonym w parametrze onBehalfOfContentOwner. Kanał wskazany za pomocą parametru onBehalfOfContentOwnerChannel musi być połączony z właścicielem treści określonym w parametrze onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów dostarczających treści do YouTube, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Pozwala właścicielom treści jednorazowo uwierzytelnić się i wykonywać działania 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 godzinę, o której nastąpi zmiana planszy. Wartość należy podać w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

Treść żądania

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, 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 szczegółów 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 ma uprawnień do wykonania żądanej operacji prawdopodobnie dlatego, że nie ma uprawnień do transmitowania na żywo.
insufficientPermissions liveStreamingNotEnabled Użytkownik, który autoryzował żądanie, nie ma uprawnień do transmitowania na żywo w YouTube. Więcej informacji może znaleźć na stronie https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Można określić tylko jedną wartość offsetTimeMs i walltime.
invalidValue (400) invalidOffsetTimeMs Wartość parametru offsetTimeMs jest nieprawidłowa. Wartość parametru musi być dodatnia, ale można go określić tylko wtedy, gdy włączony jest strumień monitorowania transmisji.
invalidValue (400) invalidWalltime Wartość parametru walltime jest nieprawidłowa.
notFound (404) liveBroadcastNotFound Transmisja określona przez parametr id nie istnieje.
required (400) actionRequired Żądanie do interfejsu API musi określać co najmniej 1 działanie. Obecnie jedynym obsługiwanym działaniem jest włączanie i wyłączanie planszy.
required (400) idRequired Wymagany parametr id musi wskazywać transmisję, która jest aktualizowana.

Wypróbuj

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