Channels: update

Die API unterstützt jetzt die Möglichkeit, deinen Kanal oder deine Videos als „speziell für Kinder“ zu kennzeichnen. Außerdem enthalten die Ressourcen channel und video jetzt eine Property, die den Status „speziell für Kinder“ des Kanals oder Videos angibt. Die Nutzungsbedingungen der YouTube API-Dienste und die Richtlinien für Entwickler wurden am 10. Januar 2020 aktualisiert. Weitere Informationen findest du in den Überarbeitungsverläufen für den YouTube Data API-Dienst und die Nutzungsbedingungen für YouTube API-Dienste.

Aktualisiert die Metadaten eines Channels. Diese Methode unterstützt nur Aktualisierungen der Objekte brandingSettings, invideoPromotion und localizations der Ressource channel und ihrer untergeordneten Attribute.

Kontingentauswirkung:Ein Aufruf dieser Methode hat Kontingentkosten von 50 Einheiten.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

PUT https://www.googleapis.com/youtube/v3/channels

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung finden Sie unter OAuth 2.0-Autorisierung implementieren.

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

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die diese Abfrage unterstützt. Alle aufgeführten Parameter sind Suchparameter.

Parameter
Erforderliche Parameter
part string
Der Parameter part dient in diesem Vorgang zwei Zwecken. Sie gibt die Attribute an, die durch den Schreibvorgang festgelegt werden, sowie die Attribute, die in der API-Antwort enthalten sind.

Die API lässt nur die Parameterwerte brandingSettings, invideoPromotion oder localizations zu. Sie können jeweils nur einen dieser Teile mit einer einzelnen Anfrage aktualisieren.

Mit dieser Methode werden die vorhandenen Werte für alle veränderbaren Eigenschaften überschrieben, die in dem Teil enthalten sind, der durch den Parameterwert angegeben wird.
Optionale Parameter
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden.

Der Parameter onBehalfOfContentOwner gibt an, dass der authentifizierte Nutzer im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner gedacht, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich einmal authentifizieren und erhalten dann Zugriff auf alle ihre Video- und Kanaldaten, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das tatsächliche CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.

Dieser Parameter muss angegeben werden, wenn die Anfrage mit den Anmeldedaten eines CMS-Rechteinhabers authentifiziert wird, der im Namen eines verwalteten Kanals handelt. Wenn Sie diese Angabe weglassen, wird die Anfrage im direkten Kontext des authentifizierten Nutzers ausgeführt und ein HTTP-Fehler „403 Forbidden“ zurückgegeben.

Anfragetext

Geben Sie im Anfragetext eine channel-Ressource an. Für diese Ressource:

  • Sie müssen einen Wert für diese Properties angeben:

    • id
  • Sie können Werte für die folgenden Properties festlegen:

    • brandingSettings.channel.country
    • brandingSettings.channel.description
    • brandingSettings.channel.defaultLanguage
    • brandingSettings.channel.keywords
    • brandingSettings.channel.trackingAnalyticsAccountId
    • brandingSettings.channel.unsubscribedTrailer
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description
    • status.selfDeclaredMadeForKids

    Wenn Sie eine Aktualisierungsanfrage senden und in Ihrer Anfrage kein Wert für ein Attribut angegeben ist, das bereits einen Wert hat, wird der vorhandene Wert des Attributs gelöscht.

Antwort

Bei Erfolg gibt diese Methode eine channel-Ressource im Antworttext zurück.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Reaktion auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie unter YouTube Data API – Fehler.

