Channels: update

この API では、チャンネルまたは動画を「子ども向け」としてマークできるようになりました。さらに、channel リソースと video リソースには、そのチャンネルまたは動画の「子ども向け」ステータスを識別するプロパティも含まれるようになりました。YouTube API サービス利用規約とデベロッパー ポリシーも 2020 年 1 月 10 日に更新されました。詳細については、YouTube Data API サービスのリビジョン履歴と YouTube API サービスの利用規約をご覧ください。

チャンネルのメタデータを更新します。このメソッドは、channel リソースの brandingSettings、invideoPromotion、localizations オブジェクトとその子プロパティの更新のみをサポートします。

割り当てへの影響: このメソッドの呼び出しでは、50 ユニットの割り当て費用が発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と承認の詳細については、OAuth 2.0 承認の実装をご覧ください。

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

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータは、このオペレーションで 2 つの目的を果たします。書き込みオペレーションで設定されるプロパティと、API レスポンスに含まれるプロパティを識別します。

この API では、パラメータ値を brandingSettings、invideoPromotion、localizations のいずれかに設定できます。（1 つのリクエストで更新できるのは、これらの部分のいずれか 1 つだけです）。

このメソッドは、パラメータ値で指定された部分に含まれるすべての変更可能なプロパティの既存の値をオーバーライドします。
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。

onBehalfOfContentOwner パラメータは、認証済みユーザーがパラメータ値で指定されたコンテンツ所有者の代理で行動することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する実際の CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。

リクエスト本文

リクエスト本文に channel リソースを指定します。そのリソースの場合:

  • 以下のプロパティの値を指定する必要があります。

    • id

  • 以下のプロパティの値を指定することができます。

    • 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

    更新リクエストを送信する場合、既に値が設定されているプロパティの値を指定していないと、そのプロパティの既存の値が削除されます。

レスポンス

成功すると、このメソッドはレスポンスの本文で channel リソースを返します。

エラー

次の表に、このメソッドの呼び出しに対する応答として API から返される可能性のあるエラー メッセージを示します。詳細については、YouTube Data API - エラーをご覧ください。

