ออบเจ็กต์การตอบกลับและข้อผิดพลาด

หน้านี้ให้ข้อมูลเกี่ยวกับออบเจ็กต์การตอบสนองและข้อผิดพลาดของ JSON ต่างๆ ที่ Tenor API ใช้

ออบเจ็กต์การตอบกลับ

ตารางต่อไปนี้แสดงรายละเอียดพร็อพเพอร์ตี้สำหรับออบเจ็กต์การตอบกลับ

พร็อพเพอร์ตี้
created	float การประทับเวลา Unix ที่แสดงเวลาที่สร้างโพสต์นี้
hasaudio	boolean แสดง true หากโพสต์นี้มีเสียง หมายเหตุ: เฉพาะรูปแบบวิดีโอเท่านั้นที่รองรับเสียง รูปแบบไฟล์ภาพ GIF ไม่มีข้อมูลเสียง
id	string ตัวระบุผลลัพธ์ของ Tenor
media_formats	{ CONTENT_FORMAT : MEDIA_OBJECT } พจนานุกรมที่มีรูปแบบเนื้อหาเป็นคีย์ และออบเจ็กต์สื่อเป็นค่า
tags	string[] อาร์เรย์ของแท็กสำหรับโพสต์
title	string ชื่อโพสต์
content_description	string คำอธิบายที่เป็นข้อความของเนื้อหา เราขอแนะนำให้คุณใช้ content_description สำหรับฟีเจอร์การช่วยเหลือพิเศษ ของผู้ใช้
itemurl	string URL แบบเต็มเพื่อดูโพสต์ใน tenor.com
hascaption	boolean แสดง true หากโพสต์นี้มีคำบรรยายแทนเสียง
flags	string รายการที่คั่นด้วยคอมมาเพื่อระบุว่าเนื้อหาเป็นสติกเกอร์หรือภาพนิ่ง มีเสียง หรือเป็นส่วนผสมของรายการเหล่านี้ หากไม่มี sticker และ static แสดงว่าเนื้อหาเป็น GIF ฟิลด์ flags ที่ว่างเปล่าหมายถึง GIF ที่ไม่มีเสียง
bg_color	string สีพิกเซลพื้นหลังที่พบบ่อยที่สุดของเนื้อหา
url	string URL แบบสั้นเพื่อดูโพสต์บน tenor.com

ออบเจ็กต์หมวดหมู่

ตารางต่อไปนี้แสดงรายละเอียดเกี่ยวกับพร็อพเพอร์ตี้สำหรับออบเจ็กต์หมวดหมู่

พร็อพเพอร์ตี้
searchterm	string ข้อความค้นหาที่สอดคล้องกับหมวดหมู่ ระบบจะแปลข้อความค้นหาให้ตรงกับlocaleของคำขอที่เกี่ยวข้อง
path	string URL การค้นหาที่จะขอหากผู้ใช้เลือกหมวดหมู่
image	string URL ของแหล่งที่มาของสื่อสำหรับ GIF ตัวอย่างของหมวดหมู่
name	string ชื่อหมวดหมู่ที่จะซ้อนทับบนรูปภาพ ชื่อจะได้รับการแปลให้ตรงกับ locale ของคำขอที่เกี่ยวข้อง

ออบเจ็กต์สื่อ

ตารางต่อไปนี้แสดงรายละเอียดเกี่ยวกับพร็อพเพอร์ตี้สำหรับออบเจ็กต์สื่อ

พร็อพเพอร์ตี้
url	string URL ของแหล่งที่มาของสื่อ
dims	int[] ความกว้างและความสูงของสื่อในหน่วยพิกเซล
duration	float แสดงเวลาเป็นวินาทีสำหรับเนื้อหา 1 ลูป หากเนื้อหาเป็นแบบคงที่ ระบบจะตั้งค่า ระยะเวลาเป็น 0
size	int ขนาดของไฟล์ในหน่วยไบต์

รูปแบบเนื้อหา

API ของ Tenor มีรูปแบบพื้นฐาน 5 รูปแบบต่อไปนี้ในขนาดต่างๆ

• GIF
• MP4
• WebM
• WebP แบบโปร่งใส
• GIF แบบโปร่งใส

