クエリ仕様
CiNii Books図書・雑誌書誌検索のOpenSearchクエリは以下の形式です。
https://ci.nii.ac.jp/books/opensearch/search?(パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です。
クエリを構成する各パラメータは以下のとおりです。これ以外のパラメータの記述は無視します。
No. | 項目名 | パラメータ名 | 論理式の記述可否 | 備考 | |
---|---|---|---|---|---|
1 | フリーワード | q | 可(AND) | 部分一致テキスト検索 | |
2 | タイトル | title | 可(AND) | 部分一致テキスト検索 | |
3 | タイトル完全一致検索フラグ | title_exact | 不可 | trueまたはfalseを指定して検索します。完全一致検索をしたい場合はtrueを指定してください。 | |
4 | 統一タイトル検索対象フラグ | include_utl | 不可 | trueまたはfalseを指定して検索します。タイトル検索の際に統一タイトルを検索対象に含めたい場合trueを指定してください。 | |
5 | 著者名 | author | 可(AND) | 部分一致テキスト検索 | |
6 | 著者名別名検索対象フラグ | include_alias | 不可 | trueまたはfalseを指定して検索します。著者名検索の際に著者別名を検索対象に含めたい場合trueを指定してください。 | |
7 | 出版者 | publisher | 可(AND) | 部分一致テキスト検索 | |
8 | 件名 | subject | 可(AND) | 部分一致テキスト検索 | |
9 | 注記 | note | 可(AND) | 部分一致テキスト検索 | |
10 | 著者ID | authorid | 可(OR) | 完全一致。 | |
11 | 統一タイトルID | utid | 可(OR) | 完全一致。 | |
12 | ISBN | isbn | 可(OR) | 完全一致。 10桁/13桁のどちらでも検索できます。ハイフンは無視されます。 | |
13 | ISSN | issn | 可(OR) | 完全一致。ハイフンは無視されます。 | |
14 | NCID | ncid | 可(OR) | 完全一致。 | |
15 | 分類 | clas | 可(OR) | 完全一致。最後に「*」をつけることで前方一致検索も可能です。 | |
16 | 一般資料種別 | gmd | 可(OR) | コードは一般資料種別コード表を参照。ただし、コード値無しはアンダースコア1文字を指定すること | |
17 | 言語種別 | lang | 可(OR) | 言語種別をコードで指定する。コードは言語コード表を参照。 | |
18 | 参加館ID | fano | 可(OR) | 完全一致。 | |
19 | 参加機関ID | kid | 可(OR) | 完全一致。 | |
20 | エリア | area | 可(OR) | 所蔵図書館の地域を指定して検索。参加組織レコードコード一覧のKENコードを指定。 | |
21 | 出版年(開始) | year_from | 不可 | 西暦年。指定された年を含む | どちらか片方だけの指定も可能です。(その場合でも出版年不明の書誌は検索対象外となります) |
22 | 出版年(終了) | year_to | 不可 | 西暦年。指定された年を含む | |
23 | 資料種別 | type | 不可 | 0:無指定(デフォルト)、1:図書、2:雑誌 | |
24 | 出力フォーマット | format | 不可 | atom:ATOM形式(デフォルト)、rss: RSS形式、 json: JSON-LD形式、html:HTML形式 | |
25 | ソート順 | sortorder | 不可 | 1:検索スコア順(デフォルト)、2:出版年昇順、3:出版年降順、4:所蔵館数昇順、5:所蔵館数降順 | |
26 | ページ番号 | p | 不可 | 最初のページを1とします。 | |
27 | 1ページあたりの結果数 | count | 不可 | デフォルト20 | |
28 | アプリケーションID | appid | 不可 | 必須です。 |
- 論理式の記述が可能な項目においては、大文字のAND,OR,NOT演算子及び括弧 (,) を使って条件を組み立てられます。
- AND,OR,NOTとワードの間には空白が必要です。演算子を指定せずに列挙した場合はデフォルトの演算子(表中で括弧書きされた演算子)が使用されます。
レスポンス仕様
クエリでレスポンスのフォーマットを、RSS, Atom, JSON-LD, HTMLから選択できます。
レスポンスの際のhttpヘッダに「Access-Control-Allow-Origin: *」を指定していますので、クロスドメイン間での非同期通信をご利用いただけます。
RSS1.0 レスポンスフォーマット仕様
No. | タグ名 | 必須 | 内容 | 備考 | |||||
---|---|---|---|---|---|---|---|---|---|
第1階層 | 第2階層 | 第3階層 | 第4階層 | 第5階層 | 属性 | ||||
1 | xml | 必須 | XML文書であることを宣言 | <?xml version="1.0" encoding="utf-8" ?> | |||||
2 | rdf:RDF | 必須 | 文書のルート要素 | xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。 | |||||
<rdf:RDF | |||||||||
xmlns | xmlns="http://purl.org/rss/1.0/" | ||||||||
xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | ||||||||
xmlns:rdfs | xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" | ||||||||
xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | ||||||||
xmlns:prism | xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" | ||||||||
xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | ||||||||
xmlns:dcterms | xmlns:dcterms="http://purl.org/dc/terms/" | ||||||||
xmlns:cinii | xmlns:cinii="http://ci.nii.ac.jp/ns/1.0/" | ||||||||
xml:lang | xml:lang=”ja”> | ||||||||
3 | channel | rdf:about | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
4 | title | 必須 | タイトル | 「CiNii Books OpenSearch -」にクエリを連結したもの。 例: <title>CiNii Books OpenSearch - 検索エンジン 順位</title> |
|||||
5 | description | 必須 | タイトル | titleと同じ内容 | |||||
6 | link | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | |||||
7 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
8 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
9 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
10 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
11 | items | 必須 | |||||||
12 | rdf:Seq | 必須 | |||||||
13 | rdf:li | rdf:resource | 必須 | 書誌詳細ページのURI | レスポンスに含まれる図書・雑誌へのパーマリンクを列挙。最大でopensearch:itemsPerPageの数まで繰り返す | ||||
14 | item | rdf:about | 必須 | 図書・雑誌情報 | 最大でopensearch:itemsPerPageの数まで繰り返す。rdf:aboutにはパーマリンクを記述。 例: <item rdf:about="http://ci.nii.ac.jp/ncid/XX12345678"> |
||||
15 | title | 必須 | タイトル | ||||||
16 | link | 必須 | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <link>http://ci.nii.ac.jp/ncid/XX12345678</link> |
|||||
17 | rdfs:seeAlso | rdf:resource | 必須 | 書誌RDFのURI | 書誌RDFのURIを表示(ただしappidのパラメータは除く) <rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/ncid/XX12345678.rdf" /> |
||||
18 | dc:creator | 必須 | 著者名 | ||||||
19 | dc:publisher | 出版者 | |||||||
20 | prism:publicationDate | 出版年 | W3CDTF表記 | ||||||
21 | dc:date | 出版年 | prism:publicationDateと同じ内容 | ||||||
22 | dcterms:isPartOf | 親書誌に関する記述 | 親書誌(シリーズ名)が複数ある場合は繰り返す。 例: <dcterms:isPartOf rdf:resource="http://ci.nii.ac.jp/ncid/BN06190301" dc:title="丸善ライブラリー"/> |
||||||
23 | rdf:resource | 必須 | 親書誌のURI | 親書誌(シリーズ名)の書誌詳細ページのURI | |||||
24 | dc:title | 必須 | 親書誌のタイトル | シリーズの中での番号等も含む | |||||
25 | dcterms:hasPart | ISBN, ISSNに関する記述 | ISBN, ISSNの数分繰り返す。 例: <dcterms:hasPart rdf:resource="urn:isbn:9784621053812"/> <dcterms:hasPart rdf:resource="urn:issn:09133801"/> |
||||||
26 | rdf:resource | 必須 | ISBN, ISSN | URN形式 | |||||
27 | cinii:ownerCount | 必須 | 所蔵館数 | 対象の図書・雑誌を所蔵する図書館の数 例: <cinii:ownerCount>63</cinii:ownerCount> |
Atom1.0 レスポンスフォーマット仕様
No. | タグ名 | 必須 | 内容 | 備考 | ||||
---|---|---|---|---|---|---|---|---|
第1階層 | 第2階層 | 第3階層 | 第4階層 | 属性 | ||||
1 | xml | 必須 | XML文書であることを宣言 | <?xml version="1.0"encoding="UTF-8" ?> | ||||
2 | feed | 必須 | 文書のルート要素 | xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。 | ||||
<feed | ||||||||
xmlns | xmlns="http://www.w3.org/2005/Atom" | |||||||
xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
xmlns:prism | xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" | |||||||
xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
xmlns:dcterms | xmlns:dcterms="http://purl.org/dc/terms/" | |||||||
xmlns:cinii | xmlns:cinii="http://ci.nii.ac.jp/ns/1.0/" | |||||||
xml:lang | xml:lang=”ja”> | |||||||
3 | title | 必須 | フィードのタイトル | 「CiNii Books OpenSearch - 」 に検索語を連結したもの。 例: <title>CiNii Books OpenSearch - インタラクション+大向</title> |
||||
4 | link | href | 必須 | 検索ページのURL | 同等内容の検索をHTMLで行う場合のURL | |||
5 | link | rel | 必須 | 参照先の文書との関係 | 固定値(self) | |||
6 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値(application/atom+xml) | ||||
7 | href | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
8 | id | 必須 | リクエストされたURI | link要素と同じ | ||||
9 | updated | 必須 | 検索が行われた日時 | W3CDTF表記 | ||||
10 | opensearch:totalResults | 必須 | 検索結果総数 | |||||
11 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | ||||
12 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | ||||
13 | entry | 検索結果の図書・雑誌情報を格納するコンテナ | 最大でopensearch:itemsPerPageの数まで繰り返す。 | |||||
14 | title | 必須 | タイトル | |||||
15 | link | href | 必須 | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <link href="http://ci.nii.ac.jp/ncid/XX12345678"/> |
|||
16 | link | rel | 必須 | 参照先の文書との関係 | 固定値(alternate) | |||
17 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値(application/rdf+xml) | ||||
18 | href | 必須 | 書誌RDFのURI | 書誌RDFのURIを表示(ただしappidのパラメータは除く) href="http://ci.nii.ac.jp/ncid/XX12345678.rdf" |
||||
19 | id | 必須 | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <id>http://ci.nii.ac.jp/ncid/XX12345678</id> |
||||
20 | author | 必須 | 著者に関する記述 | |||||
21 | name | 必須 | 著者名 | |||||
22 | dc:publisher | 出版者 | ||||||
23 | prism:publicationDate | 出版年月日 | W3CDTF表記 | |||||
24 | updated | 出版年月日 | prism:publicationDateと同じ内容 | |||||
25 | dcterms:isPartOf | 親書誌に関する記述 | 親書誌(シリーズ名)が複数ある場合は繰り返す。 例: <dcterms:isPartOf dc:title="丸善ライブラリー">http://ci.nii.ac.jp/ncid/BN06190301</dcterms:isPartOf> |
|||||
26 | dc:title | 必須 | 親書誌のタイトル | シリーズの中での番号等も含む | ||||
27 | 必須 | 親書誌のURI | 親書誌(シリーズ名)の書誌詳細ページのURI | |||||
28 | dcterms:hasPart | ISBN, ISSN | URN形式。ISBN, ISSNの数分繰り返す。 例: <dcterms:hasPart>urn:isbn:9784621053812</dcterms:hasPart> <dcterms:hasPart >urn:issn:09133801</dcterms:hasPart> |
|||||
29 | cinii:ownerCount | 必須 | 所蔵館数 | 対象の図書・雑誌を所蔵する図書館の数 例: <cinii:ownerCount>63</cinii:ownerCount> |
JSON-LD レスポンスフォーマット仕様
No. | タグ名 | 型 | 必須 | 内容 | 備考 | ||||
---|---|---|---|---|---|---|---|---|---|
第1階層 | 第2階層 | 第3階層 | 第4階層 | 第5階層 | |||||
1 | @context | オブジェクト | 必須 | 文書のルート要素 | "@context": { "dc": "http://purl.org/dc/elements/1.1/", "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "opensearch": "http://a9.com/-/spec/opensearch/1.1/", "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "dcterms": "http://purl.org/dc/terms/", "prism": "http://prismstandard.org/namespaces/basic/2.0/", "cinii": "http://ci.nii.ac.jp/ns/1.0/", "@vocab": "http://purl.org/rss/1.0/" }, |
||||
2 | @vocab | 必須 | http://purl.org/rss/1.0/ | ||||||
3 | dc | 必須 | http://purl.org/dc/elements/1.1/ | ||||||
4 | dcterms | 必須 | http://purl.org/dc/terms/ | ||||||
5 | rdf | 必須 | http://www.w3.org/1999/02/22-rdf-syntax-ns# | ||||||
6 | opensearch | 必須 | http://a9.com/-/spec/opensearch/1.1/ | ||||||
7 | rdfs | 必須 | http://www.w3.org/2000/01/rdf-schema# | ||||||
8 | prism | 必須 | http://prismstandard.org/namespaces/basic/2.0/ | ||||||
9 | cinii | 必須 | http://ci.nii.ac.jp/ns/1.0/ | ||||||
10 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
11 | @graph | 配列 | 必須 | 配列の要素数は1 | |||||
12 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
13 | @type | 必須 | 固定:"channel" | ||||||
14 | title | 必須 | タイトル | 「CiNii Books OpenSearch -」にクエリを連結したもの。 例: "title":"CiNii Books OpenSearch - 検索エンジン 順位", |
|||||
15 | description | 必須 | タイトル | titleと同じ内容 | |||||
16 | link | オブジェクト | 必須 | ||||||
17 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
18 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
19 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
20 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
21 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
22 | items | 配列 | |||||||
23 | @id | 必須 | 書誌詳細ページのURI | レスポンスに含まれる図書・雑誌へのパーマリンク | |||||
24 | @type | 必須 | 固定:"item" | ||||||
25 | title | 必須 | タイトル | ||||||
26 | link | オブジェクト | 必須 | ||||||
27 | @id | 必須 | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 "link": {@id:"http://ci.nii.ac.jp/ncid/XX12345678"}, |
|||||
28 | rdfs:seeAlso | オブジェクト | 必須 | ||||||
29 | @id | 必須 | 書誌JSON-LDのURI | 書誌JSON-LDのURIを表示(ただしappidのパラメータは除く) "rdfs:seeAlso":{@id:"http://ci.nii.ac.jp/ncid/XX12345678.json"}, |
|||||
30 | dc:creator | 著者名 | |||||||
31 | dc:publisher | 出版者 | |||||||
32 | prism:publicationDate | 出版年 | W3CDTF表記 | ||||||
33 | dc:date | 出版年 | prism:publicationDateと同じ内容 | ||||||
34 | dcterms:isPartOf | 配列 | 親書誌に関する記述 | 親書誌(シリーズ名)が複数ある場合はdcterms:isPartOf配下で繰り返す。 例: "dcterms:isPartOf":[{"@id":"http://ci.nii.ac.jp/ncid/BN06190301","dc:title":"丸善ライブラリー"}], |
|||||
35 | @id | 必須 | 親書誌のURI | 親書誌(シリーズ名)の書誌詳細ページのURI | |||||
36 | dc:title | 必須 | 親書誌のタイトル | シリーズの中での番号等も含む | |||||
37 | dcterms:hasPart | 配列 | ISBN, ISSNに関する記述 | ISBN, ISSNの数分、dcterms:hasPartf配下で繰り返す。 例: "dcterms:hasPart":[{"@id":"urn:isbn:4591095142"},{"@id":"urn:isbn:9784591095607"},{"@id":"urn:isbn:9784591097526"}], |
|||||
38 | @id | 必須 | ISBN, ISSN | URN形式 | |||||
39 | cinii:ownerCount | 必須 | 所蔵館数 | 対象の図書・雑誌を所蔵する図書館の数 例: "cinii:ownerCount":"179" |
改訂履歴
2013年4月以降の改訂履歴をご確認いただけます。
2018年1月18日
- レスポンスフォーマット仕様に以下を追加しました。
- XML言語定義(xml:lang)
2015年3月13日
- JSON-LD レスポンスフォーマットを一部変更しました。詳細は以下のとおりです。
- "items"タグをオブジェクトから配列に変更しました。
- "rdf:Seq"と"rdf:li" タグを採用しない形式に変更しました。
- JSON-LDによるCiNii ウェブAPIをベータ版としていましたが、上記の変更をもって正式版としました。
2013年10月11日
- クエリ仕様の出力フォーマット(format)にJSON-LD形式(json)を追加しました。
- レスポンスフォーマット仕様にJSON-LD(ベータ版)を追加しました。
- クロスドメイン間の非同期通信に対応しました。
2013年7月12日
- レスポンスフォーマット仕様に以下を追加しました。
- 所蔵館数(cinii:ownerCount)
2013年5月10日
- クエリ仕様に以下を追加しました。
- タイトル完全一致検索フラグ(title_exact)
- 統一タイトル検索対象フラグ(include_utl)
- 著者名別名検索対象フラグ(include_alias)
- 統一タイトルID(utid)
2013年4月19日
- レスポンスフォーマット仕様に以下を追加しました。
- 親書誌(シリーズ名)(dcterms:isPartOf)
- ISBN, ISSN(dcterms:hasPart)