指定したユーザーがフォローしている(もしくは “friends”である)全てのユーザーのIDを、選択したページの分だけ取得します 。
この時、取得結果の並びは新しい順になります。 — しかしこの並び順は予告なく変更されることがあるので、結果整合性問題の対象となります。
結果は5000個のユーザーIDを1グループとしてページに取得し、結果が複数のページにまたがる場合は、次のリクエストでnext_cursorを使って以降のページ分を取得します。詳細情報については Using cursors to navigate collections を参照してください。
このメソッドは、複数のユーザーIDを完全なユーザーオブジェクトに一括変換するGET users / lookupと組み合わせて使うと特に強力です。
GET friends/
|
https://api.twitter.com/1.1/friends/ids.json
Resource URL
|
Resource Information
Response formats
JSON
Requires authentication?
Yes
Rate limited?
Yes
Requests / 15-min window (user auth)
15
Requests / 15-min window (app auth)
15
|
screen_name か user_id のどちらかは必ず設定してください。
結果を取得するユーザーのID。
サンプル値: 12345
結果を取得するユーザーのスクリーンネーム。
サンプル値: noradio
現在のところ、取得するIDが5000を超えると複数のページに分割されます。
クエリ後にアカウント停止中のユーザーがフィルタされるので、取得されるIDの数は必ず5000になる訳ではありません。 cursor が設定されなかった場合、一番最初のページを表す -1が設定されたと見なされます。
API からの応答には previous_cursorパラメータと next_cursorパラメータが含まれており、これを使って前後のページを操作できます。 詳細情報についてはour cursor docs を参照してください。
サンプル値: 12893764510938
多くのプログラミング環境では、桁サイズが原因でTwitterのIDを使用することができません。このオプションを設定することで、IDを数字ではなく文字列として取得できます。 詳細については Twitter IDsを参照してください。
サンプル値: true
検索するIDの数を指定します。一回のリクエストで最大5000個まで検索できます。
count値は取得する検索結果の数を制限するものとして考えるのがベストです。
このメソッドでcount パラメータを使う場合は、同一ユーザーのコレクション宛のリクエストには、全て同じ値のcountを使用するのが良いでしょう。
Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.
サンプル値: 2048
ParametersEither a
user_id
optional
The ID of the user for whom to return results for. Example Values:
screen_name
optional
The screen name of the user for whom to return results for. Example Values:
cursor
semi-optional
Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of Example Values:
stringify_ids
optional
Many programming environments will not consume our Tweet ids due to their size. Provide this option to have ids returned as strings instead. More about Twitter IDs. Example Values:
count
optional
Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of Example Values: |
ログインして登録アプリケーションの一覧を参照してください。
OAuth Signature GeneratorSign in to see a list of your registered applications. |
GET
https://api.twitter.com/1.1/friends/ids.json?cursor=-1&screen_name=twitterapi&count=5000
Example RequestGET
|
{
"previous_cursor": 0,
"ids": [
657693,
183709371,
7588892,
38895958,
22891211,
9019482,
14488353,
11750202,
12249,
22915745,
1249881,
14927800,
1523501,
22548447,
15062340,
133031077,
17874544,
777925,
4265731,
27674040,
26123649,
9576402,
821958,
7852612,
819797,
1401881,
8285392,
9160152,
795649,
3191321,
783214
],
"previous_cursor_str": "0",
"next_cursor": 0,
"next_cursor_str": "0"
}
Example Result{
"previous_cursor": 0,
"ids": [
657693,
183709371,
7588892,
38895958,
22891211,
9019482,
14488353,
11750202,
12249,
22915745,
1249881,
14927800,
1523501,
22548447,
15062340,
133031077,
17874544,
777925,
4265731,
27674040,
26123649,
9576402,
821958,
7852612,
819797,
1401881,
8285392,
9160152,
795649,
3191321,
783214
],
"previous_cursor_str": "0",
"next_cursor": 0,
"next_cursor_str": "0"
}
|