Charity API

Charity API 概要 (Charity API Overview)

eBay Charity APIは、バイヤーとセラーに、サポートされている慈善団体を検索し、慈善団体の詳細を取得するための正式な方法を提供します。

注: 現在、Charity APIはUKおよびUSマーケットプレイスでのみサポートされています。

RESTful APIの使用方法の詳細については、Using eBay Restful APIs を参照してください。

技術概要 (Technical overview)

Charity APIを使用すると、サードパーティの開発者は、以下のセクションにリストされている主要なメソッドとフィールドを使用して、サポートされている慈善団体を検索し、それらの慈善団体の詳細にアクセスできます。

主要なメソッド

Charity APIで使用される主要なメソッドは以下の通りです：

  • getCharityOrg – この呼び出しは、eBay for Charityプログラムに登録されている慈善団体に関する詳細情報を取得するために使用されます。ユーザーは、慈善団体IDを使用して特定の慈善団体の詳細を取得できます。
  • getCharityOrgs – この呼び出しは、eBay for Charityプログラムに登録されている慈善団体を検索するために使用されます。ユーザーは、特定の慈善団体、または特定の慈善ドメインや地理的地域、あるいは検索条件を使用して複数の慈善団体を検索できます。

主要なフィールド

Charity APIメソッドで使用される主要なフィールドは以下の通りです：

  • Organization ID – charityOrgId フィールドには、慈善団体のIDが含まれます。
  • Description – description フィールドには、慈善団体の説明が含まれます。
  • Location – location フィールドには、市区町村、州、地理座標などの慈善団体の所在地詳細が含まれます。
  • Logo – logoImage フィールドには、画像サイズやURLなどの慈善団体のロゴ詳細が含まれます。
  • Mission Statement – missionStatement フィールドには、慈善団体のミッションステートメントが含まれます。
  • Name – name フィールドには、慈善団体の名前が含まれます。
  • Registration ID – registrationId フィールドには、慈善団体の登録ID (EIN番号) が含まれます。
  • Website – website フィールドには、慈善団体のウェブサイトへのリンクが含まれます。

ビジネスユースケース (Business use cases)

多くのバイヤーとセラーは、さまざまな個人的および財務的な理由から慈善活動に熱心に取り組んでいます。一部のバイヤーとセラーは、特定の慈善団体への寄付に特に関心を持っています。また、一般的に寄付を好む人もいます。バイヤーは、慈善団体とのビジネスを増やしたり、慈善団体に寄付したり、バイヤーと同じ大義を支援するセラーとのビジネスを選択したりする場合があります。

eBay Charity情報を取得することで、アプリケーションはいくつかの方法で利益を得ることができます。例えば：

  • 寄付プロセスを通常のビジネスプロセスに直接統合する。
  • 出品をユーザーに提示する際に、出品の恩恵を受ける非営利団体に関する情報を含める。

Charity APIが対応する高レベルのユースケースについては、以下のセクションを参照してください。

慈善団体のリストを取得する

ユーザーは、特定のマーケットプレイスのキーワードセットまたは登録IDを使用して慈善団体を検索できます。検索は、そのマーケットプレイスで利用可能な慈善団体のページ分割されたリストを返します。

注: このメソッドを使用する場合は、マーケットプレイスIDが必要です。フィールドグループとフィルタもサポートされています。

慈善団体の詳細を取得する

ユーザーは、慈善団体IDを使用して特定の慈善団体の完全な詳細を取得できます。これらの詳細には以下が含まれます：

  • 団体の名前、説明、およびミッションステートメント
  • 団体および登録ID (EIN)
  • 団体のロゴ、所在地、およびウェブサイトURL
注: このメソッドを使用する場合は、マーケットプレイスIDが必要です。フィールドグループとフィルタもサポートされています。

API制限 (API restrictions)

このセクションでは、eBay Charity APIの使用に関する制限について概説します。

サポートされているマーケットプレイス

現在、Charity APIはUKおよびUSマーケットプレイスでサポートされています。

SandboxとProductionデータ

eBay Sandbox環境のデータは静的です。範囲と数量が制限されている可能性があり、シミュレートされたデータや模擬データの場合があります。その結果、Production環境のデータにも同じ制限があると依存すべきではありません。アプリケーションが遭遇する可能性のあるデータのより広い範囲と変動性を予測するために、優れたコーディング手法を使用してください。

トップに戻る