チュートリアル
Postmanの利用開始方法
関連商品
はじめに
Postmanは、ユーザーインターフェイス内のAPIにリクエストを行うことができるRESTクライアントです。これは、新しいエンドポイントで作業しているときに役立ちます。Postmanを使用するには、まずTwitter開発者アカウントに申し込む必要があります。アカウントが承認されたら、アプリを作成します。
この例では、Twitter Developer Labsのツイートとユーザープレビューを使用します。まず、Labsに登録し、作成したアプリをこのプレビューにアタッチします。また、作成したばかりの認証情報を使用してベアラートークンも作成します。
Postmanの使用
まず、Postmanをダウンロードします。Labs用のPostmanコレクションをダウンロードすると、起動と実行を少し速くすることができます。コレクションをダウンロードしたら、Tweets and Users v2というフォルダーにあるツイートとユーザーの例を変更します。GET Single user by usernameという例を選択します。
探しているユーザー名を含むようにパス変数を調整します。Path Variablesと表示されている場合は、ペイロードを表示するTwitterユーザー名を含むように値を変更します。この例では、TwitterDevというユーザー名を使用しています。
これは次のようになります。
青い送信ボタンを押す前に、認証設定を調整します。Authorizationというタブをクリックします。[type] でBearer Tokenを選択します。Tokenの横のボックスに、作成したベアラートークンを追加します。
入力した完全なアドレスは、次のようになります。
https://api.x.com/labs/2/users/by/username/:username
ベアラートークンを追加したら、sendという青いボタンを押してリクエストを送信します。
これで、以下のようなペイロードが表示されるはずです。
{
"data": {
"id": "2244994945",
"name": "Twitter Dev",
"username": "TwitterDev"
}
}
リクエストに拡張を追加すると、1回の応答で追加の参照オブジェクトとそのフィールドをリクエストできます。Query Paramsと表示されている場所で、expansionsの横のボックスにチェックを入れ、Paramsフォルダー内のvalueの下に「pinned_tweet_id」と入力します。
この時点で、入力したアドレスは以下のようになっているはずです。
https://api.x.com/labs/2/users/by/username/:username?expansions=pinned_tweet_id
ここで、送信ボタンを押すと、以下のようなペイロードを取得できます。
{
"data": {
"id": "2244994945",
"name": "Twitter Dev",
"pinned_tweet_id": "1214281000932593667",
"username": "TwitterDev"
},
"includes": {
"tweets": [
{
"id": "1214281000932593667",
"text": "Hello… is it me you’re searching for? 🔎\n\nSearch the conversation as it unfolds with this new addition to Labs. We're making it easier than ever to find the Tweets you care about. https://t.co/HmuuUC6PKZ https://t.co/QgEXeL9XzX"
}
]
}
}
ツイートの詳細
これで最初のリクエストの実行が完了しました。おめでとうございます。
次のリクエストを行うには、GET Tweetsを使用してTwitterDevの最新のツイートの詳細を確認します。設定するには、先ほど使用したフォルダーからGET Tweetsというタイトルのサンプルリクエストをクリックします。
まず、先ほどと同様に、Paramsフォルダー内のPath Variablesの下にあるボックスにチェックを入れて、URLを変更します。最後の例では、次のJSONのキーと値のペアを調べると、最新のツイートIDは1175170649968349184であることがわかりました。"pinned_tweet_id": "1214281000932593667".
fieldsパラメーターを使用すると、Labs v2エンドポイントを使用してAPI応答で返すデータの追加フィールドを指定できます。tweet.fieldsというタイトルのボックスを選択し、valueの下に次のように入力します。
attachments,author_id,created_at,entities,geo,id,in_reply_to_user_id,lang,possibly_sensitive,public_metrics,referenced_tweets,source,text,withheld
また、前のリクエストで行ったように、このプロセスの前半で作成したものと同じベアラートークンを使用して、認証設定を更新します。
変更が完了したら、青い送信ボタンを押せます。ボタンを押すと、次のペイロードが表示されます。
{
"data": {
"attachments": {
"media_keys": [
"16_1214280974223237120"
]
},
"author_id": "2244994945",
"created_at": "2020-01-06T20:22:05.000Z",
"entities": {
"urls": [
{
"start": 179,
"end": 202,
"url": "https://t.co/HmuuUC6PKZ",
"expanded_url": "https://twittercommunity.com/t/new-recent-search-endpoint-available-in-labs/133076",
"display_url": "twittercommunity.com/t/new-recent-s…"
},
{
"start": 203,
"end": 226,
"url": "https://t.co/QgEXeL9XzX",
"expanded_url": "https://twitter.com/TwitterDev/status/1214281000932593667/photo/1",
"display_url": "pic.twitter.com/QgEXeL9XzX"
}
]
},
"id": "1214281000932593667",
"lang": "en",
"possibly_sensitive": false,
"public_metrics": {
"retweet_count": 60,
"reply_count": 39,
"like_count": 149,
"quote_count": 13
},
"source": "Twitter Web App",
"text": "Hello… is it me you’re searching for? 🔎\n\nSearch the conversation as it unfolds with this new addition to Labs. We're making it easier than ever to find the Tweets you care about. https://t.co/HmuuUC6PKZ https://t.co/QgEXeL9XzX"
}
次の手順
Postmanで [code] というボタンをクリックすると、先ほど作成したリクエストをPython、Node、Rubyなどの好みの言語に変換して開始できます。Postmanには役立つ優れたドキュメントがあります。GitHubのサンプルコードを参照することもできます。詳細については、Labsに関するドキュメントも参照してください。
ソリューション作成の準備が整った方は