APIドキュメンテーション概要

​ APIドキュメンテーション 

数十年もの間、会社はデータを使用して顧客獲得を進めてきました。今、私たちは、顧客データの力を活用して、リスクのある顧客を管理し、健全な顧客の生涯価値を高めることにより、会社ゲームを変えています。Gainsightは、会社が顧客ライフサイクル、リスク管理、価値実証、拡大とアドボカシー、機能横断的コラボレーションへのインサイトを得ることを支援します。

Gainsight APIは、Representational State Transfer (REST) のカテゴリーに属します。これにより、Gainsightテナントからのデータの読み込み、変更、追加、削除などの「RESTful」な操作を行うことができます。

Gainsightは、あなたのアプリケーションやサービスをGainsightプラットフォームと統合するためのREST APIを提供しています。Gainsight APIドキュメントは、アプリケーションやサービスをGainsightプラットフォームと統合する前にGainsight APIを理解する必要がある開発者に対応することを目的としています。これらのAPIを使用すると、外部システムからGainsightアプリケーションにデータを挿入したり、更新したりすることができます。Gainsightアプリケーションにアップサートされるデータは、GainsightのMatrix Data Platform (MDA) のさまざまなオブジェクトに格納されています。これらのREST APIを使用すると、1回のAPIコールでオブジェクトの操作 (読み取り/書き込み/アップサート/削除) や最大50レコードまでの挿入や更新を行うことができます。バルクロード (50件以上のレコードを挿入) を行いたい場合は、GainsightバルクAPIをご利用ください。

Gainsightは、Gainsight 標準オブジェクト会社、人物オブジェクト モデル、およびGainsightで作成した任意のカスタムオブジェクトにデータをロードするためのさまざまなREST APIのドキュメントを提供しています。Gainsightのさまざまなアプリケーションはこれらのオブジェクト上に構築されているので、APIを使用して外部システムからこれらのオブジェクトに直接データをロードすると、Gainsightアプリケーションで直接このデータを見ることができます。

利用可能な同期REST APIは以下の通りです。

• 会社オブジェクトAPI：これにより、Gainsight標準オブジェクト会社に会社レコードをアップサート （挿入と更新） するためのさまざまなAPIを理解できるようになります。詳細情報については、その他のリソースセクションにおける「アクティビティ会社API」 という記事を参照。
• 個人API: これにより、Gainsight個人オブジェクトモデルに個人レコードをアップサートするためのさまざまなAPIを理解できるようになります。詳細情報については、その他のリソースセクションにおける「個人API ドキュメンテーション」 という記事を参照。
• カスタムオブジェクトAPI：これにより、Gainsightで作成されたカスタムオブジェクトにレコードをアップサートするためのさまざまなAPIを理解できるようになります。詳細情報については、その他のリソースセクションにおける「カスタムAPI ドキュメンテーション」という記事を参照。
• コールトゥアクション (CTA)API: これにより、CTAの作成と更新、CTA詳細の取得、CTA設定の獲得に使用できるさまざまなREST APIを理解できるようになります。詳細情報については、その他のリソースセクションにおける「コールトゥアクション(CTA) APIドキュメンテーション」という記事を参照。
• タスクとプレイブックAPI：これにより、タスクの作成と更新、タスクとプレイブック詳細の取得に使用できるさまざまなREST APIを理解できるようになります。詳細情報については、その他のリソースセクションにおける「タスクとプレイブックAPI ドキュメンテーション」という記事を参照。
• 成功プランAPI: これらのREST APIは、成功プランの作成、更新、取得、さらに成功プラン設定の習得に使用できます。詳細情報については、その他のリソースセクションにおける「成功プランAPI」 という記事を参照。
• データ管理API: これらのREST APIは、Gainsightオブジェクトとフィールドの詳細を取得するために使用することができます。詳細情報については、その他のリソースセクションにおける「データ管理API」 という記事を参照。

GainsightバルクAPI 

バルク API (Asynchronous API Calls) は、CSVファイルからGainsightの標準およびカスタムオブジェクトへの大量のデータの挿入や更新を自動化するためのGainsightコネクタです。このコネクタを使用してレコードを挿入または更新するには、管理者はデータインジェストジョブを作成し、フィールドマッピングおよび派生マッピングなどのジョブ設定を実行します。ジョブ設定に応じて、管理者はコネクタにcURL APIを生成し、開発者と共有することができます。開発者は、これらのAPIを使用して、外部システムからさまざまなGainsightオブジェクトのレコードをアップサートできます。Gainsightのさまざまなアプリケーションはこれらのオブジェクト上に構築されているので、HELPを使用して外部システムからこれらのオブジェクトに直接データをロードすると、Gainsightアプリケーションで直接このデータを見ることができます。ソースオブジェクト、フィールドマッピング、派生マッピングなど、各ジョブ設定はGainsight管理者によって完全に制御されているので、開発者は特定の要件を満たすcURL APIを生成するために、Gainsight管理者までお問い合わせください。

Gainsight バルク APIを使用して、下記のオブジェクトにデータをロードすることができます。

• 会社
• 関係
• Gainsightカスタムオブジェクト

Gainsight バルク APIの詳細情報については、その他のリソースセクションで述べたGainsight バルク APIおよびGainsight バルク API FAQsの記事を参照。

Gainsight APIの制限

Gainsight APIの推奨API制限は次のとおりです（正確な制限はパッケージによって異なる場合があります）。

• 同期 API コール: 1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し
• 非同期APIコール （GainsightバルクAPI制限）：1時間あたり10コール/1日あたり100 コール

注意: 上記の API 制限はすべて*固定ウィンドウ速度制限です。

* 固定ウィンドウのレート制限により、特定時間におけるAPIリクエスト数を制限します。たとえば、サーバーには、1分あたり100件のリクエストしか受け付けない固定ウィンドウアルゴリズムを実装するレート制限コンポーネントを含めることができます。時間枠は固定されており、特定の時間に始まります。たとえば、サーバーは午前10:00 から午前10:01 までの間に100件のリクエストのみを処理します。

その他のリソース 

• 会社オブジェクトAPIドキュメンテーション
• 個人のAPIドキュメンテーション
• カスタムオブジェクトAPIドキュメンテーション
• GainsightバルクAPI
• GainsightバルクAPI FAQ (近日公開予定)
• コールトゥアクション (CTA)APIドキュメンテーション (近日公開予定)
• タスクとプレイブックAPIドキュメント (近日公開予定)
• 成功プランAPI (近日公開予定)
• データ管理API (近日公開予定)