API:プロパティ

This page is a translated version of the page API:Properties and the translation is 100% complete.

このページは MediaWiki 操作 API の説明文書の一部です。

選択されたページ群のプロパティを列挙する GET リクエストです。

APIの説明文書

プロパティとは、カテゴリのようなページに関するデータと、画像やリンクのようなページの内容のことです。プロパティを要求するには、クエリの prop パラメーターに、必要な情報に応じて、正しいプロパティ下位モジュールを渡します。

データを要求するページの指定は、クエリのtitles、pageids、revids のパラメータか、generator により行います。

プロパティを取得するクエリはこのような形で書きます: action=query&titles=title1&prop=property1|property2

プロパティのクエリには、必ず返却される要素数の上限があります。要素をさらに見るためには、結果のcontinue 要素に含まれる値を、元のリクエストに追加します。

プロパティを利用するためのより具体的な例を見るには、それぞれのプロパティAPIページを確認してください。

ほとんどのプロパティ下位モジュールは、特に説明がなければ、generators として使用できます。
プロパティのクエリ上限について:
- プロパティのクエリには必ず上限があります。既定の上限は 10 です。結果の件数の上限は、一般利用者は 500、apihighlimits 権限を持つ利用者 (主にボットと管理者) は 5000 まで引き上げて設定できます。いくつかのモジュールは特定の条件でより厳しい制限を課しています。
- どんな制限が自分に適用されているか分からない場合、可能な限りたくさんの結果を得るには制限に max を設定します。その場合、使用された制限を示す limits 要素が返されます。
- あるモジュールの上限パラメータは、モジュールprefixと、それに続けてlimitという単語から構成されます。例えば、imlimitは、返却されるimagesの最大件数となります。

クエリモジュールに関するドキュメント – すべてのプロパティ下位モジュールと、それに対応するパラメーターと値について簡単な説明が含まれます。
API:データベースフィールドとAPIプロパティの関連 – クエリのプロパティがMediaWiki database のフィールドとどのように関連するかについてを示した表が含まれます。
API:リスト – 類似したAPIで、allusersやrecentchangesといった、情報のリストにアクセスするためのものです。プロパティのクエリではデータをpages要素に追加しますが、それとは違い、リストはquery要素の中に別のブランチを返します。