API:リスト

From mediawiki.org
This page is a translated version of the page API:Lists and the translation is 100% complete.

GETリクエストを行うと、指定された条件に一致するアイテムをリストアップします。

APIの説明文書

リストは、一般にデータのリストを返します。たとえば、Wiki全体から集めたページや、 あるページに存在するリンクなどです。リストをリクエストするには、クエリ文字列の list パラメータに allimagesusercontribs などの有効なリストサブモジュールを渡します。

リストAPIの使用には、URL欄で action=query&list=list1|list2 を指定します。

リストの具体的な使用例については、個々のリストAPIページを参照してください。

追加的な注記

  • 特に断りのない限り、ほとんどのリストサブモジュールは generators として使用できます。
  • リストは properties とは異なります - データを pages の要素に追加する代わりに、それぞれのリストは query 要素で独自の分離したブランチを持ちます。
  • クエリ上限について:
    • 結果の件数の上限は、一般利用者は 500、apihighlimits 権限を持つ利用者 (主にボットと管理者) は 5000 まで引き上げて設定できます。
    • いくつかのモジュールは特定の条件でより厳しい制限を課しています。 詳細は subpage を参照してください。
    • どんな制限が自分に適用されているか分からない場合、可能な限りたくさんの結果を得るには制限をmaxに設定します。 その場合、使用された制限を示すlimits 要素が返されます。
    • あるモジュールの制限値は、モジュール・プレフィックスの後に limit が続くので、 ptlimitprotectedtitles を返す最大値、 cmlimitcategorymembers を返す最大値となります。

関連項目