レスポンス オブジェクトとエラー

このページでは、Tenor API で使用されるさまざまな JSON レスポンス オブジェクトとエラー オブジェクトについて説明します。

レスポンス オブジェクト

次の表に、レスポンス オブジェクトのプロパティの詳細を示します。

プロパティ
created

float

この投稿が作成された日時を表す Unix タイムスタンプ。
hasaudio

boolean

この投稿に音声が含まれている場合は true を返します。
id

string

テナー結果識別子
media_formats

{ CONTENT_FORMAT : MEDIA_OBJECT }

キーがコンテンツ形式で、値がメディア オブジェクトの辞書。
tags

string[]

投稿のタグの配列
title

string

投稿のタイトル
content_description

string

コンテンツのテキストによる説明。

ユーザー補助機能には content_description を使用することをおすすめします。
itemurl

string

tenor.com で投稿を表示するための完全な URL。
hascaption

boolean

この投稿にキャプションが含まれている場合は true を返します。
flags

string

コンテンツがステッカーか静止画像か、音声があるか、またはこれらの組み合わせであるかを示すカンマ区切りリスト。sticker と static が存在しない場合、コンテンツは GIF です。flags フィールドが空白の場合、音声のない GIF を意味します。
bg_color

string

コンテンツの最も一般的な背景ピクセル色
url

string

tenor.com で投稿を表示するための短縮 URL。

カテゴリ オブジェクト

次の表に、カテゴリ オブジェクトのプロパティの詳細を示します。

プロパティ
searchterm

string

カテゴリに対応する検索語句。検索語句は、対応するリクエストの locale に一致するように変換されます。
path

string

ユーザーがカテゴリを選択した場合にリクエストする検索 URL
image

string

カテゴリの GIF の例のメディアソースの URL
name

string

画像にオーバーレイするカテゴリ名。名前は、対応するリクエストの locale に一致するように変換されます。

メディア オブジェクト

次の表に、メディア オブジェクトのプロパティの詳細を示します。

プロパティ
url

string

メディアソースの URL
dims

int[]

メディアの幅と高さ（ピクセル単位）
duration

float

コンテンツの 1 回のループの時間を秒単位で表します。コンテンツが静的の場合、期間は 0 に設定されます。
size

int

ファイルのサイズ（バイト単位）

コンテンツの形式

Tenor の API は、次の 5 つの基本形式をさまざまなサイズで提供しています。

  • GIF
  • MP4
  • WebM
  • 透過 WebP
  • 透明 GIF

MP4 形式と WebM 形式では、クリップは 1 回のみ再生されます。ただし、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 ピクセル単位の動画コンテナの仕様に合わせてパディングされます。
  • 使用上の注意: 動画クリップを 1 回だけでなく数回実行する場合は、MP4 の共有にこのサイズを使用します。

この形式は GIF とステッカーでサポートされています。
tinymp4
  • 解像度とサイズ: MP4 形式のサイズを縮小
  • サイズ: 幅と高さは可変。境界ボックスの最大サイズは 320×320 ピクセル
  • 使用上の注意: モバイルでの MP4 のプレビューと共有には、このサイズを使用します。

この形式は GIF とステッカーでサポートされています。
nanomp4
  • 解像度とサイズ: MP4 形式の最小サイズ
  • サイズ: 幅と高さは可変。境界ボックスの最大サイズは 150×150 ピクセル
  • 使用上の注意: モバイルでの MP4 プレビューにはこのサイズを使用します。

この形式は GIF とステッカーでサポートされています。
webm
  • 解像度とサイズ: 画質の低い動画形式。MP4 よりもサイズが小さい
  • ディメンション: GIF と同様ですが、通常 8 ピクセル単位の動画コンテナの仕様に合わせてパディングされます。
  • 使用上の注意: パソコンでの WebM のプレビューと共有には、このサイズを使用します。

この形式は GIF とステッカーでサポートされています。
tinywebm
  • 解像度とサイズ: WebM 形式のサイズを縮小
  • サイズ: 幅と高さは可変。境界ボックスの最大サイズは 320×320 ピクセル
  • 使用上の注意: モバイルで GIF を共有する場合は、このサイズを使用します。

この形式は GIF とステッカーでサポートされています。
nanowebm
  • 解像度とサイズ: WebM 形式の最小サイズ
  • サイズ: 幅と高さは可変。境界ボックスの最大サイズは 150×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 サイズまたは tiny サイズのファイルを使用し、共有に tiny サイズのファイルを使用します。
  • 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 OK または accepted

エラー

Tenor の API は、HTTP レスポンス コード 4xx または 5xx と標準の Google API エラー形式でエラーを返します。詳しくは、エラーをご覧ください。