端点

此页面提供有关通过 Tenor API 提供的每个端点的信息。对于每个端点，此页面都会提供以下信息：

  • 要使用的基本网址
  • 应遵循的最佳实践
  • 可用参数
  • 回答格式
  • 每种语言的示例请求
https://tenor.googleapis.com/v2/search?<parameters>

获取一个 JSON 对象，其中包含与一组给定的搜索字词、类别、表情符号或这些元素的任意组合最相关的 GIF 列表。

如果您在请求中添加网址参数 searchfilter=sticker，Tenor 的搜索端点会返回贴纸而不是 GIF。贴纸搜索响应中的响应对象在 media_formats 字段下包含透明格式。

如需以随机顺序返回结果，而不是按相关性排序，请添加网址参数 random=true。

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 提供用户输入的搜索内容，包括标点符号和特殊字符。
  • 当用户决定要分享哪个 GIF 或贴纸时，我们建议您同时包含对 Register Share 端点的相应调用。 此可选调用有助于 Tenor 的搜索引擎 AI 调整其结果。
  • 如需控制返回的 GIF 的数量和流量，请使用 limit 和 pos 参数。例如，您可以为用户的初始搜索结果设置 limit = 10，并加载这些 GIF 的预览供用户浏览。如果用户请求更多结果，请通过发出相同的 API 调用来收集接下来的 10 个结果，但要将 pos 设置为初始响应中 next 字段的值。您可以使用此模式来创建流畅的延迟加载体验。这有助于减少带宽用量，并缩短用户响应时间，因为客户端需要并行加载的 GIF 预览数量更少。
  • 如需保留返回的 GIF 的内部内容安全评分，请使用 ContentFilter 参数。默认值为 off。
  • 如需减少返回的内容格式数量，请使用 media_filter 参数。 这可将响应对象的大小缩减 70% 以上。

下表详细介绍了 Search 端点的参数：

参数

下表详细介绍了 Search 端点的响应格式：

键

Curl

/* search for excited top 8 GIFs */
curl "https://tenor.googleapis.com/v2/search?q=excited&key=API_KEY&client_key=my_test_app&limit=8"

Python

# set the apikey and limit
apikey = "API_KEY"  # click to set to your apikey
lmt = 8
ckey = "my_test_app"  # set the client_key for the integration and use the same value for all API calls

# our test search
search_term = "excited"

# get the top 8 GIFs for the search term
r = requests.get(
    "https://tenor.googleapis.com/v2/search?q=%s&key=%s&client_key=%s&limit=%s" % (search_term, apikey, ckey,  lmt))

if r.status_code == 200:
    # load the GIFs using the urls for the smaller GIF sizes
    top_8gifs = json.loads(r.content)
    print(top_8gifs)
