Aktualizujemy interfejs Data API, aby był zgodny ze sposobem zliczania przez YouTube wyświetleń filmów Short.
Więcej informacji
Wdrożenie: napisy
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Poniższe przykłady pokazują, jak używać interfejsu YouTube Data API (w wersji 3) do wykonywania funkcji związanych z napisami.
Pobieranie listy ścieżek z napisami do filmu
Tworzenie ścieżki z napisami
Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono przesyłania plików, co jest wymagane w przypadku tej metody.
Aby przesłać nową ścieżkę z napisami do filmu, możesz użyć metody captions.insert interfejsu API. Podczas przesyłania utworu musisz podać wartość dla tych właściwości zasobu caption:
Podczas przesyłania ścieżki z napisami dostępne są te dodatkowe opcje:
-
Jeśli ustawisz parametr sync na true, YouTube zignoruje wszystkie kody czasowe w przesłanym pliku z napisami i wygeneruje nowe kody czasowe dla napisów.
Jeśli przesyłasz transkrypcję, która nie zawiera kodów czasowych, lub jeśli podejrzewasz, że kody czasowe w pliku są nieprawidłowe i chcesz, aby YouTube spróbował je poprawić, ustaw parametr sync na true.
-
Jeśli ustawisz wartość właściwości snippet.isDraft zasobu caption na true, ścieżka nie będzie widoczna publicznie.
Przykłady kodu znajdziesz w dokumentacji metody captions.insert.
Pobieranie ścieżki z napisami
Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono pobierania plików.
Aby pobrać określony ścieżkę z napisami, wywołaj metodę captions.download. Ustaw wartość parametru id na identyfikator ścieżki z napisami w YouTube, który jednoznacznie identyfikuje pobieraną ścieżkę z napisami. Żądanie musi być autoryzowane za pomocą OAuth 2.0.
Interfejs API w wersji 3 obsługuje te opcje:
-
Aby określić, że ścieżka z napisami ma zostać zwrócona w określonym formacie, ustaw wartość parametru tfmt, aby wskazać żądany format. Definicja parametru zawiera listę obsługiwanych wartości.
-
Aby pobrać tłumaczenie ścieżki z napisami, ustaw wartość parametru tlang na dwuliterowy kod języka ISO 639-1, który identyfikuje odpowiedni język napisów. Tłumaczenie jest generowane za pomocą tłumaczenia maszynowego, takiego jak Tłumacz Google.
Przykłady kodu znajdziesz w dokumentacji metody captions.download.
Aktualizowanie ścieżki z napisami
Interfejs API umożliwia zmianę stanu roboczego ścieżki napisów, przesłanie nowej ścieżki napisów do pliku lub wykonanie obu tych czynności.
Za pomocą narzędzia APIs Explorer możesz przetestować możliwość zmiany statusu szkicu utworu. Nie możesz jednak używać Eksploratora interfejsów API do aktualizowania właściwego ścieżki napisów, ponieważ to narzędzie nie obsługuje przesyłania plików.
Poniższe żądanie pobiera listę napisów do filmu na kanale YouTube Google Stories:
Prośba zaktualizuje stan wersji roboczej ścieżki z napisami na true, co oznacza, że ścieżka nie będzie widoczna publicznie. Aby przesłać żądanie w poruszniku interfejsów API, musisz ustawić wartość właściwości id, aby zidentyfikować ścieżkę napisów.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet
Przykłady kodu znajdziesz w dokumentacji metody captions.update.
Usuwanie ścieżki z napisami
Ten przykład pokazuje, jak usunąć ścieżkę z napisami. Przykład zawiera te kroki:
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-11-23 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2024-11-23 UTC."],[[["\u003cp\u003eThis document provides instructions on how to use the YouTube Data API (v3) to manage video captions.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a list of caption tracks for a specific video using the \u003ccode\u003ecaptions.list\u003c/code\u003e method, requiring OAuth 2.0 authorization.\u003c/p\u003e\n"],["\u003cp\u003eUploading a new caption track to a video is achieved using the \u003ccode\u003ecaptions.insert\u003c/code\u003e method, requiring the \u003ccode\u003esnippet.videoId\u003c/code\u003e, \u003ccode\u003esnippet.language\u003c/code\u003e, and \u003ccode\u003esnippet.name\u003c/code\u003e properties to be set.\u003c/p\u003e\n"],["\u003cp\u003eDownloading a specific caption track is possible via the \u003ccode\u003ecaptions.download\u003c/code\u003e method, including options to specify the desired format and retrieve a translated version.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows for updating a caption track's draft status and even deleting it completely using the \u003ccode\u003ecaptions.update\u003c/code\u003e and \u003ccode\u003ecaptions.delete\u003c/code\u003e methods respectively.\u003c/p\u003e\n"]]],["The YouTube Data API (v3) facilitates caption management. Key actions include: retrieving caption track lists for a video via `captions.list`; creating new tracks with `captions.insert`, specifying video ID, language, and name; downloading tracks with `captions.download`, allowing format and language selection; updating track status or file with `captions.update`; and deleting tracks using `captions.delete` after retrieving the track ID. Uploading caption files cannot be tested in the APIs Explorer.\n"],null,["# Implementation: Captions\n\nThe following examples show how to use the YouTube Data API (v3) to perform functions related to captions.\n\nRetrieve a list of caption tracks for a video\n---------------------------------------------\n\nTo retrieve a list of caption tracks that are available for a specific video, call the [captions.list](/youtube/v3/docs/captions/list) method. Set the [videoId](/youtube/v3/docs/captions/list#videoId) parameter value to the YouTube video ID that uniquely identifies the video for which you are retrieving captions. Your request must be authorized using OAuth 2.0.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel: \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?\npart=snippet\n&videoId=PRU2ShMzQRg\n```\n\nSee the [captions.list](/youtube/v3/docs/captions/list#usage) method's documentation for code samples.\n\nCreate a caption track\n----------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to upload files, which is a requirement for this method.\n\nYou can use the API's [captions.insert](/youtube/v3/docs/captions/insert) method to upload a new caption track for a video. When uploading a track, you must specify a value for the following `caption` resource properties:\n\n\u003cbr /\u003e\n\n- [snippet.videoId](/youtube/v3/docs/captions#snippet.videoId) - This identifies the video to which the caption track is being added.\n- [snippet.language](/youtube/v3/docs/captions#snippet.language) - The language of the caption track.\n- [snippet.name](/youtube/v3/docs/captions#snippet.name) - The name of the caption track.\n\n\u003cbr /\u003e\n\nThe following additional options are available when uploading a caption track:\n\n- If you set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true`, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.\n\n You should set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true` if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.\n- If you set the `caption` resource's [snippet.isDraft](/youtube/v3/docs/captions#snippet.isDraft) property to `true`, the track will not be publicly visible.\n\nSee the [captions.insert](/youtube/v3/docs/captions/insert#examples) method's documentation for code samples.\n\nDownload a caption track\n------------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to download files.\n\nTo download a specific caption track, call the [captions.download](/youtube/v3/docs/captions/download) method. Set the [id](/youtube/v3/docs/captions/download#id) parameter value to the YouTube caption track ID that uniquely identifies the caption track that you are downloading. Your request must be authorized using OAuth 2.0.\n\nThe v3 API supports the following options:\n\n- To specify that a caption track should be returned in a specific format, set the [tfmt](/youtube/v3/docs/captions/download#tfmt) parameter value to identify the desired format. The parameter definition lists supported values.\n\n- To retrieve a translation of a caption track, set the [tlang](/youtube/v3/docs/captions/download#tlang) parameter value to an [ISO 639-1 two-letter language code](http://www.loc.gov/standards/iso639-2/php/code_list.php) that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.\n\nSee the [captions.download](/youtube/v3/docs/captions/download#examples) method's documentation for code samples.\n\nUpdate a caption track\n----------------------\n\nThe API supports the ability to change a caption track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption track for a file, or both.\n\nYou can use the APIs Explorer to test the ability to change a track's draft status. However, you cannot use the APIs Explorer to update the actual caption track because tool does not support the ability to upload files.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel:\n\nThe request updates the draft status of a caption track to `true`, which means the track will not be publicly visible. To complete the request in the APIs Explorer, you need to set the `id` property's value to identify a caption track. \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?\npart=snippet\n```\n\nSee the [captions.update](/youtube/v3/docs/captions/update#usage) method's documentation for code samples.\n\nDelete a caption track\n----------------------\n\nThis example shows how to delete a caption track. The example has the following steps:\n\n- **Step 1: Retrieve the caption track ID**\n\n Follow the steps above to [retrieve a list of caption tracks](#captions-list) for a video. The list could be used to display a list of caption tracks, using each track's ID as a key.\n- **Step 2: Delete the track**\n\n Call the [captions.delete](/youtube/v3/docs/captions/delete) method to delete a specific video. In the request, the `id` parameter specifies the caption track ID of the track that you are deleting. The request must be authorized using OAuth 2.0. If you are testing this query in the APIs Explorer, you will need to substitute a valid caption track ID for the `id` parameter value. \n\n ```\n https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?\n id=CAPTION_TRACK_ID\n ```"]]
