回應物件和錯誤

本頁面說明 Tenor API 使用的不同 JSON 回應和錯誤物件。

回應物件

下表提供 Response 物件屬性的詳細資料:

屬性
created

float

代表建立這篇文章的 Unix 時間戳記。

hasaudio

boolean

如果這篇文章包含音訊,則傳回「true」。

id

string

Tenor 結果 ID

media_formats

{ CONTENT_FORMAT : MEDIA_OBJECT }

內容格式做為索引鍵,以及媒體物件為值的字典。

tags

string[]

貼文的標記陣列

title

string

訊息標題

content_description

string

內容的文字說明。

建議您使用 content_description 提供使用者無障礙功能。

itemurl

string

查看 tenor.com 上貼文的完整網址。

hascaption

boolean

如果這篇文章含有字幕,則傳回「true」。

flags

string

以半形逗號分隔的清單,用於說明內容是貼圖或靜態圖片、音訊是否有音效,或兩者的任意組合。如果沒有 stickerstatic,則內容是 GIF。空白的 flags 欄位代表沒有音訊的 GIF。

bg_color

string

最常見的內容背景像素顏色

url

string

查看 tenor.com 貼文的短網址。

類別物件

下表提供「類別物件」屬性的詳細資料:

屬性
searchterm

string

與類別對應的搜尋字詞。系統會轉譯搜尋字詞,以符合相應要求的 locale

path

string

使用者選取類別時要要求搜尋的網址

image

string

該類別範例 GIF 的媒體來源網址

name

string

與圖片重疊的類別名稱。名稱會轉譯為相應要求的 locale

媒體物件

下表提供媒體物件屬性的詳細資料:

屬性
url

string

媒體來源的網址

dims

int[]

媒體的寬度和高度 (以像素為單位)

duration

float

代表內容其中一個迴圈的時間 (以秒為單位)。如果內容為靜態,則會將時間長度設為 0

size

int

檔案大小,以位元組為單位

內容格式

Tenor 的 API 提供下列五種基本格式,各種不同的大小:

  • GIF
  • MP4
  • WebM
  • 透明的 WebP
  • 透明 GIF

MP4 和 WebM 格式只會播放一次音訊,但 loopedmp4 除外,該片段會播放多次。GIF 格式會在連續迴圈中播放其片段。透明格式適用於貼圖內容,不適用於 GIF 搜尋結果。

格式類型

以下表格詳細說明 Tenor 的可用媒體格式類型:

格式類型
preview
  • 解析度和尺寸:高品質的單一影格 GIF 格式;小於 GIF 格式
  • 尺寸:原始上傳尺寸 (無限制)
  • 使用附註:讓這個畫面的第一個頁框顯示。這個選項只能當做縮圖預覽使用。

此格式支援 GIF 和貼圖。

gif
  • 解析度和尺寸:高畫質 GIF 格式;提供最大的檔案大小
  • 尺寸:原始上傳尺寸 (無限制)
  • 使用附註:如要在電腦上分享 GIF 時,請使用這個大小。

此格式支援 GIF 和貼圖。

mediumgif
  • 解析度和尺寸:GIF 格式的縮小
  • 尺寸:原始上傳尺寸 (無限制),但壓縮率較高
  • 使用注意事項:在電腦上預覽 GIF 時,請使用這個大小。

此格式支援 GIF 和貼圖。

tinygif
  • 解析度和尺寸:GIF 格式的縮減大小
  • 尺寸:寬度最高可達 220 像素。為配合長寬比而縮放高度。
  • 使用注意事項:如要預覽 GIF 和分享內容,請使用這個大小。

此格式支援 GIF 和貼圖。

nanogif
  • 解析度和尺寸:GIF 格式的最小尺寸
  • 尺寸:最高可達 90 像素。已調整寬度,保留長寬比。
  • 使用注意事項:在行動裝置上執行 GIF 預覽時,請使用這個尺寸。

此格式支援 GIF 和貼圖。

mp4
  • 解析度和尺寸:最高品質的影片格式;最大的影片格式,但小於 GIF
  • 尺寸:與 GIF 類似,但為了符合影片容器規格而填充,通常是 8 像素的遞增。
  • 使用注意事項:如果應用程式要使用 MP4 預先發布版和共享功能,請使用這個大小。

此格式支援 GIF 和貼圖。

loopedmp4
  • 解析度和尺寸:高畫質影片格式;大於 MP4
  • 尺寸:與 GIF 類似,但為了符合影片容器規格而填充,通常是 8 像素的遞增。
  • 使用注意事項:如果您希望影片片段執行數次,而非僅執行一次,請在 MP4 分享這個大小。

此格式支援 GIF 和貼圖。