else:
    top_8gifs = None

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app"
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                final String searchTerm = "excited";

                // make initial search request for the first 8 items
                JSONObject searchResult = getSearchResults(searchTerm, 8);

                // load the results for the user
                Log.v(LogTag, "Search Results: " + searchResult.toString());

            }
        }.start();
    }

    /**
     * Get Search Result GIFs
     */
    public static JSONObject getSearchResults(String searchTerm, int limit) {

        // make search request - using default locale of EN_US

        final String url = String.format("https://tenor.googleapis.com/v2/search?q=%1$s&key=%2$s&client_key=%3$s&limit=%4$s",
                searchTerm, API_KEY, CLIENT_KEY, limit);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web request to retrieve the top GIFs returned (in batches of 8) for the given search term.
   */
  func requestData()
  {
    // the test search term
    let searchTerm = "excited"

    // Define the results upper limit
    let limit = 8

    // make initial search request for the first 8 items
    let searchRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/search?q=%@&key=%@&client_key=%@&limit=%d",
                                                             searchTerm,
                                                             apikey,
                                                             clientkey,
                                                             limit))!)

    makeWebRequest(urlRequest: searchRequest, callback: tenorSearchHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for search requests.
   */
  func tenorSearchHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let responseGifs = response["results"]!

    // Load the GIFs into your view
    print("Result GIFS: (responseGifs)")

  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for the top 8 GIFs of search
function tenorCallback_search(responsetext)
{
    // Parse the JSON response
    var response_objects = JSON.parse(responsetext);

    top_10_gifs = response_objects["results"];

    // load the GIFs -- for our example we will load the first GIFs preview size (nanogif) and share size (gif)

    document.getElementById("preview_gif").src = top_10_gifs[0]["media_formats"]["nanogif"]["url"];

    document.getElementById("share_gif").src = top_10_gifs[0]["media_formats"]["gif"]["url"];

    return;

}


// function to call the trending and category endpoints
function grab_data()
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";
    var lmt = 8;

    // test search term
    var search_term = "excited";

    // using default locale of en_US
    var search_url = "https://tenor.googleapis.com/v2/search?q=" + search_term + "&key=" +
            apikey +"&client_key=" + clientkey +  "&limit=" + lmt;

    httpGetAsync(search_url,tenorCallback_search);

    // data will be loaded by each call's callback
    return;
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// start the flow
grab_data();

</script>

<body>

<h2># 1 GIF loaded - preview image</h2>
<img id="preview_gif" src="" alt="" style="width:220px;height:164px;">

<h2># 1 GIF loaded - share image</h2>
<img id="share_gif" src="" alt="" style="width:498px;height:372px;">

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Execute web request to retrieve the top GIFs returned(in batches of 8) for the given search term.
 */
-(void)requestData
{
  // Define the results upper limit
  int limit = 8;

  // the test search term
  NSString *searchQuery = @"excited";

  // Get the top 10 trending GIFs (updated through out the day) - using the default locale of en_US
  NSString *UrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/search?key=%@&client_key=%@&q=%@&limit=%d", apiKey, clientKey, searchQuery, limit];
  NSURL *searchUrl = [NSURL URLWithString:UrlString];
  NSURLRequest *searchRequest = [NSURLRequest requestWithURL:searchUrl];
  [self makeWebRequest:searchRequest withCallback:tenorSearchResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NStopGifsError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for searches.
 */
void (^tenorSearchResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *topGifs = response[@"results"];

  // Load the GIFs into your view
  NSLog(@"Search Results: %@", topGifs);
};
 
https://tenor.googleapis.com/v2/featured?<parameters>

获取包含当前全球精选 GIF 列表的 JSON 对象。Tenor 会全天候定时更新精选直播。

如果请求中包含网址参数 searchfilter=sticker，Tenor 的热门端点会返回贴纸，而不是 GIF。在贴纸精选响应中，响应对象在 media 字段下包含透明格式。

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 当用户决定要分享哪个 GIF 或贴纸时，我们建议您同时包含对 Register Share 端点的相应调用。 此可选调用有助于 Tenor 的搜索引擎 AI 调整其结果。
  • 如需控制返回和加载的 GIF 数量和流量，请使用 limit 和 pos 参数。例如，您可以为用户的初始热门搜索请求结果设置 limit = 10，并加载这些 GIF 的预览，供用户浏览。如果用户请求更多结果，请通过发出相同的 API 调用来收集接下来的 10 个结果，但要将 pos 设置为初始响应中 next 字段的值。您可以使用此模式来创建流畅的延迟加载体验。这有助于减少带宽用量，并缩短用户响应时间，因为客户端需要并行加载的 GIF 预览数量更少。
  • 如需为您的服务或应用指定合适的 GIF 内容安全分级，请使用 ContentFilter 参数。
  • 如需减少返回的 GIF 格式数量，请使用 media_filter 参数。 这可将响应对象的大小缩减 75%。

下表详细介绍了“精选”端点的参数：

参数
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。

下表详细介绍了“精选”端点的响应格式：

键

Curl

/* Featured GIFs call */
curl "https://tenor.googleapis.com/v2/featured?key=API_KEY&client_key=my_test_app"

Python

import requests
import json

# set the apikey and limit
apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration
lmt = 10

# get the top 10 featured GIFs - using the default locale of en_US
r = requests.get("https://tenor.googleapis.com/v2/featured?key=%s&client_key=%s&limit=%s" % (apikey, ckey, lmt))

if r.status_code == 200:
    featured_gifs = json.loads(r.content)
else:
    featured_gifs = None

# load the featured GIFs
print (featured_gifs)

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // get the top 10 featured GIFs
                JSONObject featuredGifs = getFeaturedGifs(10);

                // load the results for the user
                Log.v(LogTag, "Featured GIFS: " + featuredGifs.toString());

            }
        }.start();
    }

    /**
     * Get featured GIFs
     */
    public static JSONObject getFeaturedGifs(int limit) {

        // get the Featured GIFS - using the default locale of en_US
        final String url = String.format("https://tenor.googleapis.com/v2/featured?key=%1$s&client_key=%2$s&limit=%3$s",
                API_KEY, CLIENT_KEY, limit);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }


    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web requests to retrieve featured GIFs
   */
  func requestData()
  {
    // Define the results upper limit
    let limit = 10

    // Get the top 10 featured GIFs (updated throughout the day) - using the default locale of en_US
    let featuredRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/featured?key=%@&client_key=%@&limit=%d",
                                                             apikey,
                                                             clientkey,
                                                             limit))!)
    makeWebRequest(urlRequest: featuredRequest, callback: tenorFeaturedResultsHandler)
    // Data will be loaded by the request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for featured top 10 GIFs.
   */
  func tenorFeaturedResultsHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let topTenGifs = response["results"]!

    // Load the GIFs into your view
    print("Featured Results: (topTenGifs)")
  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for featured top 10 GIFs
function tenorCallback_featured(responsetext)
{
    // Parse the JSON response
    var response_objects = JSON.parse(responsetext);

    top_10_gifs = response_objects["results"];

    // load the GIFs -- for our example we will load the first GIFs preview size (nanogif) and share size (gif)

    document.getElementById("preview_gif").src = top_10_gifs[0]["media_formats"]["nanogif"]["url"];

    document.getElementById("share_gif").src = top_10_gifs[0]["media_formats"]["gif"]["url"];

    return;

}


// function to call the featured endpoint
function grab_data()
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";
    var lmt = 10;

    // get the top 10 featured GIFs (updated throughout the day) - using the default locale of en_US
    var featured_url = "https://tenor.googleapis.com/v2/featured?key=" + apikey + "&client_key=" + clientkey + "&limit=" + lmt;


    httpGetAsync(featured_url,tenorCallback_featured);

    // data will be loaded by each call's callback
    return;
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// start the flow
grab_data();

</script>
<style>
.container {
    position: relative;
    text-align: center;
    color: white;
}
.title {
text-align: center;
}
.centered {
    position: absolute;
    top: 50%;
    left: 50%;
    transform: translate(-50%, -50%);
}
</style>

<body>

<h2 class="title">GIF loaded - preview image</h2>
<div class="container">
<img id="preview_gif" src="" alt="" style="">
</div>

<h2 class="title">GIF loaded - share image</h2>
<div class="container">
<img id="share_gif" src="" alt="" style="">
</div>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Execute web requests to retrieve featured GIFs
 */