รูปแบบ MP4 และ WebM จะเล่นคลิปเพียงครั้งเดียว ยกเว้น loopedmp4 ซึ่งจะเล่นคลิป 2-3 ครั้ง รูปแบบ 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 เมื่อต้องการให้วิดีโอคลิปเล่น 2-3 ครั้งแทนที่จะเล่นเพียงครั้งเดียว รูปแบบนี้รองรับ GIF และสติกเกอร์
tinymp4	ความละเอียดและขนาด: ขนาดที่ลดลงของรูปแบบ MP4 ขนาด: ความกว้างและความสูงเปลี่ยนแปลงได้ โดยมีกรอบล้อมรอบสูงสุดขนาด 320x320 พิกเซล หมายเหตุการใช้งาน: ใช้ขนาดนี้สำหรับการแสดงตัวอย่างและการแชร์ MP4 บนอุปกรณ์เคลื่อนที่ รูปแบบนี้รองรับ GIF และสติกเกอร์
nanomp4	ความละเอียดและขนาด: ขนาดเล็กที่สุดของรูปแบบ MP4 ขนาด: ความกว้างและความสูงที่เปลี่ยนแปลงได้ โดยมีกรอบล้อมรอบสูงสุดที่ 150x150 พิกเซล หมายเหตุการใช้งาน: ใช้ขนาดนี้สำหรับตัวอย่าง MP4 บนอุปกรณ์เคลื่อนที่ รูปแบบนี้รองรับ GIF และสติกเกอร์
webm	ความละเอียดและขนาด: รูปแบบวิดีโอคุณภาพต่ำกว่า มีขนาดเล็กกว่า MP4 ขนาด: คล้ายกับ GIF แต่มีการเพิ่มระยะขอบให้พอดีกับข้อกำหนดของคอนเทนเนอร์วิดีโอ ซึ่งมักจะเพิ่มทีละ 8 พิกเซล หมายเหตุการใช้งาน: ใช้ขนาดนี้สำหรับการแสดงตัวอย่างและแชร์ WebM บนเดสก์ท็อป รูปแบบนี้รองรับ GIF และสติกเกอร์
tinywebm	ความละเอียดและขนาด: รูปแบบ WebM ที่มีขนาดเล็กลง ขนาด: ความกว้างและความสูงที่เปลี่ยนแปลงได้ โดยมีกรอบล้อมรอบสูงสุดขนาด 320x320 พิกเซล หมายเหตุการใช้งาน: ใช้ขนาดนี้สำหรับการแชร์ GIF บนอุปกรณ์เคลื่อนที่ รูปแบบนี้รองรับ GIF และสติกเกอร์
nanowebm	ความละเอียดและขนาด: ขนาดเล็กที่สุดของรูปแบบ WebM ขนาด: ความกว้างและความสูงที่เปลี่ยนแปลงได้ โดยมีกรอบล้อมรอบสูงสุดที่ 150x150 พิกเซล หมายเหตุการใช้งาน: ใช้ขนาดนี้สําหรับตัวอย่าง 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 พิกเซล โดยจะปรับขนาดความกว้างเพื่อรักษาอัตราส่วน ไว้ หมายเหตุการใช้งาน: ใช้ขนาดนี้สำหรับตัวอย่างสติกเกอร์สำหรับผู้ใช้ที่มีแบนด์วิดท์ต่ำ สติกเกอร์รองรับรูปแบบนี้

แนวทางปฏิบัติแนะนำ

• สำหรับอุปกรณ์เคลื่อนที่ ให้ใช้ไฟล์ขนาดเล็กมากหรือเล็กสำหรับการแสดงตัวอย่าง และใช้ไฟล์ขนาดเล็กสำหรับการแชร์
• ตั้งค่าพารามิเตอร์ 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
200 หรือ 202	ตกลงหรือยอมรับ

ข้อผิดพลาด

API ของ Tenor จะแสดงข้อผิดพลาดพร้อมรหัสการตอบกลับ HTTP 4xx หรือ 5xx และในรูปแบบข้อผิดพลาดของ Google API มาตรฐาน โปรดดูรายละเอียดที่หัวข้อ ข้อผิดพลาด