FanFundingEvents

注意:這是淘汰公告內容。

粉絲贊助功能已淘汰,2017 年 2 月 28 日 Fan Fund API 也將停用。這項淘汰公告與 YouTube 新推出的超級留言功能相輔相成。

fanFundingEvent 資源代表 YouTube 頻道上的粉絲贊助活動。粉絲贊助功能可以為 YouTube 創作者提供營利支援。使用者針對頻道進行一次性自費付款時,就會發生支持者贊助事件。如要進一步瞭解粉絲贊助,請造訪 YouTube 說明中心

方法

這個 API 支援下列 fanFundingEvents 資源的方法:

list
列出頻道的支持者贊助活動。API 要求必須獲得頻道擁有者的授權。立即試用

資源表示法

以下 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
支持者頻道的網址。
snippet.supporterDetails.displayName string
支持者頻道的顯示名稱。
snippet.supporterDetails.profileImageUrl string
支持者頻道的顯示圖片網址。
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$