Wir aktualisieren die Data API, damit sie der Zählweise von YouTube-Aufrufen für Kurzvideos entspricht.
Weitere Informationen
Captions: update
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Aktualisiert einen Untertiteltrack. Beim Aktualisieren eines Untertiteltracks kannst du den Status des Entwurfs ändern, eine neue Untertiteldatei für den Track hochladen oder beides.
Diese Methode unterstützt das Hochladen von Medien. Hochgeladene Dateien müssen diesen Einschränkungen entsprechen:
- Maximale Dateigröße:100 MB
- Zulässige Medien-MIME-Typen:
text/xml
, application/octet-stream
, */*
Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 450 Einheiten.
Gängige Anwendungsfälle
Anfragen
HTTP-Anfrage
PUT https://www.googleapis.com/upload/youtube/v3/captions
Parameter
In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.
Parameter |
Erforderliche Parameter |
part |
string
Der Parameter part dient in diesem Vorgang zwei Zwecken. Sie identifiziert die Eigenschaften, die durch den Schreibvorgang festgelegt werden, sowie die Eigenschaften, die die API-Antwort enthalten wird. Setze den Attributwert auf snippet , wenn du den Entwurfsstatus des Tracks aktualisierst. Setzen Sie andernfalls den Attributwert auf id .
Die folgende Liste enthält die part -Namen, die Sie in den Parameterwert aufnehmen können:
|
Optionale Parameter |
onBehalfOfContentOwner |
string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.
Der Parameter onBehalfOfContentOwner gibt an, dass durch die Autorisierungsanmeldedaten der Anfrage ein YouTube CMS-Nutzer identifiziert wird, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das eigentliche CMS-Konto, bei dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein. |
sync |
boolean
Dieser Parameter wurde eingestellt.
Hinweis:Der API-Server verarbeitet den Parameterwert nur, wenn die Anfrage eine aktualisierte Untertiteldatei enthält.
Der Parameter sync gibt an, ob YouTube die Untertiteldatei automatisch mit dem Audiotrack des Videos synchronisieren soll. Wenn du den Wert auf true setzt, synchronisiert YouTube den Untertiteltrack automatisch mit dem Audiotrack. |
Anfragetext
Geben Sie im Anfragetext eine Untertitelressource an.
Für diese Ressource:
-
Sie müssen einen Wert für diese Attribute angeben:
-
Sie können Werte für diese Eigenschaften festlegen:
Wenn Sie eine Aktualisierungsanfrage senden und in Ihrer Anfrage kein Wert für eine Eigenschaft angegeben ist, die bereits einen Wert hat, wird der vorhandene Wert der Eigenschaft gelöscht.
Antwort
Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Untertitel-Ressource im Antworttext zurückgegeben.
Fehler
In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.
Fehlertyp |
Fehlerdetails |
Beschreibung |
badRequest (400) |
contentRequired |
Bei der Anfrage wurde keine aktualisierte Untertiteldatei hochgeladen. Der tatsächliche Titelinhalt ist erforderlich, wenn der Parameter sync auf true gesetzt ist. |
forbidden (403) |
forbidden |
Die mit der Anfrage verknüpften Berechtigungen reichen nicht aus, um den Untertiteltrack zu aktualisieren. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert. |
notFound (404) |
captionNotFound |
Der angegebene Untertiteltrack wurde nicht gefunden. Prüfen Sie, ob der Wert des Attributs id der Anfrage korrekt ist. |
Jetzt testen
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-04-26 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-04-26 (UTC)."],[],[],null,["# Captions: update\n\nUpdates a caption track. When updating a caption track, you can change the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption file for the track, or both.\n\nThis method supports media upload. Uploaded files must conform to these constraints:\n\n- **Maximum file size:** 100MB\n- **Accepted Media MIME types:** `text/xml`, `application/octet-stream`, `*/*`\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 450 units.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/upload/youtube/v3/captions\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/guides/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtubepartner` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to `snippet` if you are updating the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft). Otherwise, set the property value to `id`. The following list contains the `part` names that you can include in the parameter value: - `id` - `snippet` |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/v3/guides/authentication). **Note:** This parameter is intended exclusively for YouTube content partners. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |\n| `sync` | `boolean` This parameter has been deprecated. **Note:** The API server only processes the parameter value if the request contains an updated caption file. The **sync** parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to `true`, YouTube will automatically synchronize the caption track with the audio track. |\n\n### Request body\n\nProvide a [caption resource](/youtube/v3/docs/captions#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `id`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.isDraft`\n\n \u003cbr /\u003e\n\n If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\n\nResponse\n--------\n\nIf successful, this method returns a [caption resource](/youtube/v3/docs/captions#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|--------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `badRequest (400)` | `contentRequired` | The request did not upload an updated caption file. The actual track contents are required if the `sync` parameter is set to `true`. |\n| `forbidden (403)` | `forbidden` | The permissions associated with the request are not sufficient to update the caption track. The request might not be properly authorized. |\n| `notFound (404)` | `captionNotFound` | The specified caption track could not be found. Check the value of the request's `id` property to ensure that it is correct. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]