このクイックスタートガイドでは、Postman を使用し、指定した一連の fields を含めてフルアーカイブ検索エンドポイントへ最初のリクエストを送る方法を説明します。
各種言語のサンプルコードは、GitHub の X API v2 sample code リポジトリをご覧ください。
前提条件
フルアーカイブ検索エンドポイントは現在、プロおよびエンタープライズのアクセスでのみ利用可能です。このエンドポイントを使用するには、プロアクセスへアップグレードするか、エンタープライズのアクセスレベルを申請してください。アクセスの承認に加えて、リクエストを認証するためのキーとトークンが必要です。以下の手順でキーとトークンを生成できます。
-
開発者ポータルで、エンタープライズまたはプロのアクセスが付与されたProjectに移動し、その Project 内に関連付けられたdeveloper Appがあることを確認します。
-
アプリの「Keys and tokens」ページに移動し、必要なクレデンシャルを生成します。すべてのクレデンシャルは安全な場所に保存してください。
from:XDevelopers
Postman で「Params」タブに移動し、この ID、またはカンマ区切りの Post の ID の文字列を、ids パラメータの「Value」列に入力します。
| Key | Value | Description |
|---|
query | from:XDevelopers | フルアーカイブ検索エンドポイントに送信する検索クエリ |
id、text、edit_history_tweet_ids。編集機能が導入される前の Post が返る場合、edit_history_tweet_ids フィールドは含まれません。このフィールドの履歴バックフィルは実施されていません。
これらのデフォルト fields を超えて追加の fields が必要な場合は、リクエストで fields および/または expansions パラメータを使用して指定します。
この演習では、異なるオブジェクトから4種類の fields セットをリクエストします。
- デフォルトの Post オブジェクトの fields
- プライマリの Post オブジェクトにおける追加の tweet.created_at フィールド
- 返された Post に関連する投稿者の user オブジェクトのデフォルト fields
- 関連するユーザーオブジェクトにおける追加の user.description フィールド
Postman で「Params」タブに移動し、次の key:value を「Query Params」テーブルに追加します。
| Key | Value | Returned fields |
|---|
tweet.fields | created_at | tweets.created_at |
expansions | author_id | includes.users.id, includes.users.name, includes.users.username |
| user.fields | description | includes.users.description |
https://api.x.com/2/tweets/search/all?query=from:XDevelopers&tweet.fields=created_at&expansions=author_id&user.fields=created_at
ご注意くださいデフォルトでは、最新の Post が最大10件だけ返されます。1回のリクエストで10件を超える Post を取得したい場合は、max_results パラメータを使用し、1リクエストあたり最大500件の Post を指定できます。同様に、デフォルトでは直近30日分の Post が返されます。30日より古い Post を取得したい場合は、API コールで start_time と end_time パラメータを使用してください。
{
"data": [
{
"author_id": "2244994945",
"created_at": "2020-06-11T16:05:06.000Z",
"id": "1271111223220809728",
"text": "今夜は@jessicagarsonがお気に入りのPythonパッケージをRで実行する方法をご紹介します。🍿\n\nデータサイエンスのための2つの強力なプログラミング言語を組み合わせて使う方法を学び、TwitterのDeveloper Labsの最近の検索エンドポイントを使用したライブデモをご覧ください。https://t.co/v178oUZNuj"
},
{
"author_id": "2244994945",
"created_at": "2020-06-10T19:25:24.000Z",
"id": "1270799243071062016",
"text": "新しいTwitter APIの構築に向けて取り組む中、いくつかのLabs v1エンドポイントの廃止予定時期を延長しました。詳細はこちら 📖 https://t.co/rRWaJYJgKk"
},
{
"author_id": "2244994945",
"created_at": "2020-06-09T18:08:47.000Z",
"id": "1270417572001976322",
"text": "アノテーションはTweetについてより詳しく知るのに役立ちます。興味のあるトピックを見つけることもできます。🔬\n\nこのチュートリアルでは、@suhemparackがアノテーションとフィルタリングされたストリームエンドポイントを使用してCOVID-19に関連するTweetを見つける方法を紹介します。\n\nあなたもぜひ学んでみてください。⤵️\nhttps://t.co/qwVOgw0zSV"
}
],
"includes": {
"users": [
{
"description": "TwitterのDevRelチームの公式アカウントです。Twitter APIに関する最新情報、ニュース、イベント情報をお届けします。\n\n#BlackLivesMatter",
"id": "2244994945",
"name": "Twitter Dev",
"username": "TwitterDev"
}
]
},
"meta": {
"newest_id": "1271111223220809728",
"oldest_id": "1270417572001976322",
"result_count": 3
}
}
