統合ガイド

このページでは、manage Bookmarks エンドポイントをシステムに統合するにあたって理解しておくべき、いくつかのツールと重要な概念について説明します。内容は次のセクションで構成されています。

便利なツール
重要な概念
- 認証
- [開発者コンソール、プロジェクト、App](/x-api/users/blocks/integrate#Developer Console-projects-and-developer-apps)
- レート制限

便利なツール

このエンドポイントを統合するための重要な概念を説明する前に、まず次のツールに慣れておくことをおすすめします。

Postman

Postman は、エンドポイントをテストするために使用できる非常に便利なツールです。各 Postman リクエストには、利用可能な項目をすばやく把握できるよう、すべてのパスおよびボディパラメータが含まれています。Postman コレクションの詳細については、「Using Postman」ページをご覧ください。

コードサンプル

お好みのプログラミング言語でこのエンドポイントを使い始めるためのコードをお探しですか？GitHub ページには、出発点として利用できるさまざまなコードサンプルを用意しています。

サードパーティライブラリ

コミュニティのサードパーティライブラリを活用して、開発の開始に役立ててください。v2 エンドポイントに対応したライブラリは、適切なバージョンタグを目印に探すことができます。

主要な概念

認証

すべての X API v2 エンドポイントでは、キーやトークンとも呼ばれる一連の認証情報を使用してリクエストを認証する必要があります。これらのエンドポイントでは、OAuth 2.0 Authorization Code Flow with PKCE を使用する必要があります。これは、リクエストを正常に行うために、一連のキーとユーザーの Access Token を使用しなければならないことを意味します。Access Token は、あなたが代理でリクエストを行う対象のユーザーに紐づいている必要があります。別のユーザーの Access Token を生成したい場合、そのユーザーは Authorize URL を使用してあなたの App を承認または認証しなければなりません。 OAuth 2.0 の利用は難しい場合があることに注意してください。この認証方式に慣れていない場合は、ライブラリや Postman のようなツールを使用して、リクエストを正しく認証することをお勧めします。

開発者コンソール、Project、開発者 App

X API v2 エンドポイントで利用できる一連の認証情報を取得するには、開発者アカウントを所有し、そのアカウント内にProjectを作成し、その Project 内に開発者 Appを作成している必要があります。そのうえで、開発者 App 内でキーとトークンを確認できます。

レート制限

毎日、何千人もの開発者が X API へリクエストを送信しています。こうした大量のリクエストを管理するために、各エンドポイントにはレート制限が設定されており、あなたの App または認証済みユーザーに代わって送信できるリクエスト数が制限されています。これらのエンドポイントはユーザーレベルでレート制限されており、あなたがリクエストを送信している認証済みユーザーは、どの開発者向け App であっても、そのエンドポイントを呼び出せる回数に上限があります。GET メソッドには、15 分ごとに 180 リクエストというユーザー単位のレート制限があります。Bookmarks lookup エンドポイントの GET メソッドでは、直近のブックマーク済みの投稿を最大 800 件まで取得できます。さらに、POST および DELETE メソッドには、15 分あたり 50 リクエストというユーザー単位のレート制限があります。

コード例

ブックマークを取得

cURL

curl "https://api.x.com/2/users/123/bookmarks?tweet.fields=created_at,public_metrics" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

# ユーザーのブックマークを取得
for page in client.bookmarks.get(user_id="123", tweet_fields=["created_at", "public_metrics"]):
    for post in page.data:
        print(f"{post.text} - Likes: {post.public_metrics.like_count}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });

// ユーザーのブックマークを取得
const paginator = client.bookmarks.get("123", {
  tweetFields: ["created_at", "public_metrics"],
});

for await (const page of paginator) {
  page.data?.forEach((post) => {
    console.log(`${post.text} - Likes: ${post.public_metrics?.like_count}`);
  });
}

ブックマークを作成する

cURL

curl -X POST "https://api.x.com/2/users/123/bookmarks" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tweet_id": "1234567890"}'

from xdk import Client

client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

# ポストをブックマークに追加する
response = client.bookmarks.create(user_id="123", tweet_id="1234567890")
print(response.data)

import { Client } from "@xdevplatform/xdk";

const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });

// ポストをブックマークに追加する
const response = await client.bookmarks.create("123", { tweetId: "1234567890" });
console.log(response.data);

概要

投稿

ユーザー

ダイレクトメッセージ

いいね

リスト

スペース

コミュニティ

コミュニティノート

トレンド

ニュース

メディア

X のアクティビティ

利用状況

ストリーム接続

コンプライアンス

Enterprise v2

いいねのストリーム

GNIP 2.0

便利なツール

Postman

コードサンプル

サードパーティライブラリ

主要な概念

認証

開発者コンソール、Project、開発者 App

レート制限

コード例

ブックマークを取得

ブックマークを作成する

​便利なツール

​Postman

​コードサンプル

​サードパーティライブラリ

​主要な概念

​認証

​開発者コンソール、Project、開発者 App

​レート制限

​コード例

​ブックマークを取得

​ブックマークを作成する

便利なツール

Postman

コードサンプル

サードパーティライブラリ

主要な概念

認証

開発者コンソール、Project、開発者 App

レート制限

コード例

ブックマークを取得

ブックマークを作成する