Fehlertyp Fehlerdetails Beschreibung
badRequest (400) brandingValidationError Einer der Werte im brandingSettings-Objekt hat die Validierung nicht bestanden. Verwende die Methode channels.list, um die vorhandenen Einstellungen für den Kanal abzurufen, und aktualisiere die Attributwerte gemäß den Richtlinien in der Dokumentation zur Ressource channels.
badRequest (400) channelTitleUpdateForbidden Wenn du die brandingSettings part eines Kanals aktualisierst, musst du den Wert der Property brandingSettings.channel.title auf den aktuellen Titel des Kanals festlegen oder die Property weglassen. Die API gibt einen Fehler zurück, wenn Sie den Wert der Eigenschaft ändern.
badRequest (400) defaultLanguageNotSetError defaultLanguage muss auf „update“ (aktualisieren) localizations festgelegt sein.
badRequest (400) invalidBrandingOption Eine der von Ihnen angegebenen Markeneinstellungen ist nicht vorhanden. Verwenden Sie die Methode channels.list, um gültige Werte abzurufen, und aktualisieren Sie sie gemäß den Richtlinien in der Dokumentation zur Ressource channels.
badRequest (400) invalidCustomMessage In den Anfragemetadaten ist eine ungültige benutzerdefinierte Nachricht angegeben. Prüfen Sie den Wert des Attributs invideoPromotion.items[].customMessage in der Ressource, die die Anfrage gesendet hat.
badRequest (400) invalidDuration In den Metadaten der Anfrage ist im Abschnitt „invideoPromotion“ eine ungültige Dauer angegeben.
badRequest (400) invalidDuration In den Metadaten der Anfrage ist ein ungültiger Positionstyp angegeben, um zu bestimmen, wie das beworbene Element im Videoplayer positioniert wird. Prüfen Sie den Wert des Attributs invideoPromotion.position.type in der Ressource, die die Anfrage gesendet hat.
badRequest (400) invalidRecentlyUploadedBy In den Metadaten der Anfrage ist eine ungültige Kanal-ID angegeben. Prüfen Sie den Wert der Eigenschaft invideoPromotion.items[].id.recentlyUploadedBy in der Ressource, an die die Anfrage gesendet wurde.
badRequest (400) invalidTimingOffset In den Metadaten der Anfrage ist im Teil „invideoPromotion“ ein ungültiger Zeitversatz angegeben.
badRequest (400) invalidTimingOffset In den Metadaten der Anfrage ist ein ungültiger Zeitversatz angegeben, um zu bestimmen, wann der beworbene Artikel im Videoplayer angezeigt werden soll. Prüfen Sie den Wert des Attributs invideoPromotion.timing.offsetMs in der Ressource, die die Anfrage gesendet hat.
badRequest (400) invalidTimingType In den Metadaten der Anfrage ist eine ungültige Timing-Methode angegeben, um zu bestimmen, wann der beworbene Artikel im Videoplayer angezeigt werden soll. Prüfen Sie den Wert der Eigenschaft invideoPromotion.timing.type in der Ressource, an die die Anfrage gesendet wurde.
badRequest (400) localizationValidationError Einer der Werte im Objekt „localizations“ konnte nicht validiert werden. Verwenden Sie die Methode channels.list, um gültige Werte abzurufen, und aktualisieren Sie sie gemäß den Richtlinien in der Dokumentation zur Channels-Ressource.
badRequest (400) tooManyPromotedItems Die Anzahl der zulässigen beworbenen Elemente im Teil „invideoPromotion“ wurde überschritten.
forbidden (403) channelForbidden Der im Parameter id angegebene Kanal unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
forbidden (403) promotedVideoNotAllowed Der Kanal, der mit der API-Anfrage aktualisiert werden soll, wurde nicht gefunden. Prüfe den Wert des Attributs id in der Ressource channel, die die Anfrage gesendet hat, um sicherzustellen, dass die Kanal-ID korrekt ist.
forbidden (403) websiteLinkNotAllowed Die angegebene Website-URL ist nicht zulässig.
notFound (404) channelNotFound Der im Parameter id angegebene Kanal wurde nicht gefunden.
notFound (404) channelNotFound Der mit dem Parameter id angegebene Kanal wurde nicht gefunden oder hat keine Branding-Optionen.
notFound (404) unknownChannelId Die angegebene Channel-ID wurde nicht gefunden.
notFound (404) unknownChannelId Die angegebene „recentlyUploadedBy“-Kanal-ID wurde nicht gefunden.
notFound (404) unknownVideoId Die als beworbenes Element angegebene Video-ID wurde nicht gefunden.
required (400) requiredItemIdType In den Metadaten der Anfrage muss im Teil „invideoPromotion“ ein Elementtyp angegeben werden.
required (400) requiredItemId In den Metadaten der Anfrage muss im Teil „invideoPromotion“ eine Artikel-ID angegeben werden.
required (400) requiredTimingOffset In den Anfragemetadaten muss ein Standard-Timing-Offset angegeben werden, damit YouTube feststellen kann, wann das beworbene Element angezeigt werden soll. Legen Sie den Wert des Attributs invideoPromotion.defaultTiming.offsetMs in der Ressource fest, die von der Anfrage gesendet wird.
required (400) requiredTimingOffset In den Metadaten der Anfrage muss ein zeitlicher Versatz angegeben werden, damit YouTube feststellen kann, wann das beworbene Element angezeigt werden soll. Legen Sie den Wert des Attributs invideoPromotion.timing.offsetMs in der Ressource fest, die von der Anfrage gesendet wird.
required (400) requiredTimingType In den Anfragemetadaten muss eine Timing-Methode angegeben werden, damit YouTube feststellen kann, wann das beworbene Element angezeigt werden soll. Legen Sie den Wert des Attributs invideoPromotion.defaultTiming.type in der Ressource fest, die von der Anfrage gesendet wird.
required (400) requiredTimingType In den Metadaten der Anfrage muss eine Timing-Methode angegeben werden, damit YouTube bestimmen kann, wann der beworbene Artikel angezeigt werden soll. Legen Sie den Wert des Attributs invideoPromotion.timing.type in der Ressource fest, die von der Anfrage gesendet wird.
required (400) requiredTiming In den Metadaten der Anfrage muss für jedes Element im invideoPromotion-Teil ein Zeitpunkt angegeben werden.
required (400) requiredVideoId In den Metadaten der Anfrage muss eine Video-ID angegeben werden, um den beworbenen Artikel zu identifizieren.
required (400) requiredWebsiteUrl In den Metadaten der Anfrage muss im Abschnitt „invideoPromotion“ eine Website-URL angegeben werden. Legen Sie den Wert des Attributs invideoPromotion.items[].id.websiteUrl in der Ressource fest, die mit der Anfrage gesendet wird.

Testen!

Verwenden Sie den APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort zu sehen.