-(void)requestData
{
  // Define the results upper limit
  int limit = 10;

  // Get the top 10 featured GIFs (updated throughout the day) - using the default locale of en_US
  NSString *featuredUrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/featured?key=%@&client_key=%@&limit=%d", apiKey, clientKey, limit];
  NSURL *featuredUrl = [NSURL URLWithString:featuredUrlString];
  NSURLRequest *featuredRequest = [NSURLRequest requestWithURL:featuredUrl];
  [self makeWebRequest:featuredRequest withCallback:tenorFeaturedResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NSError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for featured top 10 GIFs.
 */
void (^tenorFeaturedResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *topTenGifs = response[@"results"];

  // Load the GIFs into your view
  NSLog(@"Featured Results: %@", topTenGifs);
};

类别

基准网址

https://tenor.googleapis.com/v2/categories?<parameters>

获取一个 JSON 对象，其中包含与所提供类型关联的 GIF 类别列表。每个类别都包含一个相应的搜索网址，供用户点击该类别时使用。搜索网址包含对“类别”端点的原始调用中的所有参数。

支持的类型

  • featured （默认）：当前精选的表情或反应类 GIF 类别。这包括每个术语的预览 GIF。
  • trending：当前的热搜字词。这包括每个术语的预览 GIF。

最佳做法

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 使用 locale 参数将类别名称转换为用户的语言。默认值为 en_US。
  • 如需为您的服务或应用指定合适的 GIF 内容安全分级，请使用 ContentFilter 参数。 使用时，ContentFilter 参数会传递给 categories 响应对象中找到的所有搜索网址。

参数

下表详细介绍了“类别”端点的参数：

参数
key

必需

string

用于特权 API 访问的 API 密钥

没有默认值。
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。
country

强烈建议

string (YY)

指定请求的来源国家/地区。为此，请提供相应国家/地区的双字母 ISO 3166-1 国家/地区代码。

默认值为 US。
locale

强烈建议

string (xx_YY)

指定用于解读搜索字符串的默认语言。xx 是语言的 ISO 639-1 语言代码，而可选的 _YY 值是两个字母的 ISO 3166-1 国家/地区代码。

您可以使用 locale 中提供的国家/地区代码来区分给定语言的不同方言。

默认值为 en_US。
type

强烈建议

string

确定返回的类别类型。

默认值为 featured。可接受的值为 featured 和 trending。
contentfilter

强烈建议

enum

指定内容安全过滤级别。

默认值为 off。可接受的值包括 off、low、medium 和 high。

回答格式

下表详细介绍了“类别”端点的响应格式：

键
tags

CATEGORY_OBJECT[]

一个 CATEGORY_OBJECTS 数组，其中 name 字段已翻译为 locale 语言。

示例请求

Curl

/* categories call */
curl "https://tenor.googleapis.com/v2/categories?key=API_KEY&client_key=my_test_app"

Python

import requests
import json

# set the apikey and limit
apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration

# get the current list of categories - using the default locale of en_US
r = requests.get("https://tenor.googleapis.com/v2/categories?key=%s&client_key=%s" % (apikey, ckey))

if r.status_code == 200:
    categories = json.loads(r.content)
else:
    categories = None

# load the categories below the search bar for the user
print (categories)

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // get the current list of categories
                JSONObject categories = getCategories();

                // load the results for the user
                Log.v(LogTag, "GIF Categories: " + categories.toString());

            }
        }.start();
    }


    /**
     * Get categories
     */
    public static JSONObject getCategories() {

        // get the categories - using the default locale of en_US
        final String url = String.format("https://tenor.googleapis.com/v2/categories?key=%1$s&client_key=%2$s",
                API_KEY, CLIENT_KEY);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web requests to retrieve featured GIFs and GIF categories.
   */
  func requestData()
  {

    // Get the current list of categories - using the default locale of en_US
    let categoryRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/categories?key=%@&client_key=%@",
                                                             apikey, clientkey))!)
    makeWebRequest(urlRequest: categoryRequest, callback: tenorCategoryResultsHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for GIF categories.
   */
  func tenorCategoryResultsHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let categories = response["tags"]!

    // Load the categories into your view
    print("Category Results: (categories)")
  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for GIF categories
function tenorCallback_categories(responsetext)
{
    // Parse the JSON response
    var response_objects = JSON.parse(responsetext);

    categories = response_objects["tags"];

    // load the categories - example is for the first category

    // url to load:
    var imgurl = categories[0]["image"];

    // text to overlay on image:
    var txt_overlay = categories[0]["name"];


    // search to run if user clicks the category
    var category_search_path = categories[0]["path"];

    document.getElementById("category_gif").src = imgurl
    document.getElementById("catgif_caption").innerHTML = txt_overlay
    document.getElementById("cat_link").href = category_search_path

    return;
}

// function to call the category endpoints
function grab_data()
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";

    // get the current list of categories - using the default locale of en_US
    var cat_url = "https://tenor.googleapis.com/v2/categories?key=" + apikey + "&client_key=" + clientkey;

    httpGetAsync(cat_url,tenorCallback_categories);

    // data will be loaded by each call's callback
    return;
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// start the flow
grab_data();

</script>
<style>
.container {
    position: relative;
    text-align: center;
    color: white;
}
.title {
text-align: center;
}
.centered {
    position: absolute;
    top: 50%;
    left: 50%;
    transform: translate(-50%, -50%);
}
</style>

<body>

<h2 class="title">GIF Category</h2>
<div class="container">
    <a id="cat_link" href="">
        <img id="category_gif" src="" alt="" style="">
        <div id="catgif_caption" class="centered"></div>
    </a>
</div>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Execute web requests to retrieve GIF categories.
 */
-(void)requestData
{

  // Get the current list of categories - using the default locale of en_US
  NSString *categoryUrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/categories?key=%@&client_key=%@", apiKey, clientKey];
  NSURL *categoryUrl = [NSURL URLWithString:categoryUrlString];
  NSURLRequest *categoryRequest = [NSURLRequest requestWithURL:categoryUrl];
  [self makeWebRequest:categoryRequest withCallback:tenorCategoryResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NSError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for GIF categories.
 */
void (^tenorCategoryResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *categories = response[@"tags"];

  // Load the categories into your view
  NSLog(@"Category Results: %@", categories);
};

搜索建议

基准网址

https://tenor.googleapis.com/v2/search_suggestions?<parameters>

获取一个 JSON 对象，其中包含指定搜索字词的备选搜索字词列表。

搜索建议可帮助用户缩小搜索范围或发现相关搜索字词，从而找到更精确的 GIF。该 API 会根据历史用户搜索和分享行为，按最有可能促成分享的顺序返回指定字词的结果。

最佳做法

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 按响应提供的顺序显示结果。

参数

下表详细介绍了“搜索建议”端点的参数：

参数
key

必需

string

用于特权 API 访问的 API 密钥

没有默认值。
q

必需

string

搜索字符串

没有默认值。
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。
country

强烈建议

string (YY)

指定请求的来源国家/地区。为此，请提供相应国家/地区的双字母 ISO 3166-1 国家/地区代码。

默认值为 US。
locale

强烈建议

string (xx_YY)

指定用于解读搜索字符串的默认语言。xx 是语言的 ISO 639-1 语言代码，而可选的 _YY 值是两个字母的 ISO 3166-1 国家/地区代码。

您可以使用 locale 中提供的国家/地区代码来区分给定语言的不同方言。

默认值为 en_US。
limit

可选

integer

提取的结果数量上限。

默认值为 20，最大值为 50。

回答格式

下表详细介绍了“搜索建议”端点的响应格式：

键
results

string[]

建议的搜索字词数组

示例请求

Curl

/* search suggestion */
curl "https://tenor.googleapis.com/v2/search_suggestions?key=API_KEY&client_key=my_test_app&q=smile&limit=5"

Python

# set the apikey and limit the # coming back
apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration
lmt = 5

# partial search
search = "smile"

r = requests.get(
 "https://tenor.googleapis.com/v2/search_suggestions?key=%s&client_key=%s&q=%s&limit=%s" % (apikey, ckey, search, lmt))

if r.status_code == 200:
    # return the search suggestions
    search_suggestion_list = json.loads(r.content)["results"]
    print search_suggestion_list
else:
    # handle a possible error
    search_suggestion_list = []

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // for testing, the last search
                final String lastSearch = "smile";
                int limit = 5;

                // make the search suggestion call
                JSONObject searchSuggestionResult = searchSuggestionRequest(lastSearch, limit);

                // load the results for the user
                Log.v(LogTag, "Search Suggestion Results: " + searchSuggestionResult.toString());

            }
        }.start();
    }

    /**
     * Autocomplete Request
     */
    public static JSONObject searchSuggestionRequest(String lastSearch, int limit) {

        // make an autocomplete request - using default locale of EN_US
        final String url = String.format("https://tenor.googleapis.com/v2/search_suggestions?key=%1$s&client_key=%2$s&q=%3$s&limit=%4$s",
                API_KEY, CLIENT_KEY, lastSearch, limit);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web requests to get search suggestions.
   */
  func requestData()
  {
    // for testing, the partial search
    let lastsearch = "smile"
    let limit = 5

    // Get the top 5 search suggestions - using the default locale of en_US
    let suggestRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/search_suggestions?key=%@&client_key=%@&q=%@&limit=%d",
                                                             apikey,
                                                             clientkey,
                                                             lastsearch,
                                                             limit))!)
    makeWebRequest(urlRequest: suggestRequest, callback: tenorSuggestResultsHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for search suggestion requests.
   */
  func tenorSuggestResultsHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let searchSuggestion = response["results"]!

    // Load the GIFs into your view
    print("Search Suggestion Results: (searchSuggestion)")
  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for share event
function tenorCallback_searchSuggestion(responsetext)
{
    var response_objects = JSON.parse(responsetext);

    predicted_words = response_objects["results"];

    document.getElementById("ac_1").innerHTML = predicted_words[0];
    document.getElementById("ac_2").innerHTML = predicted_words[1];
    document.getElementById("ac_3").innerHTML = predicted_words[2];
    document.getElementById("ac_4").innerHTML = predicted_words[3];
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

//search term
psearch_term = "smile";

// set the apikey and limit
var apikey = "API_KEY";
var clientkey = "my_test_app";
var lmt = 5;

// using default locale of en_US
var autoc_url = "https://tenor.googleapis.com/v2/search_suggestions?key=" + apikey + "&client_key=" + clientkey + "&q=" + psearch_term + "&limit=" + lmt;

// send search suggestion request
httpGetAsync(autoc_url,tenorCallback_searchSuggestion);


</script>

<body>

<h2>Search Suggestion for "smile":</h2>
<h3 id = "ac_1"></h3>
<h3 id = "ac_2"></h3>
<h3 id = "ac_3"></h3>
<h3 id = "ac_4"></h3>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
   Execute web requests to get search suggestions.
   */
-(void)requestData
{
  // Define the results upper limit
  int limit = 5;

  // the test search term
  NSString *lastSearch = @"smile";

  // Get the search suggestions for the given last search - using the default locale of en_US
  NSString *UrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/search_suggestions?key=%@&client_key=%@&q=%@&limit=%d", apiKey, clientKey, lastSearch, limit];
  NSURL *searchUrl = [NSURL URLWithString:UrlString];
  NSURLRequest *searchRequest = [NSURLRequest requestWithURL:searchUrl];
  [self makeWebRequest:searchRequest withCallback:tenorSearchSuggestionResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NStopGifsError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for search suggestions
 */
void (^tenorSearchSuggestionResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *results = response[@"results"];

  // Load the GIFs into your view
  NSLog(@"Search Suggestion Result: %@", results);
};

自动补全

基准网址

https://tenor.googleapis.com/v2/autocomplete?q=<term>&key=<API KEY>

获取一个 JSON 对象，其中包含指定部分搜索字词的已完成搜索字词列表。 该列表由 Tenor 的 AI 排序，随着 Tenor 的 AI 确定性越来越高，结果数量会减少。

最佳做法

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 使用 locale 参数可根据用户的语言调整结果。默认值为 en_US。
  • 按响应提供的顺序显示结果。

参数

下表详细介绍了“自动补全”端点的参数：

参数
key

必需

string

用于特权 API 访问的 API 密钥

没有默认值。
q

必需

string

搜索字符串

没有默认值。
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。
country

强烈建议

string (YY)

指定请求的来源国家/地区。为此，请提供相应国家/地区的双字母 ISO 3166-1 国家/地区代码。

默认值为 US。
locale

强烈建议

string (xx_YY)

指定用于解读搜索字符串的默认语言。xx 是语言的 ISO 639-1 语言代码，而可选的 _YY 值是两个字母的 ISO 3166-1 国家/地区代码。

您可以使用 locale 中提供的国家/地区代码来区分给定语言的不同方言。

默认值为 en_US。
limit

可选

integer

提取的结果数量上限。

默认值为 20，最大值为 50。

回答格式

下表详细介绍了自动补全端点的响应格式：

键
results

string[]

建议的搜索字词数组

示例请求

Curl

/* autocomplete */
curl "https://tenor.googleapis.com/v2/autocomplete?key=API_KEY&client_key=my_test_app&q=exc"

Python

apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration
lmt = 5

# partial search
psearch = "exc"

r = requests.get(
    "https://tenor.googleapis.com/v2/autocomplete?key=%s&client_key=%s&q=%s&limit=%s" % (apikey, ckey, psearch, lmt))

if r.status_code == 200:
    # return the search predictions
    search_term_list = json.loads(r.content)["results"]
    print(search_term_list)
else:
    # handle a possible error
    search_term_list = []

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // for testing, the partial search
                final String partialSearch = "exc";
                int limit = 5;

                // make the autocomplete call
                JSONObject autoCompleteResult = autoCompleteRequest(partialSearch, limit);

                // load the results for the user
                Log.v(LogTag, "AutoComplete Results: " + autoCompleteResult.toString());

            }
        }.start();
    }

    /**
     * Autocomplete Request
     */
    public static JSONObject autoCompleteRequest(String partialSearch, int limit) {

        // make an autocomplete request - using default locale of EN_US
        final String url = String.format("https://tenor.googleapis.com/v2/autocomplete?key=%1$s&client_key=%2$s&q=%3$s&limit=%4$s",
                API_KEY, CLIENT_KEY, partialSearch, limit);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web requests to get autocomplete suggestions.
   */
  func requestData()
  {
    // for testing, the partial search
    let partialSearch = "exc"
    let limit = 5

    // Get up to 5 results from the autocomplete suggestions - using the default locale of en_US
    let autoRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/autocomplete?key=%@&client_key=%@&q=%@&limit=%d",
                                                             apikey,
                                                             clientkey,
                                                             partialSearch,
                                                             limit))!)
    makeWebRequest(urlRequest: autoRequest, callback: tenorAutoCompleteResultsHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for autocomplete requests.
   */
  func tenorAutoCompleteResultsHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let autoSuggestions = response["results"]!

    // Load the GIFs into your view
    print("Autocomplete Results: (autoSuggestions)")
  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for share event
function tenorCallback_autocomplete(responsetext)
{
    var response_objects = JSON.parse(responsetext);

    predicted_words = response_objects["results"];

    document.getElementById("ac_1").innerHTML = predicted_words[0];
    document.getElementById("ac_2").innerHTML = predicted_words[1];
}

// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

//partial search term
psearch_term = "exc";

// set the apikey and limit
var apikey = "API_KEY";
var clientkey = "my_test_app";
var lmt = 5;

// using default locale of en_US
var autoc_url = "https://tenor.googleapis.com/v2/autocomplete?key=" + apikey + "&client_key=" + clientkey + "&q=" + psearch_term + "&limit=" + lmt;

// send autocomplete request
httpGetAsync(autoc_url,tenorCallback_autocomplete);


</script>

<body>

<h2>Partial Search "exc":</h2>
<h3 id = "ac_1"></h3>
<h3 id = "ac_2"></h3>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
   Execute web requests to get autocomplete suggestions.
   */
-(void)requestData
{
  // Define the results upper limit
  int limit = 8;

  // the test search term
  NSString *partialSearch = @"exc";

  // Get the auto complete predictions for the given partial search - using the default locale of en_US
  NSString *UrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/autocomplete?key=%@&client_key=%@&q=%@&limit=%d", apiKey, clientKey, partialSearch, limit];
  NSURL *searchUrl = [NSURL URLWithString:UrlString];
  NSURLRequest *searchRequest = [NSURLRequest requestWithURL:searchUrl];
  [self makeWebRequest:searchRequest withCallback:tenorAutoCompleteResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NStopGifsError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for auto complete predictions
 */
void (^tenorAutoCompleteResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *results = response[@"results"];

  // Load the GIFs into your view
  NSLog(@"Auto Complete Result: %@", results);
};
 
https://tenor.googleapis.com/v2/trending_terms?<parameters>

获取包含当前热门搜索字词列表的 JSON 对象。Tenor 的 AI 每小时更新一次列表。

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 按响应提供的顺序显示结果。

下表详细介绍了“热门搜索字词”端点的参数：

参数

下表详细介绍了“热门搜索字词”端点的响应格式：

键

Curl

/* trending Terms call */
curl "https://tenor.googleapis.com/v2/trending_terms?key=API_KEY&client_key=my_test_app"

Python

import requests
import json


apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration

# get the current list of categories - using the default locale of en_US
r = requests.get("https://tenor.googleapis.com/v2/trending_terms?key=%s&client_key=%s" % (apikey,ckey))

if r.status_code == 200:
    trending_terms = json.loads(r.content)
else:
    trending_terms = None

# load the results
print(trending_terms)

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // get the current list of categories
                JSONObject terms = getTrendingTerms();

                // load the results for the user
                Log.v(LogTag, "Trending Terms: " + terms.toString());

            }
        }.start();
    }

    /**
     * Get trending terms
     */
    public static JSONObject getTrendingTerms() {

        // get the categories - using the default locale of en_US
        final String url = String.format("https://tenor.googleapis.com/v2/trending_terms?key=%1$s&client_key=%2$s",
                API_KEY, CLIENT_KEY);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web requests to retrieve trending terms.
   */
  func requestData()
  {

    // Get the current list of categories - using the default locale of en_US
    let categoryRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/trending_terms?key=%@&client_key=%@",
                                                             apikey, clientkey))!)
    makeWebRequest(urlRequest: categoryRequest, callback: tenorTermsResultsHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for GIF categories.
   */
  func tenorTermsResultsHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let terms = response["results"]!

    // Load the categories into your view
    print("Trending Terms Results: (terms)")
  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for GIF categories
function tenorCallback_terms(responsetext)
{
    // Parse the JSON response
    var response_objects = JSON.parse(responsetext);

    terms = response_objects["results"];

    document.getElementById("res").innerHTML = terms

    return;
}

// function to call the trending terms
function grab_data()
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";
    var lmt = 10;

    // get the current list of trending terms - using the default locale of en_US
    var cat_url = "https://tenor.googleapis.com/v2/trending_terms?key=" + apikey + "&client_key=" + clientkey;

    httpGetAsync(cat_url,tenorCallback_terms);

    // data will be loaded by each call's callback
    return;
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// start the flow
grab_data();

</script>
<style>
.container {
    position: relative;
    text-align: center;
    color: white;
}
.title {
text-align: center;
}
.centered {
    position: absolute;
    top: 50%;
    left: 50%;
    transform: translate(-50%, -50%);
}
</style>

<body>

<h2 class="title">Trending Terms</h2>
<div class="container" id="res">
</div>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Execute web requests to retrieve trending terms.
 */
-(void)requestData
{

  // Get the current list of categories - using the default locale of en_US
  NSString *categoryUrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/trending_terms?key=%@&client_key=%@", apiKey, clientkey];
  NSURL *categoryUrl = [NSURL URLWithString:categoryUrlString];
  NSURLRequest *categoryRequest = [NSURLRequest requestWithURL:categoryUrl];
  [self makeWebRequest:categoryRequest withCallback:tenorTermsResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NSError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}


/**
 Web response handler for GIF categories.
 */
void (^tenorTermsResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *terms = response[@"results"];

  // Load the categories into your view
  NSLog(@"Trending Terms: %@", terms);
};

注册分享

基准网址

https://tenor.googleapis.com/v2/registershare?<parameters>

注册用户分享 GIF 或贴纸的操作。

最佳做法

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 提供搜索字词。这有助于进一步调整 Tenor 的搜索引擎 AI，从而帮助用户更轻松地找到合适的 GIF 或贴纸。
  • 使用 locale 参数可增强分享信号的区域相关性。默认值为 en_US。

参数

下表详细介绍了“注册分享”端点的参数：

参数
key

必需

string

用于特权 API 访问的 API 密钥

没有默认值。
id

必需

string

响应对象的 id

没有默认值。
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。
country

强烈建议

string (YY)

指定请求的来源国家/地区。为此，请提供相应国家/地区的双字母 ISO 3166-1 国家/地区代码。

默认值为 US。
locale

强烈建议

string (xx_YY)

指定用于解读搜索字符串的默认语言。xx 是语言的 ISO 639-1 语言代码，而可选的 _YY 值是两个字母的 ISO 3166-1 国家/地区代码。

您可以使用 locale 中提供的国家/地区代码来区分给定语言的不同方言。

默认值为 en_US。
q

强烈建议

string

促成此分享的搜索字符串。

没有默认值。

回答格式

对于“注册分享”端点，没有正式的响应。开发者可以检查 HTTPS 响应代码，以确定是否已成功访问 API。

示例请求

Curl

/* register share */
curl "https://tenor.googleapis.com/v2/registershare?id=16989471141791455574&key=API_KEY&client_key=my_test_app&q=excited"

Python

# set the apikey
apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration

# get the GIF's id and search used
shard_gifs_id = top_8gifs["results"][0]["id"]

search_term = "excited"

r = requests.get("https://tenor.googleapis.com/v2/registershare?id=%s&key=%s&client_key=%s&q=%s" % (shard_gifs_id, apikey, ckey, search_term))

if r.status_code == 200:
    pass
    # move on
else:
    pass
    # handle error

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                // test values for the share example
                final String gifId = "16989471141791455574";
                final String searchTerm = "excited";

                // make the register share call
                JSONObject shareResult = registerShare(gifId, searchTerm);

                // load the results for the user
                Log.v(LogTag, "Share Results: " + shareResult.toString());

            }
        }.start();
    }

    /**
     * Register the GIF share
     */
    public static JSONObject registerShare(String gifId, String searchTerm) {

        // make register share request - using default locale of EN_US
        final String url = String.format("https://tenor.googleapis.com/v2/registershare?key=%1$s&client_key=%2$s&id=%3$s&q=%4$s",
                API_KEY, CLIENT_KEY, gifId, searchTerm);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    // test values for the share example
    let gifId = "16989471141791455574"
    let searchTerm = "excited"

    // register the user's share
    registerShare(gifId: gifId, searchTerm: searchTerm)

    return true
  }

  // Function for handling a user's selection of a GIF to share.
  // In a production application, the GIF id should be the "id" field of the GIF response object that the user selected
  // to share. The search term should be the user's last search.
  func registerShare(gifId: String, searchTerm: String) {

    // Register the user's share - using the default locale of en_US
    let shareRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/registershare?key=%@&client_key=%@&id=%@&q=%@",
                                                             apikey,
                                                             clientkey,
                                                             gifId,
                                                             searchTerm))!)
    makeWebRequest(urlRequest: shareRequest, callback: tenorShareHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for search requests.
   */
  func tenorShareHandler(response: [String:AnyObject])
  {
   // no response expected from the registershare endpoint

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for share event
function tenorCallback_share(responsetext)
{
    // no action is needed in the share callback
}


// function to call the register share endpoint
function send_share(search_term,shared_gifs_id)
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";

    var share_url = "https://tenor.googleapis.com/v2/registershare?id=" + shared_gifs_id + "&key=" + apikey + "&client_key=" + clientkey + "&q=" + search_term;

    httpGetAsync(share_url,tenorCallback_share);
}

// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// grab search term from cookies or some other storage
search_term = "excited";

// GIF id from the shared gif
// shared_gifs_id = gif_json_response_object_from_search["results"][0]["id"]
shared_gifs_id = "16989471141791455574"; // example

// send the share notifcation back to Tenor
send_share(search_term,shared_gifs_id);

alert("share sent!");


</script>

<body>

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Function for handling a user's selection of a GIF to share.
 In a production application, the GIF id should be the "id" field of the GIF response object that the user selected
 to share. The search term should be the user's last search.
 */
-(void)requestData
{


  // the test search term
  NSString *searchQuery = @"excited";
  NSString *gifId = @"16989471141791455574";

  //  Send the share event for the GIF id and search query
  NSString *UrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/registershare?id=%@&key=%@&client_key=%@&q=%@", gifId, apiKey, clientKey, searchQuery];
  NSURL *searchUrl = [NSURL URLWithString:UrlString];
  NSURLRequest *searchRequest = [NSURLRequest requestWithURL:searchUrl];
  [self makeWebRequest:searchRequest withCallback:tenorSearchResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NStopGifsError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for registered shares
 */
void (^tenorShareResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
// no response expected from the registershare endpoint.
};

帖子

基准网址

https://tenor.googleapis.com/v2/posts?<parameters>

获取指定 ID 的 GIF、贴纸或两者兼有。

最佳做法

  • 如需区分集成，请提供 client_key 参数以及 API 的 key。
  • 如需减少返回的 GIF 格式数量，请使用 media_filter 参数。 这可将响应对象的大小缩减 75%。

参数

下表详细介绍了“帖子”端点的参数：

参数
key

必需

string

用于特权 API 访问的 API 密钥

没有默认值。
ids

必需

string

以英文逗号分隔的响应对象 ID 列表。

没有默认值，最大值为 50。
client_key

强烈建议

string

表示集成的客户端指定字符串。

借助客户端密钥，您可以在不同的集成中使用同一 API 密钥，但仍能区分它们。

对于应用集成，请为所有 API 调用使用相同的 client_key 值。

任何客户端自定义行为都由 key 和 client_key 参数的配对触发。

没有默认值。
media_filter

强烈建议

string

用于过滤响应对象的 GIF 格式的英文逗号分隔列表。默认情况下，media_filter 会返回每个响应对象的所有格式。

示例：media_filter=gif,tinygif,mp4,tinymp4

没有默认值。

回答格式

下表详细介绍了“帖子”端点的响应格式：

键
results

RESPONSE_OBJECT[]

与 ids 列表中传递的对象对应的响应对象数组。

示例请求

Curl

/* Posts endpoint */
curl "https://tenor.googleapis.com/v2/posts?key=API_KEY&client_key=my_test_app&ids=11586094175715197775"

Python

apikey = "API_KEY"   # click to set to your apikey
ckey = "my_test_app"  # set the client_key for the integration

# our gif id
gifid = "11586094175715197775"

# get the specific gif
r = requests.get(
    "https://tenor.googleapis.com/v2/posts?ids=%s&key=%s&client_key=%s" % (gifid, apikey,ckey))

if r.status_code == 200:
    # load the GIFs using the urls for the smaller GIF sizes
    gifs = json.loads(r.content)
    print(gifs)
else:
    gifs = None

Android/Java

import android.app.Application;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URL;

public class App extends Application {

    private static final String API_KEY = "API_KEY";
    private static final String CLIENT_KEY = "my_test_app";
    private static final String LogTag = "TenorTest";

    @Override
    public void onCreate() {
        super.onCreate();

        new Thread() {
            @Override
            public void run() {

                final String gif_id ="11586094175715197775";

                // get the requested gif
                JSONObject gifResult = getGifResults(gif_id);

                // load the results for the user
                Log.v(LogTag, "Gif Results: " + gifResult.toString());

            }
        }.start();
    }

    /**
     * Get Search Result GIFs
     */
    public static JSONObject getGifResults(String gif_id) {


        final String url = String.format("https://tenor.googleapis.com/v2/posts?ids=%1$s&key=%2$s&client_key=%3$s",
                gif_id, API_KEY, CLIENT_KEY);
        try {
            return get(url);
        } catch (IOException | JSONException ignored) {
        }
        return null;
    }

    /**
     * Construct and run a GET request
     */
    private static JSONObject get(String url) throws IOException, JSONException {
        HttpURLConnection connection = null;
        try {
            // Get request
            connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            // Handle failure
            int statusCode = connection.getResponseCode();
            if (statusCode != HttpURLConnection.HTTP_OK && statusCode != HttpURLConnection.HTTP_CREATED) {
                String error = String.format("HTTP Code: '%1$s' from '%2$s'", statusCode, url);
                throw new ConnectException(error);
            }

            // Parse response
            return parser(connection);
        } catch (Exception ignored) {
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
        return new JSONObject("");
    }

    /**
     * Parse the response into JSONObject
     */
    private static JSONObject parser(HttpURLConnection connection) throws JSONException {
        char[] buffer = new char[1024 * 4];
        int n;
        InputStream stream = null;
        try {
            stream = new BufferedInputStream(connection.getInputStream());
            InputStreamReader reader = new InputStreamReader(stream, "UTF-8");
            StringWriter writer = new StringWriter();
            while (-1 != (n = reader.read(buffer))) {
                writer.write(buffer, 0, n);
            }
            return new JSONObject(writer.toString());
        } catch (IOException ignored) {
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ignored) {
                }
            }
        }
        return new JSONObject("");
    }
}

Swift 2.0+/iOS

let apikey = "API_KEY"
let clientkey = "my_test_app"

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    requestData()

    return true
  }

  /**
   Execute web request to the requested gif.
   */
  func requestData()
  {
    // the test gif id
    let gifid = "11586094175715197775"

    // request the gif
    let searchRequest = URLRequest(url: URL(string: String(format: "https://tenor.googleapis.com/v2/posts?ids=%@&key=%@&client_key=%@",
                                                             gifid,
                                                             apikey,
                                                             clientkey))!)

    makeWebRequest(urlRequest: searchRequest, callback: tenorgifHandler)

    // Data will be loaded by each request's callback
  }

  /**
   Async URL requesting function.
   */
  func makeWebRequest(urlRequest: URLRequest, callback: @escaping ([String:AnyObject]) -> ())
  {
    // Make the async request and pass the resulting JSON object to the callback
    let task = URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
      do {
        if let jsonResult = try JSONSerialization.jsonObject(with: data!, options: []) as? [String:AnyObject] {
          // Push the results to our callback
          callback(jsonResult)
        }
      } catch let error as NSError {
        print(error.localizedDescription)
      }
    }
    task.resume()
  }

  /**
   Web response handler for search requests.
   */
  func tenorgifHandler(response: [String:AnyObject])
  {
    // Parse the JSON response
    let responseGifs = response["results"]!

    // Load the GIFs into your view
    print("Result GIFS: (responseGifs)")

  }

  }

