メインページ > 国立国会図書館サーチについて > 国立国会図書館サーチが提供するOAI-PMH

国立国会図書館サーチが提供するOAI-PMH

1. OAI-PMHについて

国立国会図書館サーチ（NDLサーチ）では、Webサービスや研究開発等にご活用いただくため、NDLサーチの書誌メタデータをOAI-PMHで提供しています。
OAI-PMHとは、データの自動収集によってメタデータを交換するためのプロトコルです。OAI-PMHの基本仕様は以下のページに記述されています（国立情報学研究所による日本語訳）。
また、国立国会図書館では、これまでのNDLサーチの経験や反省をふまえ、OAI-PMHの概要と実装時の注意点などをまとめた「OAI-PMHの要点」（ZIPファイル）を公開しています。

OAI-PMHの入力形式はURL、出力形式はXMLです。リクエスト種別や取得したいメタデータの条件、フォーマット等を指定したOAI-PMHリクエスト(URL）を送信すると、NDLサーチがそのリクエストを受け取り、リクエストされた条件やフォーマット等に合致するメタデータをXML形式で返戻します。
以下で、NDLサーチのOAI-PMHの使い方をご紹介します。

2. OAI-PMHリクエストURLの作成方法

OAI-PMHのリクエストURLの構成は以下のとおりです。


NDLサーチへのリクエストURLはすべてこの「基本URL」から始まります。基本URLの後ろには、①リクエスト種別と②メタデータの選択条件を記述します。

①リクエスト種別は、次の6種類です。基本URLの後ろに、「verb=リクエスト種別」と記述します。1つのリクエストURLで設定できるリクエスト種別は1つだけです。
リクエスト種別
リクエスト種別 内容
GetRecord NDLサーチの特定の書誌1件のメタデータを取得する
Identify NDLサーチがサポートするOAI-PMHについての情報を取得する
ListIdentifiers NDLサーチの全書誌のメタデータID を取得する
ListMetadataFormats NDLサーチのサポートするメタデータの形式を取得する
ListRecords NDLサーチのメタデータを取得する
ListSets NDLサーチのサポートしているset（絞込み条件）を取得する

②メタデータの選択条件は、次の6つです。リクエスト種別の後ろに、「&選択条件=[値]&選択条件=[値]…」 と記述します。なお、リクエストの種類ごとに必須な選択条件や使用可能な選択条件が異なります。
メタデータの選択条件
選択条件 内容
identifier NDLサーチの書誌メタデータID を指定する
metadataPrefix リクエストに対して返戻されるメタデータのフォーマットを指定する。oai_dc 、dcndl （DC-NDL（RDF）） 、dcndl_simple （DC-NDL（Simple））のいずれかを選択可能。DC-NDL（RDF）およびDC-NDL（Simple）の内容は、「メタデータ」のページを参照。
from 日付(datestamp)の下限をYYYY-MM-DDまたはYYYY-MM-DDThh:mm:ssZ形式で指定する
until 日付(datestamp)の上限をYYYY-MM-DDまたはYYYY-MM-DDThh:mm:ssZ形式で指定する
set 収集対象とするsetパラメータを指定する。詳しくは後述
resumptionToken 一度では取得できないメタデータの続きを取得する場合に指定する。1回のリクエストに返戻されるデータの件数の上限は200件なので、201 件以降を取得したい場合には、200 件を取得した際に通知されるresumptionToken を指定してリクエストする
＊setパラメータについて
NDLサーチでは、特定の属性を持つメタデータのみを取得できるよう、setパラメータを設けています。setとは、メタデータを特定の属性ごとにグループ化する定義です。NDLサーチのOAI-PMHにおけるsetは、以下の5つです。
  • データプロバイダのID
  • データプロバイダグループ（資料の類型、ジャンル）のID
  • NDC
  • コレクションコード…※
  • 公開範囲（Access Rights）…※
    • ※…データプロバイダ「国立国会図書館デジタルコレクション」（ndl-dl）又は「国立国会図書館デジタルコレクション（電子書籍・電子雑誌）」（ndl-dl-online）を指定した場合のみ有効となる
データプロバイダ及びデータプロバイダグループのID については、「API提供対象データプロバイダ一覧」をご覧ください。
setパラメータを指定してリクエストした場合、setパラメータで指定したデータプロバイダないしデータプロバイダグループ、NDCの書誌メタデータのみが返戻されます。たとえば、データプロバイダに「国立国会図書館オンライン」を指定する場合は、「set=iss-ndl-opac」のように指定します。NDC分類「735」のものを指定する場合は「set=735」とします。データプロバイダが「国立国会図書館オンライン」かつNDC分類「735」のものを指定する場合は、「set=iss-ndl-opac:735」もしくは「set=735:iss-ndl-opac」とします。
取得したいメタデータの特性に合わせて、setパラメータを指定してください。

3. OAI-PMHで書誌メタデータを取得する

OAI-PMHで書誌データを取得したい場合は、リクエスト種別にListRecordsを指定します。リクエスト種別の後ろにはメタデータの選択条件を記述しますが、このメタデータの選択条件は以下のとおりパラメータによって必須なもの、任意なものがあります。
ListRecordsリクエストの場合のメタデータの選択条件
選択条件内容
identifier 使用不可
metadataPrefix 必須
from 必須
until 任意
set 任意
resumptionToken 任意(排他)
fromやuntilを使用して特定の期間の書誌メタデータを取得したり、setパラメータを使用して特定のデータプロバイダの書誌メタデータを取得するなど、目的に合わせてメタデータ選択基準の値を設定してください。
なお、resumptionTokenは排他(exclusive)のパラメータです。resumptionTokenを指定する場合は他のパラメータを指定しないでください。
from、untilの指定には次の制約がありますので注意してください。
  • 1年を超える期間を指定することはできない。
  • untilを指定しない場合には、上記の最大の期間がuntilに指定されたものとみなす

リクエスト例は次のとおりです。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&set=aozora&from=2015-07-01
⇒2015年7月1日以降にNDLサーチに登録・更新された「青空文庫」のメタデータをdcndl_simple形式で取得する。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl&set=iss-ndl-opac&from=2018-07-01&until=2018-07-10
⇒2018年7月1日～2018年7月10日までにNDLサーチに登録・更新された「国立国会図書館オンライン」の「作成完了書誌」のメタデータをdcndl形式で取得する。
その他、OAI-PMHにおける ListRecords以外のリクエストの詳細、及びNDLサーチが提供するAPI全般については、以下をご覧ください。

⇒「API仕様の概要＞ 3. API仕様書（日本語版）」


4． OAI-PMHで国立国会図書館作成の書誌メタデータを取得する

「3. OAI-PMHで書誌メタデータを取得する」で書誌メタデータを取得する方法をご紹介しましたが、特に国立国会図書館作成の書誌メタデータのみを取得したい場合のリクエストURL作成方法についてご紹介します。

4-1. 「国立国会図書館オンライン」の書誌データ

「国立国会図書館オンライン」（NDL新着書誌情報・全国書誌情報を含む）の書誌データをOAI-PMHで取得する場合、メタデータ選択基準のsetパラメータに「iss-ndl-opac」、もしくは「iss-ndl-opac-national」、「iss-ndl-opac-inprocess」を指定します（リクエスト種別はListRecordsです）。
setパラメータの値の定義は以下のとおりです。
iss-ndl-opac
完了書誌。作成が完了し、正式な書誌となったものです。国内刊行図書、洋図書、博士論文、地図資料等、当館が所蔵する多様な資料の書誌です。
iss-ndl-opac-national
全国書誌。法定納本制度に基づき納本された国内出版物と、納本以外の方法により収集した（寄贈、購入等）国内出版物及び外国刊行日本語出版物が対象です。
iss-ndl-opac-inprocess
作成中書誌（新着書誌情報）。当館に納入された国内刊行出版物及び外国刊行日本語出版物の基本書誌情報（※）を、納入後数日で取得することができます。これにより取得された書誌は、未完成の書誌であり、後に修正されることがありますのでご注意ください。
※国内刊行出版物及び外国刊行日本語出版物の書誌データのうち、地図資料及びアジア言語資料は含まれません。

リクエスト例は次のとおりです。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=iss-ndl-opac
⇒2018年7月10日～2018年7月20日にNDLサーチに登録・更新された「作成完了書誌」を取得できます。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=iss-ndl-opac-national
⇒2018年7月10日～2018年7月20日にNDLサーチに登録・更新された「全国書誌」を取得できます。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=iss-ndl-opac-inprocess:913
⇒2018年7月10日～2018年7月20日にNDLサーチに登録・更新された「作成中書誌」で、かつNDCが「913」であるデータを取得できます。

4-2. 「NDL雑誌記事索引」の書誌データ

「NDL雑誌記事索引」の書誌データをOAI-PMHで取得する場合、メタデータ選択基準のsetパラメータに「zassaku」を指定します。
リクエスト例は次のとおりです。

https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=zassaku
⇒2018年7月10日～2018年7月20日にNDL Searchに登録・更新された「NDL雑誌記事索引」のデータを取得できます。

4-3. 国立国会図書館デジタルコレクションの書誌データ

国立国会図書館デジタルコレクションの書誌データをOAI-PMHで取得する場合は、メタデータ選択基準のsetパラメータに「ndl-dl」、もしくは「ndl-dl-online」を指定します（リクエスト種別はListRecordsです）。
setパラメータの値の定義は以下のとおりです。
ndl-dl
国立国会図書館デジタルコレクション。国立国会図書館で収集・集積されているさまざまなデジタル化資料を提供しています。
※国立国会図書館サーチから提供しているデータベース「国立国会図書館デジタルコレクション」には、「国立国会図書館デジタルコレクション（電子書籍・電子雑誌）」で提供しているデータは含まれません。
ndl-dl-online
国立国会図書館デジタルコレクション（電子書籍・電子雑誌）。国立国会図書館が収集したインターネット上の刊行物を提供しています。2013年7月1日以降に当館が収集したインターネット等で出版（公開）される電子書籍・電子雑誌や、国立国会図書館のホームページにて掲載している刊行物もこちらのデータベースから検索することができます。
リクエスト例は次のとおりです。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=ndl-dl
⇒2018年7月10日～2018年7月20日にNDLサーチに登録・更新された「国立国会図書館デジタルコレクション」のデータを取得できます。
https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&from=2018-07-10&until=2018-07-20&set=ndl-dl-online
⇒2018年7月10日～2018年7月20日にNDLサーチに登録・更新された「国立国会図書館デジタルコレクション（電子書籍・電子雑誌）」のデータを取得できます。

4-4. 国立国会図書館作成書誌データの起点日

国立国会図書館作成書誌データの起点日（最も古い更新日のデータ）は、以下のとおりです。
データプロバイダ名データプロバイダID（set）起点日
国立国会図書館オンラインiss-ndl-opac2020-12-04
NDL新着書誌情報iss-ndl-opac-inprocess2020-12-04
NDL全国書誌情報iss-ndl-opac-national2020-12-04
NDL雑誌記事索引zassaku2020-12-04
国立国会図書館デジタルコレクションndl-dl2020-02-13
国立国会図書館デジタルコレクション（電子書籍・電子雑誌）ndl-dl-online2020-02-13

リクエストに対する1度の返戻は200件が上限です。resumptionTokenを指定することで200件以降の取得が可能になります。
また、全件のデータ量が多いため、できるだけ期間等で対象を絞ってリクエストしていただくことを推奨いたします。

5. 国立国会図書館作成書誌の全件ファイル提供について

国立国会図書館サーチのOAI-PMHでメタデータを提供するデータプロバイダのうち、次に示すものについては、OAI-PMHのListRecordsリクエストに対するレスポンス仕様に準じた全件ファイルの提供が可能です。
データプロバイダ名データプロバイダID（set）レコード件数ファイルサイズ
国立国会図書館オンラインiss-ndl-opac約1200万件約4GB（※）
NDL雑誌記事索引zassaku約1300万件約4GB（※）
※ZIP形式で圧縮した後のサイズとなります。展開後のサイズは約50GBです。

全件ファイルの入手を希望の方は「書誌データの提供」（国立国会図書館ホームページ）をご覧いただき、所定の方法でお申込みください。
全件ファイルの技術的仕様については次の資料をご覧ください。


前のページへ戻る
▲ ページの先頭へ