API:プロパティ

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Properties and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎polski • ‎português • ‎română • ‎български • ‎русский • ‎українська • ‎עברית • ‎हिन्दी • ‎ไทย • ‎中文 • ‎日本語

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

APIの説明文書

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

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

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

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

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

追加的な注記

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

関連項目