回應物件和錯誤

本頁說明 Tenor API 使用的各種 JSON 回應和錯誤物件。

回應物件

下表詳細說明回應物件的屬性:

屬性
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 格式的最小尺寸
  • 尺寸:寬度和高度可變動,但定界框最大為 150 x 150 像素
  • 使用注意事項:在行動裝置上預覽 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
  • 尺寸:寬度最多 90 像素,系統會縮放寬度以維持長寬比。
  • 使用注意事項:為頻寬較低的使用者提供貼紙預覽畫面時,請使用這個大小。

貼紙支援這種格式。

gif_transparent
  • 解析度和大小:高品質 GIF 貼圖格式;檔案大小上限
  • 尺寸:原始上傳尺寸 (無限制)
  • 使用注意事項:如果使用者頻寬較高,請使用這個大小分享貼紙。

貼紙支援這種格式。

tinygif_transparent
  • 解析度和大小:縮減 GIF 貼圖格式的大小,上限為 500 KB
  • 尺寸:最多 220x220 像素,高度會經過縮放,以維持長寬比。
  • 使用注意事項:高頻寬使用者可使用這個大小的貼紙預覽畫面,低頻寬使用者則可使用這個大小的分享畫面。

貼紙支援這種格式。

nanogif_transparent
  • 解析度和大小:GIF 貼圖格式的最小大小;最大大小為 100 KB
  • 尺寸:寬度最多 90 像素,系統會縮放寬度以維持長寬比。
  • 使用注意事項:為頻寬較低的使用者提供貼紙預覽畫面時,請使用這個大小。

貼紙支援此格式。

最佳做法

  • 如果是行動裝置,請使用 nano 或 tiny 大小的檔案進行預覽,並使用 tiny 大小的檔案進行分享。
  • media_filter 參數設為您要使用的格式。這可減少 70% 的 API 回應大小。

格式大小

每個內容格式的檔案大小取決於所選 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 OK 或接受

錯誤

Tenor 的 API 會以 HTTP 回應碼 4xx5xx 傳回錯誤,並採用標準 Google API 錯誤格式。詳情請參閱「錯誤」。