JavaScript

<!DOCTYPE html>
<html>
<script>

// url Async requesting function
function httpGetAsync(theUrl, callback)
{
    // create the request object
    var xmlHttp = new XMLHttpRequest();

    // set the state change callback to capture when the response comes in
    xmlHttp.onreadystatechange = function()
    {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
        {
            callback(xmlHttp.responseText);
        }
    }

    // open as a GET call, pass in the url and set async = True
    xmlHttp.open("GET", theUrl, true);

    // call send with no params as they were passed in on the url string
    xmlHttp.send(null);

    return;
}

// callback for the requested gif
function tenorCallback_gifs(responsetext)
{
    // Parse the JSON response
    var response_objects = JSON.parse(responsetext);

    var gif = response_objects["results"];

    // load the GIFs -- for our example we will load the first GIFs preview size (nanogif) and share size (gif)

    document.getElementById("preview_gif").src = gif[0]["media_formats"]["nanogif"]["url"];

    document.getElementById("share_gif").src = gif[0]["media_formats"]["gif"]["url"];

    return;

}


// function to call the trending and category endpoints
function grab_data()
{
    // set the apikey and limit
    var apikey = "API_KEY";
    var clientkey = "my_test_app";

    // GIF id
    var gif_id = "11586094175715197775";

    // using default locale of en_US
    var search_url = "https://tenor.googleapis.com/v2/posts?ids=" + gif_id + "&key=" +
            apikey + "&client_key=" + clientkey;

    httpGetAsync(search_url,tenorCallback_gifs);

    // data will be loaded by each call's callback
    return;
}


