注: これはサポート終了のお知らせです。
視聴者ファンディング機能は非推奨となり、2017 年 2 月 28 日に提供が終了します。このサポート終了は、YouTube の新機能である Super Chat のリリースと同時に行われます。
視聴者ファンディング機能は非推奨となり、2017 年 2 月 28 日に提供が終了します。このサポート終了は、YouTube の新機能である Super Chat のリリースと同時に行われます。
fanFundingEvent
リソースは、YouTube チャンネルの視聴者ファンディング イベントを表します。視聴者ファンディングは、YouTube クリエイターに金銭的な支援を行うための手段です。視聴者ファンディング イベントは、ユーザーが 1 回限りの自発的な支払いをチャンネルに対して行うと発生します。視聴者ファンディングについて詳しくは、YouTube ヘルプセンターをご覧ください。
Methods
API は、fanFundingEvents
リソースについて次のメソッドをサポートしています。
リソース表現
次の JSON 構造は、fanFundingEvents
リソースの形式を示しています。
{ "kind": "youtube#fanFundingEvent", "etag": etag, "id": string, "snippet": { "channelId": string, "supporterDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "commentText": string, "createdAt": datetime, "amountMicros": unsigned long, "currency": string, "displayString": string } }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
kind |
string API リソースのタイプを識別します。値は youtube#fanFundingEvent です。 |
etag |
etag このリソースの Etag。 |
id |
string 視聴者ファンディング イベントを一意に識別するために YouTube が割り当てる ID。 |
snippet |
object snippet オブジェクトには、視聴者ファンディング イベントに関する情報が含まれています。 |
snippet.channelId |
string ファンディングを受け取ったチャンネルの ID。 |
snippet.supporterDetails |
object サポーター チャンネルの詳細。このオブジェクトは、サポーターがファンディング イベントを公開した場合にのみ存在します。 |
snippet.supporterDetails.channelId |
string ユーザーの YouTube チャンネル ID。 |
snippet.supporterDetails.channelUrl |
string サポーター チャンネルの URL。 |
snippet.supporterDetails.displayName |
string サポーターズ チャンネルの表示名。 |
snippet.supporterDetails.profileImageUrl |
string 支援者のチャンネルのアバター URL。 |
snippet.commentText |
string サポーターのコメントのテキスト コンテンツ。 |
snippet.createdAt |
datetime 出資の日時。値は ISO 8601( YYYY-MM-DDThh:mm:ss.sZ )形式で指定します。 |
snippet.amountMicros |
unsigned long ファンディング イベントに貢献した金額。価値は資金通貨のマイクロ単位です。たとえば、フォンダーが 1 ドル(1 ドル)を提供する場合、 snippet.amountMicros プロパティ値は 1000000 です。 |
snippet.currency |
string 資金提供額に関連付けられている通貨。値は ISO 4217 の通貨コードです。 |
snippet.displayString |
string ファンドの金額と通貨を示す文字列(表示用)。 fanFundingEvents.list リクエストで hl パラメータを使用してアプリケーション言語を指定した場合、ディスプレイ文字列は、その言語での表示用にローカライズされます。たとえば、英語の場合は通貨が $1.50 、フランス語の場合は 1,50$ と表示されます。 |