API:Query/ja

action=querymoduleによって、大部分のデータを取り出せるようになります. 編集トークンを含みます.

queryモジュールは多くの下位モジュールを持ち(query modulesと呼ばれる)、それぞれの下位モジュールには異なる機能があります. queryモジュールには3つのタイプがあります:
 * wikiとログインユーザに関するメタ情報
 * ページのプロパティ
 * ある基準を満たすページの一覧

Multiple modules should be used together to get what you need in one request, e.g.  is a call to six modules in one request.

Unlike meta and list modules, all property modules work on a set of pages provided with either,  ,  , or   parameters. Use the first three if you know page's title/page id/revision id. Do not ask for one page at a time - this is very inefficient, and consumes lots of extra resources and bandwidth. You should combine multiple titles or ids with a "|" symbol:.

Use generator if you want to get data about pages that are the result of another api call. For example, if you want to get data about pages in a certain category, and then call api with pageids set to all the returned results, you should combine two calls into one by setting  instead of the list parameter.

Lastly, you should always request the new "continue" syntax to iterate over results. To use it, always pass an empty  parameter, and check if the result contains a   section. If it does, merge returned values with the original request and call the api again. Repeat until there is no more  section.

Sample query
Before we get into the nitty-gritty, here's a useful sample query that simply gets the wiki markup (content) of a page:

api.php?action=query&prop=revisions&rvprop=content&format=xml&titles=Main%20Page

This means fetch (action=query) the content (rvprop=content) of the most recent revision of Main Page (titles=Main%20Page) in XML format (format=xml).

Alternatively, you can use  as a parameter to index.php to get the content of a page: index.php?title=Main%20Page&action=raw

Specifying pages
You can specify pages in the following ways:
 * By name using the  parameter, e.g.
 * By page ID using the  parameter, e.g.
 * By revision ID using the  parameter, e.g.
 * Most query modules will convert revision ID to the corresponding page ID. Only prop=revisions actually uses the revision ID itself.
 * Using a generator

Specifying titles through the query string (either through  or  ) is limited to 50 titles per query (or 500 for those with the   right, usually bots and sysops).

タイトルの正規化
タイトルの正規化はページタイトルを正統的な形式に変換します. 最初の文字は大文字に変換され、アンダースコアはスペースに置き換えられるなどのことが行われることを意味します. どのqueryモジュールが使われているかに関わらず、タイトルの正規化は自動的に行われます. However, any trailing line breaks in page titles (\n) will cause odd behavior and they should be stripped out first.

見つからないもしくは無効なタイトル
存在しないもしくは無効なタイトルが セクションに表示されますが、but それらは もしくは 属性のセットを持ちます. (JSONやPHPのシリアライズ化などの)数値の配列キーをサポートする出力フォーマットにおいて、見つからないタイトルと無効なタイトルはユニークで、負のページIDを持ちます. query modulesは見つからないもしくは無効なタイトルで何か便利なことはできないのでそれらのタイトルを無視します. The titles in the Special: and Media: namespaces cannot be queried. If any such titles are found in the  parameter or passed to a module by a generator, a warning will be issued.

リダイレクトを解決する
リダイレクトは自動的に解決されるので、リダイレクトのターゲットが任意のタイトルの代わりに返されます. 下記の例は本当に役立ちません. それはquery modulesを使わないからですが、 パラメーターの動作方法を示します. 標準化とリダイレクトの両方が起こることがあります. 二重のリダイレクトの場合、すべてのリダイレクトは解決され、循環リダイレクトの場合、'pages'セクションにページが存在しないことがあります(下記も参照). Redirect resolution cannot be used in combination with the  parameter or with a generator generating revids; doing that will produce a warning and will not resolve redirects for the specified revids.

制限
See here for more information on limits.

クエリの続行

 * See legacy continue for the  information

Very often you will not get all the data you want in one request. If there is more data, the result will have a  element. Appending contained values to your original request will get the next portion of the data. Due to legacy reasons, until we introduce API 2.0, you should always include a  parameter to let the servers know you support this feature.

You can now add  and   to the original request (the new value for   would replace the initial empty string) to get the next set of results. If there is no more results, there will not be a  element.

Here is the recommended way to iterate over query results (uses python requests lib). Note that clients should not be manipulating or depending on any specifics of the values returned inside the  element, as they may change.

Getting a list of page IDs
With the  parameter, you'll get a list of all page IDs listed in the   element. This is particularly useful for formats like JSON in which the pages array has numeric indexes.

Exporting pages
You can export pages through the API with the  parameter. If the  parameter is set, an XML dump of all pages in the   element will be added to the result. The  parameter only gives a result when used with specified titles (Generator, ,   or  ). Note that the XML dump will be wrapped in the requested format; if that format is XML, characters like &lt; and &gt; will be encoded as entities (&amp;lt; and &amp;gt;) If the  parameter is also set, only the XML dump (not wrapped in an API result) will be returned.

関連項目: ページの取り込み

ジェネレーター
ジェネレーターによって、 パラメーターの代わりにリストの出力を使うことができます. リストの出力はページのリストでなければなりません. , もしくは パラメーターの代わりに、そのタイトルが自動的に使われます. 多のquery modulesは パラメーターを通してあたかもユーザーによって提供されたものとしてそれらのページを取り扱います. 1つのジェネレーターのみが許可されます. ページのリストを表示しないlist modulesはジェネレーターとして使うことはできません. prop modulesの中にはジェネレーターとして使うことができるものもあります.

ジェネレーターに渡されたパラメーターは接頭辞が'g'でなければなりません. 例えば、generator=backlinksを使うとき、 の代わりに を使ってください.

ジェネレーターはページタイトルを'real'クエリに渡すだけで、それら自身の情報を出力できないことに注意してください. のようなパラメーターを設定しても効果はありません.

ジェネレーターとリダイレクト
ここでは、prop=linksをジェネレーターとして使います. このクエリはTitleからリンクされたすべてのページからのすべてのリンクを取得します. この例では、TitleはTitleAとTitleBへのリンクを持つことを仮定します. TitleBはTitleCへのリダイレクトです. TitleAはTitleA1、TitleA2、TitleA3にリンクします; そしてTitleCはTitleC1とTitleC2にリンクします. パラメーターが設定されているので、リダイレクトは解決されます.

クエリは次のステップを実行します:
 * 1)  パラメーターでタイトルに対するリダイレクトを解決する
 * 2)  パラメーターのすべてのタイトルに対して、それらがリンクするページのリストを取得する
 * 3) そのリストでリダイレクトを解決する
 * 4) タイトルのそのリスト上でprop=linksクエリを実行する

ジェネレーターのより詳しい例

 * "T"の文字で始まる4ページに関する情報を表示する
 * http://en.wikipedia.org/w/api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info


 * "Re"で始まる最初の2つの非リダイレクトのページの内容を表示する
 * http://en.wikipedia.org/w/api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

Possible warnings

 * No support for special pages has been implemented
 * Thrown if a title in the Special: or Media: namespace is given
 * Redirect resolution cannot be used together with the revids= parameter. Any redirects the revids= point to have not been resolved.
 * Note that this can also be caused by a generator that generates revids