エラーのタイプ エラーの詳細 説明
badRequest (400) brandingValidationError brandingSettings オブジェクトの値のいずれかが検証に失敗しました。channels.list メソッドを使用してチャンネルの既存の設定を取得し、channels リソースのドキュメントのガイドラインに沿ってプロパティ値を更新します。
badRequest (400) channelTitleUpdateForbidden チャンネルの brandingSettings part を更新する場合は、brandingSettings.channel.title プロパティの値をチャンネルの現在のタイトルに設定するか、プロパティを省略する必要があります。プロパティの値を変更すると、API はエラーを返します。
badRequest (400) defaultLanguageNotSetError localizations を更新するには、defaultLanguage を設定する必要があります。
badRequest (400) invalidBrandingOption 指定したブランド設定のいずれかが存在しません。channels.list メソッドを使用して有効な値を取得し、channels リソースのドキュメントのガイドラインに沿って更新してください。
badRequest (400) invalidCustomMessage リクエスト メタデータに無効なカスタム メッセージが指定されています。リクエストが送信したリソースの invideoPromotion.items[].customMessage プロパティの値を確認します。
badRequest (400) invalidDuration リクエスト メタデータの invideoPromotion 部分に無効な時間指定が指定されています。
badRequest (400) invalidDuration 動画プレーヤーでのプロモート アイテムの配置方法を決定するための、リクエスト メタデータにより指定されている位置タイプが無効です。リクエストが送信したリソースの invideoPromotion.position.type プロパティの値を確認します。
badRequest (400) invalidRecentlyUploadedBy リクエスト メタデータに無効なチャンネル ID が指定されています。リクエストが送信したリソースの invideoPromotion.items[].id.recentlyUploadedBy プロパティの値を確認します。
badRequest (400) invalidTimingOffset リクエスト メタデータの invideoPromotion 部分に無効なタイミング オフセットが指定されています。
badRequest (400) invalidTimingOffset リクエスト メタデータが、動画プレーヤーにプロモート アイテムを表示するタイミングを決定するために指定しているタイミング オフセットが無効です。リクエストが送信したリソースの invideoPromotion.timing.offsetMs プロパティの値を確認します。
badRequest (400) invalidTimingType リクエスト メタデータが、動画プレーヤーにプロモート アイテムを表示するタイミングを決定するために指定しているタイミング メソッドが無効です。リクエストが送信したリソースの invideoPromotion.timing.type プロパティの値を確認します。
badRequest (400) localizationValidationError localizations オブジェクトの値のいずれかが検証に失敗しました。channels.list メソッドを使用して有効な値を取得し、チャンネル リソースのドキュメントのガイドラインに沿って更新してください。
badRequest (400) tooManyPromotedItems invideoPromotion 部分で、許可されているプロモーション対象アイテムの数を超えています。
forbidden (403) channelForbidden id パラメータで指定されたチャネルがリクエストをサポートしていないか、リクエストが適切に承認されていません。
forbidden (403) promotedVideoNotAllowed API リクエストが更新しようとしているチャンネルが見つかりません。リクエストで送信された channel リソースの id プロパティの値を確認し、チャンネル ID が正しいことを確認します。
forbidden (403) websiteLinkNotAllowed 指定されたウェブサイトの URL は許可されていません。
notFound (404) channelNotFound id パラメータで指定されたチャンネルが見つかりませんでした。
notFound (404) channelNotFound id パラメータで指定されたチャンネルが見つからない、またはブランディング オプションがない。
notFound (404) unknownChannelId 指定されたチャンネル ID が見つかりませんでした。
notFound (404) unknownChannelId 指定された recentlyUploadedBy チャンネル ID が見つかりませんでした。
notFound (404) unknownVideoId プロモート アイテムとして指定された動画 ID が見つかりません。
required (400) requiredItemIdType リクエスト メタデータの invideoPromotion 部分でアイテムタイプを指定する必要があります。
required (400) requiredItemId リクエスト メタデータの invideoPromotion 部分にアイテム ID を指定する必要があります。
required (400) requiredTimingOffset リクエスト メタデータでデフォルトのタイミング オフセットを指定すると、YouTube はプロモーション対象アイテムを表示するタイミングを決定できます。リクエストが送信するリソースで invideoPromotion.defaultTiming.offsetMs プロパティの値を設定します。
required (400) requiredTimingOffset リクエスト メタデータでタイミング オフセットを指定して、プロモート アイテムを表示するタイミングを YouTube が判断できるようにする必要があります。リクエストが送信するリソースで invideoPromotion.timing.offsetMs プロパティの値を設定します。
required (400) requiredTimingType リクエスト メタデータでタイミング メソッドを指定して、プロモート アイテムを表示するタイミングを YouTube が判断できるようにする必要があります。リクエストが送信するリソースで invideoPromotion.defaultTiming.type プロパティの値を設定します。
required (400) requiredTimingType リクエスト メタデータでタイミング メソッドを指定して、プロモート アイテムを表示するタイミングを YouTube が判断できるようにする必要があります。リクエストが送信するリソースで invideoPromotion.timing.type プロパティの値を設定します。
required (400) requiredTiming リクエスト メタデータで、invideoPromotion 部分の各アイテムのタイミングを指定する必要があります。
required (400) requiredVideoId プロモート アイテムを特定するため、リクエスト メタデータには動画 ID を指定する必要があります。
required (400) requiredWebsiteUrl リクエスト メタデータの invideoPromotion 部分にウェブサイトの URL を指定する必要があります。リクエストが送信するリソースで invideoPromotion.items[].id.websiteUrl プロパティの値を設定します。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。