Channels

channel リソースには、YouTube チャンネルに関する情報が格納されます。

メソッド

この API では、channels リソースについて以下のメソッドがサポートされています。

list

リクエスト条件に一致するゼロ個以上の channel リソースを返します。 今すぐ試す。

update

チャンネルのメタデータを更新します。このメソッドは現在、channel リソースの brandingSettings および invideoPromotion オブジェクトとその子プロパティに対する更新のみをサポートすることに注意してください。 今すぐ試す。

リソース表現

下記の JSON の構造体は、channels リソースの形式を示したものです。

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string,
      "watchHistory": string,
      "watchLater": string
    },
    "googlePlusUserId": string
  },
  "statistics": {
    "viewCount": unsigned long,
    "commentCount": unsigned long,
    "subscriberCount": unsigned long,
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "defaultTab": string,
      "trackingAnalyticsAccountId": string,
      "moderateComments": boolean,
      "showRelatedChannels": boolean,
      "showBrowseView": boolean,
      "featuredChannelsTitle": string,
      "featuredChannelsUrls": [
        string
      ],
      "unsubscribedTrailer": string,
      "profileColor": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    },
    "image": {
      "bannerImageUrl": string,
      "bannerMobileImageUrl": string,
      "backgroundImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "largeBrandedBannerImageImapScript": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "largeBrandedBannerImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "smallBrandedBannerImageImapScript": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "smallBrandedBannerImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "watchIconImageUrl": string,
      "trackingImageUrl": string,
      "bannerTabletLowImageUrl": string,
      "bannerTabletImageUrl": string,
      "bannerTabletHdImageUrl": string,
      "bannerTabletExtraHdImageUrl": string,
      "bannerMobileLowImageUrl": string,
      "bannerMobileMediumHdImageUrl": string,
      "bannerMobileHdImageUrl": string,
      "bannerMobileExtraHdImageUrl": string,
      "bannerTvImageUrl": string,
      "bannerExternalUrl": string
    },
    "hints": [
      {
        "property": string,
        "value": string
      }
    ]
  },
  "invideoPromotion": {
    "defaultTiming": {
      "type": string,
      "offsetMs": unsigned long,
      "durationMs": unsigned long
    },
    "position": {
      "type": string,
      "cornerPosition": string
    },
    "items": [
      {
        "id": {
          "type": string,
          "videoId": string,
          "websiteUrl": string
        },
        "timing": {
          "type": string,
          "offsetMs": unsigned long,
          "durationMs": unsigned long
        },
        "customMessage": string
      }
    ]
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind	string API リソースのタイプ。値は youtube#channel です。
etag	etag このリソースの Etag。
id	string チャンネルを一意に識別するために YouTube によって使用される ID。
snippet	object snippet オブジェクトには、チャンネルに関する基本的な詳細情報（タイトル、説明、サムネイル画像など）が格納されます。
snippet.title	string チャンネルのタイトル。
snippet.description	string チャンネルの説明。
snippet.publishedAt	datetime チャンネルの作成日時。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。
snippet.thumbnails	object チャンネルに関連付けられているサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。
snippet.thumbnails.(key)	object 有効なキー値は次のとおりです。 default – デフォルトのサムネイル画像。動画（または、再生リストのアイテムや検索結果など、動画を参照するリソース）のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。 medium – やや解像度の高いバージョンのサムネイル画像。動画（または動画を参照するリソース）の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。 high – 高解像度バージョンのサムネイル画像。動画（または動画を参照するリソース）の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
snippet.thumbnails.(key).url	string 画像の URL。
snippet.thumbnails.(key).width	unsigned integer 画像の幅。
snippet.thumbnails.(key).height	unsigned integer 画像の高さ。
contentDetails	object contentDetails オブジェクトは、チャンネルのコンテンツに関する情報をカプセル化します。
contentDetails.relatedPlaylists	object relatedPlaylists オブジェクトは、チャンネルに関連付けられている再生リスト（チャンネルのアップロード済み動画やお気に入り動画など）を特定するマップです。これらの再生リストは、いずれも playlists.list メソッドを使用して取得できます。
contentDetails.relatedPlaylists.likes	string チャンネルの高く評価された動画を含む再生リストの ID。リストのアイテムを追加または削除するには、playlistItems.insert および playlistItems.delete を使用します。
contentDetails.relatedPlaylists.favorites	string チャンネルのお気に入り動画を含む再生リストの ID。リストのアイテムを追加または削除するには、playlistItems.insert および playlistItems.delete を使用します。
contentDetails.relatedPlaylists.uploads	string チャンネルのアップロード済み動画を含む再生リストの ID。新しい動画をアップロードするには videos.insert メソッドを使用し、以前にアップロードされた動画を削除するには videos.delete メソッドを使用します。
contentDetails.relatedPlaylists.watchHistory	string チャンネルの再生履歴の ID。リストのアイテムを追加または削除するには、playlistItems.insert および playlistItems.delete を使用します。
contentDetails.relatedPlaylists.watchLater	string チャンネルの [後で見る] 再生リストの ID。リストのアイテムを追加または削除するには、playlistItems.insert および playlistItems.delete を使用します。
contentDetails.googlePlusUserId	string googlePlusUserId オブジェクトは、該当するチャンネルに関連付けられた Google+ プロフィール ID を特定します。
statistics	object statistics オブジェクトは、チャンネルの統計情報をカプセル化します。
statistics.viewCount	unsigned long チャンネルの再生回数。
statistics.commentCount	unsigned long チャンネルのコメント数。
statistics.subscriberCount	unsigned long チャンネルの登録者数。
statistics.hiddenSubscriberCount	boolean チャンネル登録者数を公開表示するかどうかを指定します。
statistics.videoCount	unsigned long チャンネルにアップロードされた動画の数。
topicDetails	object topicDetails オブジェクトは、チャンネルに関連付けられた Freebase トピックに関する情報をカプセル化します。
topicDetails.topicIds[]	list チャンネルに関連付けられた Freebase トピック ID のリスト。各トピックに関する情報は、Freebase Topic API を使用して取得できます。
status	object status オブジェクトは、チャンネルのプライバシー ステータスに関する情報をカプセル化します。
status.privacyStatus	string チャンネルのプライバシー ステータス。 このプロパティで有効な値は以下のとおりです。 private public unlisted
status.isLinked	boolean チャンネル データから、YouTube ユーザー名または Google+ アカウントのいずれかに既にリンクされているユーザーが特定されるかどうかを示します。このいずれかのリンクを持つユーザーは公開されている YouTube ID を既に持っているユーザーであり、動画のアップロードなど、いくつかの操作の前提条件となります。
brandingSettings	object brandingSettings オブジェクトは、チャンネルのブランディングに関する情報をカプセル化します。
brandingSettings.channel	object channel オブジェクトは、チャンネル ページのブランディングのプロパティをカプセル化します。
brandingSettings.channel.title	string チャンネルのタイトル。タイトルの文字数は全角 15 文字（半角 30 文字）以内です。
brandingSettings.channel.description	string チャンネルの説明。チャンネル ページのチャンネル情報ボックスに表示されます。
brandingSettings.channel.keywords	string チャンネルに関連付けられたキーワード。値はカンマで区切られた文字列のリストです。
brandingSettings.channel.defaultTab	string 視聴者がチャンネル ページにアクセスしたときにデフォルトで表示するコンテンツ タブ。
brandingSettings.channel.trackingAnalyticsAccountId	string チャンネルへのトラフィックを追跡/測定するために使用する Google Analytics アカウントの ID。
brandingSettings.channel.moderateComments	boolean チャンネル ページにユーザーが投稿したコメントを公開表示するためにチャンネル所有者の承認が必要かどうかを決定します。デフォルト値は false です。
brandingSettings.channel.showRelatedChannels	boolean YouTube のアルゴリズムによって自動的に生成された関連チャンネルのリストをチャンネル ページ上に表示するかどうかを指定します。
brandingSettings.channel.showBrowseView	boolean チャンネル ページにコンテンツを一覧ビューで表示するかフィード ビューで表示するかを指定します。たとえば一覧ビューを指定すると、アップロード済みの動画、再生リスト、高く評価した動画が個別のセクションに表示されます。フィード ビューの場合は、チャンネルのアクティビティ フィードが表示されます。
brandingSettings.channel.featuredChannelsTitle	string おすすめチャンネル モジュールの上に表示されるタイトル。
brandingSettings.channel.featuredChannelsUrls[]	list おすすめチャンネル モジュールからリンクするチャンネルのリスト（最大 16 個）。プロパティ値は YouTube チャンネル ID 値のリストです。それぞれの ID 値によって、チャンネルが一意に識別されます。
brandingSettings.channel.unsubscribedTrailer	string チャンネル登録をしていない視聴者に対して、おすすめ動画モジュール（チャンネル ページの一覧ビューに表示されます）で再生する動画。チャンネル登録済みの視聴者に対する表示はこれとは異なり、最近のチャンネル アクティビティがハイライトされます。
brandingSettings.channel.profileColor	string チャンネルのコンテンツを際立たせる色。
brandingSettings.watch	object watch オブジェクトは、チャンネルの動画再生ページのブランディング プロパティをカプセル化します。
brandingSettings.watch.textColor	string 動画再生ページのブランド領域の背景色。
brandingSettings.watch.backgroundColor	string 動画再生ページのブランド領域のテキスト色。
brandingSettings.watch.featuredPlaylistId	string 動画再生ページで動画プレーヤーの横に表示される再生リストを一意に識別する ID。
brandingSettings.image	object image オブジェクトは、チャンネルのチャンネル ページまたは動画再生ページに表示される画像に関する情報をカプセル化します。
brandingSettings.image.bannerImageUrl	string YouTube ウェブサイトのチャンネル ページに表示されるバナー画像の URL。画像は 1060px × 175px です。
brandingSettings.image.bannerMobileImageUrl	string モバイル アプリケーションのチャンネル ページに表示されるバナー画像の URL。画像は 640px × 175px です。
brandingSettings.image.backgroundImageUrl	object backgroundImageUrl オブジェクトは、動画再生ページに表示される背景画像の設定をカプセル化します。画像は 1200px × 615px で、最大ファイルサイズは 128 KB です。
brandingSettings.image.backgroundImageUrl.default	string プロパティのデフォルト値。
brandingSettings.image.backgroundImageUrl.localized[]	list プロパティの言語に固有の値を指定するオブジェクトのリスト。
brandingSettings.image.backgroundImageUrl.localized[].value	string 指定された言語のプロパティ値。
brandingSettings.image.backgroundImageUrl.localized[].language	string 値に関連付けられた言語。
brandingSettings.image.largeBrandedBannerImageImapScript	object largeBrandedBannerImageImapScript オブジェクトは、チャンネル ページ上に表示されるバナー画像のイメージ マップ スクリプトに関する情報をカプセル化します。
brandingSettings.image.largeBrandedBannerImageImapScript.default	string プロパティのデフォルト値。
brandingSettings.image.largeBrandedBannerImageImapScript.localized[]	list プロパティの言語に固有の値を指定するオブジェクトのリスト。
brandingSettings.image.largeBrandedBannerImageImapScript.localized[].value	string 指定された言語のプロパティ値。
brandingSettings.image.largeBrandedBannerImageImapScript.localized[].language	string 値に関連付けられた言語。
brandingSettings.image.largeBrandedBannerImageUrl	object 動画再生ページで動画表示を拡大した場合に、動画プレーヤーの下に表示される 854px × 70px の画像の URL。
brandingSettings.image.largeBrandedBannerImageUrl.default	string プロパティのデフォルト値。
brandingSettings.image.largeBrandedBannerImageUrl.localized[]	list プロパティの言語に固有の値を指定するオブジェクトのリスト。
brandingSettings.image.largeBrandedBannerImageUrl.localized[].value	string 指定された言語のプロパティ値。
brandingSettings.image.largeBrandedBannerImageUrl.localized[].language	string 値に関連付けられた言語。
brandingSettings.image.smallBrandedBannerImageImapScript	object 小さいバナー画像のイメージ マップ スクリプト。largeBrandedBannerImageImapScript オブジェクトは、モバイル アプリケーションのチャンネル ページ上に表示されるバナー画像のイメージ マップ スクリプトに関する情報をカプセル化します。
brandingSettings.image.smallBrandedBannerImageImapScript.default	string プロパティのデフォルト値。
brandingSettings.image.smallBrandedBannerImageImapScript.localized[]	list プロパティの言語に固有の値を指定するオブジェクトのリスト。
brandingSettings.image.smallBrandedBannerImageImapScript.localized[].value	string 指定された言語のプロパティ値。
brandingSettings.image.smallBrandedBannerImageImapScript.localized[].language	string 値に関連付けられた言語。
brandingSettings.image.smallBrandedBannerImageUrl	object 動画再生ページのデフォルト表示で、動画プレーヤーの下に表示される 640px × 70px のバナー画像の URL。
brandingSettings.image.smallBrandedBannerImageUrl.default	string プロパティのデフォルト値。
brandingSettings.image.smallBrandedBannerImageUrl.localized[]	list プロパティの言語に固有の値を指定するオブジェクトのリスト。
brandingSettings.image.smallBrandedBannerImageUrl.localized[].value	string 指定された言語のプロパティ値。
brandingSettings.image.smallBrandedBannerImageUrl.localized[].language	string 値に関連付けられた言語。
brandingSettings.image.watchIconImageUrl	string 動画プレーヤーの上に表示される画像の URL。高さは 25px ですが幅は固定ではなく、170px 以下の画像です。この画像が提供されていない場合は、画像の代わりにチャンネル名が表示されます。
brandingSettings.image.trackingImageUrl	string チャンネルまたは動画ページの再生回数に関する統計情報を収集するために使用する 1px × 1px のトラッキング ピクセルの URL。
brandingSettings.image.bannerTabletLowImageUrl	string タブレット アプリケーションのチャンネル ページ上に表示される低解像度のバナー画像の URL。画像は 1138px × 188px です。
brandingSettings.image.bannerTabletImageUrl	string タブレット アプリケーションのチャンネル ページ上に表示されるバナー画像の URL。画像は 1707px × 283px です。
brandingSettings.image.bannerTabletHdImageUrl	string タブレット アプリケーションのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像は 2276px × 377px です。
brandingSettings.image.bannerTabletExtraHdImageUrl	string タブレット アプリケーションのチャンネル ページ上に表示される超高解像度のバナー画像の URL。画像は 2560px × 424px です。
brandingSettings.image.bannerMobileLowImageUrl	string モバイル アプリケーションのチャンネル ページ上に表示される低解像度のバナー画像の URL。画像は 320px × 88px です。
brandingSettings.image.bannerMobileMediumHdImageUrl	string モバイル アプリケーションのチャンネル ページ上に表示される中解像度のバナー画像の URL。画像は 960px × 263px です。
brandingSettings.image.bannerMobileHdImageUrl	string モバイル アプリケーションのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像は 1280px × 360px です。
brandingSettings.image.bannerMobileExtraHdImageUrl	string モバイル アプリケーションのチャンネル ページ上に表示される超高解像度のバナー画像の URL。画像は 1440px × 395px です。
brandingSettings.image.bannerTvImageUrl	string テレビ アプリケーションのチャンネル ページ上に表示されるバナー画像の URL。画像は 2120px × 1192px です。
brandingSettings.image.bannerExternalUrl	string 注: このプロパティは channels.update リクエストのみで使用されます。 このプロパティでは、チャンネルに合わせてさまざまなサイズのバナー画像を生成するために YouTube が使用するバナー画像の場所を指定します。バナー画像の外部 URL を取得するには、まず channelBanners.insert メソッドを呼び出すことで、使用するチャンネル バナーの画像をアップロードする必要があります。
brandingSettings.hints[]	list hints オブジェクトは、その他のブランディング プロパティをカプセル化します。
brandingSettings.hints[].property	string プロパティ。
brandingSettings.hints[].value	string プロパティの値。
invideoPromotion	object invideoPromotion オブジェクトは、チャンネルに関連付けられているプロモーション キャンペーンに関する情報をカプセル化します。チャンネルでは動画内プロモーション キャンペーンを使用し、チャンネルの動画が再生されている間は動画プレーヤーにプロモート動画のサムネイル画像を表示しておくことができます。
invideoPromotion.defaultTiming	object defaultTiming オブジェクトでは、チャンネルでの動画の再生中にプロモート アイテムを表示する時期のデフォルト設定を指定します。任意のプロモート アイテム用により具体的な timing 設定を指定する場合は、このデフォルト設定を上書きすることができます。
invideoPromotion.defaultTiming.type	string 動画の再生中にプロモート アイテムを挿入するタイミングを決定するタイミング メソッド。値が offsetFromStart の場合、offsetMs フィールドは、動画の先頭からのオフセットを表します。値が offsetFromEnd の場合、offsetMs フィールドは動画の末尾からのオフセットを表します。
invideoPromotion.defaultTiming.offsetMs	unsigned long 動画の再生中にプロモート アイテムが表示されるタイミングを決定するタイム オフセット。ミリ秒単位で指定します。type プロパティの値により、オフセットを動画の先頭と末尾のどちらから測定するかが決定されます。
invideoPromotion.defaultTiming.durationMs	unsigned long プロモーションの表示時間をミリ秒単位で定義します。定義されていない場合、クライアントではデフォルトが使用されます。
invideoPromotion.position	object position オブジェクトは、プロモート アイテムが表示される動画内の空間的な位置に関する情報をカプセル化します。
invideoPromotion.position.type	string 動画プレーヤーにプロモート アイテムを配置する方法。 このプロパティで有効な値は以下のとおりです。 corner
invideoPromotion.position.cornerPosition	string プロモート アイテムが表示されるプレーヤーのコーナー。 このプロパティで有効な値は以下のとおりです。 bottomLeft bottomRight topLeft topRight
invideoPromotion.items[]	list 同じ視聴者に対する別の再生時に表示される順序でプロモート アイテムを並べたリスト。
invideoPromotion.items[].id	object プロモート アイテムを指定します。
invideoPromotion.items[].id.type	string プロモート アイテムのタイプ。 このプロパティで有効な値は以下のとおりです。 video website
invideoPromotion.items[].id.videoId	string この値は、プロモート アイテムが動画である場合に使用され、その動画に割り当てられている YouTube ID を指定します。このフィールドは、type プロパティの値が video である場合のみ存在します。
invideoPromotion.items[].id.websiteUrl	string プロモート アイテムがウェブサイトである場合、このフィールドは該当するウェブサイトを参照する URL を表します。このフィールドは、type の値が website である場合のみ存在します。 関連ウェブサイト、商用サイト、ソーシャル ネットワーク サイトなどをリンクできます。コンテンツのリンクを有効化する方法の詳細については、YouTube ヘルプセンターの関連ウェブサイトおよび商用サイトの説明をご覧ください。 ユーザーは、プロモーション リンクを追加することによって、これらのリンクが未承認サイトへのトラフィックのリダイレクトを目的としないこと、ならびに AdWords のポリシー、YouTube の広告ポリシー、YouTube コミュニティ ガイドライン、および YouTube 利用規約を遵守することに同意するものとします。
invideoPromotion.items[].timing	object 動画の再生中にプロモート アイテムを表示するタイミング。これらのタイミング設定は、デフォルトのタイミング設定よりも優先されます。
invideoPromotion.items[].timing.type	string 動画の再生中にプロモート アイテムを挿入するタイミングを決定するタイミング メソッド。値が offsetFromStart の場合、offsetMs フィールドは、動画の先頭からのオフセットを表します。値が offsetFromEnd の場合、offsetMs フィールドは動画の末尾からのオフセットを表します。
invideoPromotion.items[].timing.offsetMs	unsigned long 動画の再生中にプロモート アイテムが表示されるタイミングを決定するタイム オフセット。ミリ秒単位で指定します。type プロパティの値により、オフセットを動画の先頭と末尾のどちらから測定するかが決定されます。
invideoPromotion.items[].timing.durationMs	unsigned long プロモーションの表示時間をミリ秒単位で定義します。定義されていない場合、クライアントではデフォルトが使用されます。
invideoPromotion.items[].customMessage	string このプロモーション用に表示するカスタム メッセージ。現時点では、プロモート アイテムがウェブサイトでない限り、このフィールドは無視されます。