// SUPPORT FUNCTIONS ABOVE
// MAIN BELOW

// start the flow
grab_data();

</script>

<body>

<h2># 1 GIF loaded - preview image</h2>
<img id="preview_gif" src="" alt="" style="width:220px;height:164px;">

<h2># 1 GIF loaded - share image</h2>
<img id="share_gif" src="" alt="" style="width:498px;height:372px;">

</body>
</html>

Objective-C

NSString *apiKey = @"API_KEY";
NSString *clientKey = @"my_test_app";

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  [self requestData];
  return YES;
}

/**
 Execute web request to retrieve the requested gif.
 */
-(void)requestData
{

  NSString *gifid = @"11586094175715197775";

  // Get the GIF
  NSString *UrlString = [NSString stringWithFormat:@"https://tenor.googleapis.com/v2/posts?key=%@&client_key=%@&ids=%@", apiKey, clientKey, gifid];
  NSURL *searchUrl = [NSURL URLWithString:UrlString];
  NSURLRequest *searchRequest = [NSURLRequest requestWithURL:searchUrl];
  [self makeWebRequest:searchRequest withCallback:tenorgifResultsHandler];

  // Data will be loaded by each request's callback
}

/**
 Async URL requesting function.
 */
-(void)makeWebRequest:(NSURLRequest *)urlRequest withCallback:(void (^)(NSDictionary *))callback
{
  // Make the async request and pass the resulting JSON object to the callback
  NSURLSessionTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    NStopGifsError *jsonError = nil;
    NSDictionary *jsonResult = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableLeaves error:&jsonError];

    if(jsonError != nil) {
      NSLog(@"%@", jsonError.localizedDescription);
      return;
    }

    // Push the results to our callback
    callback(jsonResult);
  }];

  [task resume];
}

/**
 Web response handler for searches.
 */
void (^tenorgifResultsHandler)(NSDictionary *) = ^void(NSDictionary *response)
{
  // Parse the JSON response
  NSDictionary *gif = response[@"results"];

  // Load the GIFs into your view
  NSLog(@"GIF Results: %@", gif);
};