tinymp4
  • 解析度和尺寸:縮減 MP4 格式的尺寸
  • 尺寸:變數寬度和高度,上限為 320x320 像素的定界框
  • 使用注意事項:如果應用程式使用 MP4 預覽和分享等功能,請使用這個大小。

此格式支援 GIF 和貼圖。

nanomp4
  • 解析度和尺寸:MP4 格式的最小尺寸
  • 尺寸:可變寬度和高度,上限為 150x150 像素
  • 使用注意事項:在行動裝置上執行 MP4 預覽時使用此大小。

此格式支援 GIF 和貼圖。

webm
  • 解析度和尺寸:畫質較低的影片格式;小於 MP4
  • 尺寸:與 GIF 類似,但為了符合影片容器規格而填充,通常是 8 像素的遞增。
  • 使用注意事項:這個大小只能用於 WebM 預覽和在電腦上分享。

此格式支援 GIF 和貼圖。

tinywebm
  • 解析度和尺寸:縮減 WebM 格式的尺寸
  • 尺寸:可變寬度和高度,上限為 320x320 像素的定界框
  • 使用附註:如要在行動裝置上使用 GIF 分享,請使用這個大小。

此格式支援 GIF 和貼圖。

nanowebm
  • 解析度和尺寸:WebM 格式的最小尺寸
  • 尺寸:可變寬度和高度,上限為 150 x 150 像素的定界框
  • 使用注意事項:在行動裝置上執行 GIF 預覽時,請使用這個尺寸。

此格式支援 GIF 和貼圖。

webp_transparent
  • 解析度和尺寸:高品質的 WebP 貼圖格式;可用檔案大小上限
  • 尺寸:原始上傳尺寸 (無限制)
  • 使用附註:這個尺寸適用於高頻寬使用者的貼圖分享區。

這個格式支援貼圖格式。

tinywebp_transparent
  • 解析度和尺寸:縮減 WebP 貼圖格式;大小上限為 500 KB
  • 尺寸:最高可達 220x220 像素,高度經過縮放以維持長寬比。
  • 使用注意事項:這個頻寬預覽適用於高頻寬使用者,方便低頻寬使用者分享。

這個格式支援貼圖格式。

nanowebp_transparent
  • 解析度和尺寸:WebP 貼圖格式的最小尺寸;最大 100 KB
  • 尺寸:最高可達 90x90 像素,寬度經過調整以維持長寬比。
  • 使用附註:這個大小可用於低頻寬使用者的貼圖預覽。

這個格式支援貼圖格式。

gif_transparent
  • 解析度和尺寸:高畫質 GIF 貼圖格式;可用檔案大小上限
  • 尺寸:原始上傳尺寸 (無限制)
  • 使用附註:這個尺寸適用於高頻寬使用者的貼圖分享區。

這個格式支援貼圖格式。

tinygif_transparent
  • 解析度和尺寸:GIF 貼圖格式縮減;大小上限 500 KB
  • 尺寸:最高可達 220x220 像素,高度可按比例調整,以維持長寬比。
  • 使用注意事項:這個頻寬預覽適用於高頻寬使用者,方便低頻寬使用者分享。

這個格式支援貼圖格式。

nanogif_transparent
  • 解析度和尺寸:GIF 貼圖格式的最小尺寸;大小上限為 100 KB
  • 尺寸:最高可達 90x90 像素,寬度經過調整以維持長寬比。
  • 使用附註:這個大小可用於低頻寬使用者的貼圖預覽。

這個格式支援貼圖。

最佳做法

  • 如果是行動裝置,請使用 Nano 或小尺寸檔案以預覽,而迷你檔案則可用於分享。
  • media_filter 參數設為您要使用的格式。可將 API 回應大小縮減 70%。

格式大小

每種內容格式的檔案大小取決於所選 GIF 的尺寸和長度。因此,請將下表中的方法和媒介視為一般準則,而非硬性值。

檔案格式 平均檔案大小 (KB) 檔案大小中位數 (KB)
gif 3,356 人 956
mediumgif 2,548 人 574
tinygif 521 101
nanogif 175 56
mp4 207 91
loopedmp4 515 228
tinymp4 84 81
nanomp4 37 28
webm 76 61
tinywebm 57 45
nanowebm 35 25
webp_transparent 530 95
tinywebp_transparent 249 60
nanowebp_transparent 107 25
gif_transparent 643 35
tinygif_transparent 349 20
nanogif_transparent 116 10

回應碼

下表提供用於表示成功要求的 HTTP 狀態回應代碼:

HTTP 狀態碼
200202 普通

錯誤

Tenor 的 API 會傳回以下錯誤:HTTP 回應代碼 4xx5xx,以及標準 Google API 錯誤格式。詳情請參閱「錯誤」一節。