メインコンテンツへスキップ
Gainsight Japanese Localization

会社APIドキュメンテーション

  1. 最後の更新
  2. PDFとして保存 
重要 - 画像/情報は四半期ごとのリリースで更新されます!

四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。

 

​この記事では、Gainsight会社オブジェクトのレコードを作成、更新、読み込み、削除する際に利用できるREST APIの詳細について説明します。

はじめに

会社オブジェクトのレコードを作成、更新、読み込み、削除するために使用できるREST APIの詳細を提供します。会社は、Matrix Data Architecture（MDA）におけるGainsightの標準オブジェクトであり、個々の顧客レコードと会社情報を格納します。これは外部APIです。

前提条件

  • このドキュメントのAPIを使用するには、必要なサブドメインまたはカスタムドメインが作成されていることを確認します。例： https://companyapi.gainsightcloud.com または https://companyapi.yourcompany.com.ドメインの作成方法に関する詳細情報については、Gainsightドメインをセットアップを参照。
    Gainsightに接続するために、エンドポイントURLにあなたのドメインを追加することができます。
  • これらの会社オブジェクトAPIを使用するには、次のことを確認します:
     
    1. 会社オブジェクトがテナントにインストールされている。
    2. 必須カスタムフィールドが会社オブジェクトに作成されている。
      会社オブジェクトにカスタムフィールドを作成するには、 管理 > データ管理 > [ 会社オブジェクトを選択] ページに移動する。
  • 以下のように、データ管理スキーマから取得したキーとして、フィールド名を渡します:

clipboard_e8907859e69d080fe27ed278bd0b9df38.png

認証

API アクセスは、固有のアクセス キーを使用して制御されます。REST API要求を送信するGainsightテナントのアクセスキーを取得するにはGainsight 管理者に連絡してください。アクセス キーを生成または共有する方法に関する詳細情報については、Gainsight管理者は API アクセス キーを生成 の記事を参照できます。

アクセスキーを取得した後は、GainsightへのすべてのAPIリクエストのリクエストヘッダー「accesskey」の一部として、アクセスキーを渡す必要があります。

注意: AccessKeyに有効期限はありません。

ヘッダー

キー 値
アクセスキー アクセス キーに関する詳細情報については、Gainsight管理者は API アクセス キーを生成 の記事を参照できます。
コンテンツタイプ JSON

スロットリング制限

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は、Gainsightの会社オブジェクトに1つまたは複数のレコードを挿入するために使用されます。1回のAPIコールで最大50件のレコードを挿入できます。バルクロード (50件以上のレコードを挿入} を実行する場合は、 Gainsight S3コネクター または GainsightバルクAPIを利用できます。

このAPIは、レコードを挿入する前に、オブジェクトの全てのフィールドを検証します。検証が成功すると、レコードがオブジェクトに挿入されます。いずれかのフィールドのいずれかのレコードで検証が失敗した場合、API 呼び出しは検証エラーで失敗します。

メソッド

ポスト

エンドポイント URL

https://companyapi.gainsightcloud.com/v1/data/objects/Company

このエンドポイントURLでは https://companyapi.gainsightcloud.com  は、Gainsightに接続するためのドメインです。 あくまで参考です。

会社は、レコードを挿入するGainsight標準オブジェクトです。

リクエスト本文のサンプル


{
 "records": [
   {
     "Name": "Acme",
     "Industry": "Software",
     "ARR": 250000,
     "Employees": 840,
     "LifecycleInWeeks": 15,
     "OriginalContractDate": "12-14-2017",
     "RenewalDate": "12-13-2018",
     "Stage": "Adopting",
     "Status": "Active",
     "CSMFirstName": "Steve",
     "CSMLastName": "Smith",
     "ParentCompanyName": "KLM Software"
   },
   {
     "Name": "Heroku",
     "Industry": "Networking",
     "ARR": 200000,
     "Employees": 480,
     "LifecycleInWeeks": 7,
     "OriginalContractDate": "04-30-2018",
     "RenewalDate": "04-29-2019",
     "Stage": "Kicked Off",
     "Status": "Active",
     "CSMFirstName": "Joe",
     "CSMLastName": "Roberts",
     "ParentCompanyName": "Telenet"
   },
   {
     "Name": "DriveData",
     "Industry": "Hardware",
     "ARR": 260000,
     "Employees": 560,
     "LifecycleInWeeks": 18,
     "OriginalContractDate": "05-31-2018",
     "RenewalDate": "05-30-2019",
     "Stage": "New Customer",
     "Status": "Active",
     "CSMFirstName": "Mark",
     "CSMLastName": "Lehmann",
     "ParentCompanyName": "Superbiz Inc."
   },
   {
     "Name": "ABC Corp.",
     "Industry": "Healthcare",
     "ARR": 340000,
     "Employees": 950,
     "LifecycleInWeeks": 28,
     "OriginalContractDate": "01-15-2018",
     "RenewalDate": "01-14-2019",
     "Stage": "Launched",
     "Status": "Active",
     "CSMFirstName": "Michelle",
     "CSMLastName": "Williams",
     "ParentCompanyName": "Power Health Group"
   },
   {
     "Name": "XYZ Inc.",
     "Industry": "Marketing",
     "ARR": 450000,
     "Employees": 280,
     "LifecycleInWeeks": 23,
     "OriginalContractDate": "05-30-2018",
     "RenewalDate": "05-29-2018",
     "Stage": "Adopting",
     "Status": "Active",
     "CSMFirstName": "Josh",
     "CSMLastName": "Wood",
     "ParentCompanyName": "Marketive"
   }
 ],
 "lookups": {
   "CSM": {
     "fields": {
       "CSMFirstName": "FirstName",
       "CSMLastName": "LastName"
     },
     "lookupField": "Gsid",
     "objectName": "gsuser",
     "multiMatchOption": "FIRSTMATCH",
     "onNoMatch": "ERROR"
   },
   "ParentCompany": {
     "fields": {
       "ParentCompanyName": "Name"
     },
     "lookupField": "Gsid",
     "objectName": "company",
     "multiMatchOption": "FIRSTMATCH",
     "onNoMatch": "ERROR"
   }
 }
}

インポートルックアップ

要求本文の一部としてインポートルックアップ構成を渡すことが可能です。インポートルックアップ設定により、同一または別のオブジェクトから参照することで、フィールドにGSIDを入力することができます。同じオブジェクトまたは別のオブジェクトからGSIDを入力するために、GSIDタイプのフィールドを渡すことを確認します。GSIDデータタイプのフィールドに入力するために挿入されるすべてのレコードへのルックアップに、1つのJSONが適用されます。

ルックアップには次の2タイプがあります。ダイレクトおよびセルフ。このルックアップにより、別の標準オブジェクトを検索し、そのルックアップオブジェクトからレコードのGSIDを取得できます。以下のスニペットに示すCSMフィールドのルックアップ設定は、ダイレクトルックアップの一例です。

セルフルックアップにより、同一のオブジェクトをルックアップし、ターゲットフィールドに別のレコードのGSIDを取得できます。以下のスニペットに示す親会社フィールドのルックアップ設定は、セルフルックアップの一例です。


{
  "lookups": {
    "CSM": {
      "fields": {
        "CSMFirstName": "FirstName",
        "CSMLastName": "LastName"
      },
      "lookupField": "Gsid",
      "objectName": "gsuser",
      "multiMatchOption": "FIRSTMATCH",
      "onNoMatch": "ERROR"
    },
    "ParentCompany": {
      "fields": {
        "ParentCompanyName": "Name"
      },
      "lookupField": "Gsid",
      "objectName": "company",
      "multiMatchOption": "FIRSTMATCH",
      "onNoMatch": "ERROR"
    }
  }
}

上記のルックアップコードのスニペットでは、キーは次のように定義されています。

  • 「CSMFirstName」（リクエスト本文内）：FirstName (照合するGSユーザーオブジェクトのフィールド名)
  • 「CSMLastName」（リクエスト本文内）：「LastName」 (一致するGSユーザーオブジェクトのフィールド名)
  • 注意: ソースから複数のフィールドを渡して、複数のルックアップフィールドと一致させることができます（例：GSユーザーオブジェクト > フィールド) を選択して、適切な一致を見つけます。
  • 「ParentCompanyName」 (リクエスト本文内): 「Name」 (一致するGSユーザーオブジェクトのフィールド名)
  • 「lookupField」: 「Gsid」（ルックアップフィールド名）、例：GSユーザー＞GSIDまたは会社＞GSID
  • 「objectName」: 「gsuser」(ルックアップオブジェクト名)、例: GSユーザー（ダイレクトルックアップ）または会社（セルフルックアップ）。

キーmultiMatchOptionでサポートされているオプションは2つあります：

  • FIRSTMATCH: (デフォルト） このオプションは、ルックアップJSONおよびルックアップオブジェクトの間で最初に一致したGSIDを入力します。
  • MARKASERROR: このオプションにより、JSONおよびルックアップオブジェクトの間で複数のレコードが条件に一致した場合、システムがエラーで応答することができます。

キー onNoMatch でサポートされているオプションは 3 つあります:

  • NULLABLE: (デフォルト） このオプションを選択すると、ターゲットフィールドにNULL値が挿入されます
  • DEFAULTVALUE: このオプションを選択すると、デフォルト値をターゲットフィールドに挿入します。
    注意: [管理] > [データ管理] > [ターゲット オブジェクトの選択] > [ターゲット フィールドの編集] ページでフィールドにデフォルト値を割り当てることができます。
  • エラー: このオプションにより、JSONおよびルックアップオブジェクトの間で条件に一致するレコードがなかった場合、システムがエラーで応答することができます。
ダイレクトインポートルックアップ

たとえば、以下のコードスニペットでは、 CSMName （リクエスト本文内）とFirstName （GSuser内）、CSMLastName （リクエスト本文内） とLastName （Gsuser内） の一致により、 CSMフィールドにGSユーザーオブジェクトからのGSIDが入力されます。

clipboard_ecb0d30a8c68094c1da82ebfb824b3dbf.png

セルフインポートルックアップ

たとえば、以下のコードスニペットでは、ParentCompanyName （リクエスト本文内） と名前 （会社オブジェクト内） の一致により、 親会社フィールドには同じオブジェクトである会社からのGSIDが入力されます。

clipboard_eaa886a16d38055e9e107fe4ffe3dda15.png

パラメーター

パラメーター* データタイプ 値(ある場合) 説明
名前* 文字列

-

 会社名を含む文字列値。
業界 文字列 -

業界名を含む文字列値。
ARR 通貨 - 年間経常収益を含む通貨値。

従業員

数字

-

会社の従業員数を含む数値。

LifeCycleInWeeks

数字

-

全プロセスが通過する週数を含む数値。

OriginalContractDate

日付

-

クライアントとの契約を開始した日を含む日付値。

RenewalDate

日付

-

契約更新日を含む日付値。

ステージ

Dropdownlist

新規顧客

キックオフ

立ち上げ完了

アダプション

チャーン予定

チャーン

セールスパイプラインにおける会社の現在のステージを含むDropdownlist値。

ステータス

Dropdownlist

 

 

アクティブ

非アクティブ

チャーン

現在のステータスを含むDropdownlist値。

CSMFirstName

文字列

-

会社のPOCのFirst Nameを含む文字列値。

CSMLastName

文字列

-

会社のPOCのLast Nameを含む文字列値。

ParentCompanyName

文字列

-

親会社名を含む文字列値。

応答成功のサンプル


{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "eaa1520f-0b27-4468-86b0-17b4e94f1786",
  "data": {
    "records": [
      {
        "CreatedDate": 1521691459693,
        "Name": "Acme",
        "Industry": "Software",
        "ARR": 250000,
        "Employees": 840,
        "LifecycleInWeeks": 15,
        "OriginalContractDate": 1531691459792,
        "RenewalDate": 1543691459853,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "ModifiedDate": 1562691459623,
        "Gsid": "1P02MRXML1GRDV44YOYPEBMABN5JYVTAATP8",
        "Csm": "1P01OI3OHC9S79J7VN1DW2NKI9JJFXEVHIZK",
        "Parentcompany": "1P02MRXML1GRDV44YOL2I8HX2NJNQTEE"
      },
      {
        "CreatedDate": 1521691459693,
        "Name": "Heroku",
        "Industry": "Networking",
        "ARR": 200000,
        "Employees": 480,
        "LifecycleInWeeks": 7,
        "OriginalContractDate": 1531691459792,
        "RenewalDate": 1543691459853,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "ModifiedDate": 1241672475612,
        "Gsid": "1P02MRXML1GRDV44YO6NO2DQXRNTQYQXDLGF",
        "Csm": "1P01OI3OHC9S79J7VN1DW2NKI9JJFXEVHIZK",
        "Parentcompany": "8P02MRXML1GRDV44YO6QXRNTQYQXDLGF"
      },
      {
        "CreatedDate": 1521691459693,
        "Name": "DriveData",
        "Industry": "Hardware",
        "ARR": 260000,
        "Employees": 560,
        "LifecycleInWeeks": 18,
        "OriginalContractDate": 1531691459792,
        "RenewalDate": 1543691459853,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "ModifiedDate": 1241672475612,
        "Gsid": "1P02MRXML1GRDV44YOL2PI8HX2NJRH5NQTEE",
        "Csm": "1P01OI3OHC9S79J7VN1DW2NKI9JJFXEVHIZK",
        "Parentcompany": "2P02MRXML1GRDV44YO2PVGD1NMPG69BD"
      },
      {
        "CreatedDate": 1521691459693,
        "Name": "ABC Corp.",
        "Industry": "Healthcare",
        "ARR": 340000,
        "Employees": 950,
        "LifecycleInWeeks": 28,
        "OriginalContractDate": 1531691459792,
        "RenewalDate": 1543691459853,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "ModifiedDate": 1241672475612,
        "Gsid": "1P02MRXML1GRDV44YO2PVJIALGD1NMPG69CA",
        "Csm": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "Parentcompany": "1P01OI3OHC9S79J7VN8QDH0Y52CYFMXW"
      },
      {
        "CreatedDate": 1521691459693,
        "Name": "XYZ Inc.",
        "Industry": "Marketing",
        "ARR": 450000,
        "Employees": 280,
        "LifecycleInWeeks": 23,
        "OriginalContractDate": 1531691459792,
        "RenewalDate": 1543691459853,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "ModifiedDate": 1241672475612,
        "Gsid": "1P02MRXML1GRDV44YO87PCQFV0QIRSDZZ3DN",
        "Csm": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "Parentcompany": "4P01OI3OHC9S79J7VN8QUF0Y52CYFMXW"
      }
    ]
  },
  "message": null
}

失敗応答のサンプル

 {
  "result": false,
  "errorCode": "GSOBJ_1005",
  "errorDesc": "Invalid dateTime format (OriginalContractDate =210318).",
  "requestId": "39f58495-8f05-4344-8542-ca44ac9afeb8",
  "data": {
    "count": 0,
    "errors": [
      [
        {
          "success": false,
          "parsedValue": 210318,
          "errors": [
            {
              "errorMessage": "Invalid dateTime format",
              "errorCode": "GSOBJ_1005",
              "fieldName": "OriginalContractDate",
              "invalidValue": 210318
            }
          ]
        }
      ]
    ],
    "records": null
  },
  "message": null
}

更新API

更新APIは、会社オブジェクトの1つまたは複数の既存レコードを更新するために使用します。既存のレコードはエンドポイント URL で指定されたキーを使用して識別され、残りのフィールドの値は API 呼び出しで説明されているように更新されます。API呼び出し毎に最大50レコードを更新することができます。

メソッド

入力

エンドポイント URL

https://companyapi.gainsightcloud.com/v1/data/objects/Company?keys=fieldName1,fieldName2

このエンドポイントURLでは、

  • https://companyapi.gainsightcloud.comがGainsightに接続できるドメインです。あくまで参考です。
  • 会社はオブジェクト名です。
  • キーは従業員および業界であり、会社オブジェクトのレコードを更新するための有効なエンドポイントURLは、次のようになります。 https://companyapi.gainsightcloud.com/v1/data/objects/Company?keys=Employees,Industry。

注意: 上記で使用されるキー （フィールド名） は、あくまで参考用です。以下の条件を満たすエンドポイントURLにおいて、会社オブジェクトから任意のフィールドをキーとして渡すことができます。

条件:

  • エンドポイントURLでは、文字列、GSID、数、及びメールのみのデータタイプのキーを指定することができます。
  • エンドポイントURLには、特定のレコードを識別するためのキーを最大3つまで入力できます。
  • キー間の演算子は常にANDです。つまり、全てのキーの条件に一致するレコードがUpdate APIを使って更新されます。

リクエスト本文のサンプル

{
  "records": [
    {
      "Industry": "Marketing",
      "ARR": 520000,
      "Employees": 280,
      "LifecycleInWeeks": 23,
      "OriginalContractDate": "12-20-2017",
      "RenewalDate": "12-19-2018",
      "Stage": "Launched",
      "Status": "Active",
      "CSMFirstName": "Mark",
      "CSMLastName": "Taylor"
    },
    {
      "Industry": "Healthcare",
      "ARR": 390000,
      "Employees": 950,
      "LifecycleInWeeks": 28,
      "OriginalContractDate": "10-15-2017",
      "RenewalDate": "10-14-2018",
      "Stage": "Will Churn",
      "Status": "Inactive",
      "CSMFirstName": "Julia",
      "CSMLastName": "Brown"
    }
  ],
  "lookups": {
    "CSM": {
      "fields": {
        "CSMFirstName": "FirstName",
        "CSMLastName": "LastName"
      },
      "lookupField": "Gsid",
      "objectName": "gsuser",
      "multiMatchOption": "FIRSTMATCH",
      "onNoMatch": "ERROR"
    }
  }
}

パラメーター

パラメーター* データタイプ 値(ある場合) 説明

業界

文字列

-

業界名を含む文字列値。

ARR

通貨

-

年間経常収益を含む通貨値。

従業員

数字

-

会社の従業員数を含む数値。

LifeCycleInWeeks

数字

-

全プロセスが通過する週数を含む数値。

OriginalContractDate

日付

-

クライアントとの契約を開始した日付を含む日付値。

RenewalDate

日付

-

契約更新日を含む日付値。

ステージ

Dropdownlist

新規顧客

キックオフ

立ち上げ完了

アダプション

チャーン予定

チャーン

セールスパイプラインにおける会社の現在のステージを含むDropdownlist値。

ステータス

Dropdownlist

アクティブ
非アクティブ
チャーン

現在のステータスを含むDropdownlist値。

CSMFirstName

文字列

-

会社のPOCのFirst Nameを含む文字列値。

CSMLastName

文字列

-

会社のPOCのLast Nameを含む文字列値。

応答成功のサンプル 

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "eaa1520f-0b27-4468-86b0-17b4e94f1786",
  "data": {
    "count": 2,
    "errors": null,
    "records": [
      {
        "CreatedDate": 1521691459694,
        "Name": "XYZ Inc.",
        "Industry": "Marketing",
        "ARR": 520000,
        "Employees": 280,
        "LifecycleInWeeks": 23,
        "OriginalContractDate": 1521743018667,
        "RenewalDate": 1521691459694,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "ModifiedDate": 1521743018667,
        "Gsid": "1P02MRXML1GRDV44YO87PCQFV0QIRSDZZ3DN",
        "Csm": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "Parentcompany": "4P01OI3OHC9S79J7VN8QUF0Y52CYFMXW"
      },
      {
        "CreatedDate": 1521691459694,
        "Name": "ABC Corp.",
        "Industry": "Healthcare",
        "ARR": 390000,
        "Employees": 950,
        "LifecycleInWeeks": 28,
        "OriginalContractDate": 1521743018667,
        "RenewalDate": 1521691459694,
        "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
        "Status": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "ModifiedDate": 1521743018667,
        "Gsid": "1P02MRXML1GRDV44YO2PVJIALGD1NMPG69CA",
        "Csm": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
        "Parentcompany": "1P01OI3OHC9S79J7VN8QDH0Y52CYFMXW"
      }
    ]
  },
  "message": null
}

失敗応答のサンプル

{
  "result": false,
  "errorCode": "GSOBJ_1006",
  "errorDesc": "Invalid dateTime format (OriginalContractDate = 210318).",
  "requestId": "7cba3c98-b04b-4e21-9e57-44807fa52b8a",
  "data": {
    "count": 0,
    "errors": [
      [
        {
          "success": false,
          "parsedValue": 210318,
          "errors": [
            {
              "errorMessage": "Invalid dateTime format",
              "errorCode": "GSOBJ_1006",
              "fieldName": "OriginalContractDate",
              "invalidValue": 210318
            }
          ]
        }
      ]
    ],
    "records": null
  },
  "message": null
}

読み取りAPI

読み取りAPIでは、会社オブジェクトから特定の条件に一致する1つまたは複数のレコードを読み取ることができます。読み取りAPIでは、1回のAPIコールで最大5000件のレコードが取得できます。

注意: フェッチできるレコードが 5000 を超えると思われる場合は、オフセットを 5001 として別の API 呼び出しを渡し、残りのレコード (ここでも最大 5000 レコード) がフェッチされるようにします。

メソッド

ポスト

エンドポイント URL

https://companyapi.gainsightcloud.com/v1/data/objects/query/Company

このエンドポイントURLでは、

  • https://companyapi.gainsightcloud.comがGainsightに接続できるドメインです。あくまで参考です。
  • 会社は、レコードの読み取り元となるGainsight標準オブジェクトです。

リクエスト本文のサンプル


{
  "select": [
    "Name",
    "Renewal_Date",
    "Status",
    "Stage",
    "Customer_Lifetime_in_Months",
    "csm__gr.email"
  ],
  "where": {
    "conditions": [
      {
        "name": "Renewal_Date",
        "alias": "A",
        "value": [
          "03-22-2018",
          "05-21-2018"
        ],
        "operator": "BTW"
      },
      {
        "name": "Stage",
        "alias": "B",
        "value": [
          "New Customer",
          "Kicked Off",
          "Launched"
        ],
        "operator": "IN"
      }
    ],
    "expression": "A OR B"
  },
  "orderBy": {
    "Renewal_Date__gc": "asc",
    "Company_ID__gr.stage": "desc"
  },
  "limit": 100,
  "offset": 0
}

パラメーター

パラメーター* データタイプ 値(ある場合) 説明

名前

文字列

-

会社名を含む文字列値。

Renewal_Date

通貨

-

契約更新日を含む通貨値。

ステージ

Dropdownlist

-

セールスパイプラインにおける会社の現在のステージを含むDropdownlist値。

顧客生涯月数

数字

-

一般的な顧客が会社に関連している月数を含む数値。

csm_ _gr.email

メール

-

CSMのメールIDを含むメール値。

応答成功のサンプル 

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "8863e73c-a465-4fc6-a385-f7b3200720dc",
  "data": [
    {
      "Name": "Heroku",
      "Renewal_Date": 1521743018667,
      "Status": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
      "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
      "Customer_Lifetime_in_Months": 22,
      "csm__gr.email": "jnash@heroku.com"
    },
    {
      "Name": "ABC Inc.",
      "Renewal_Date": 1521743018667,
      "Status": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
      "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
      "Customer_Lifetime_in_Months": 15,
      "csm__gr.email": "cbrown@abc.com"
    },
    {
      "Name": "XYZ Inc.",
      "Renewal_Date": 1521743018667,
      "Status": "1P01OI3OHC9S79J7VN8GQLUQDH0Y52CYFMXW",
      "Stage": "1I0054U9FAKXZ0H26HO92M3F1G5SPWVQDNF3",
      "Customer_Lifetime_in_Months": 6,
      "csm__gr.email": "dbess@xyz.com"
    }
  ],
  "message": null
}

失敗応答のサンプル


{
  "result": false,
  "errorCode": "GSOBJ_1XXX",
  "errorDesc": "No data found for given criteria",
  "requestId": "58222b97-eaf0-402e-854d-1914987c4b49",
  "data": null,
  "message": null
}

削除API

削除APIは、会社オブジェクトの特定のレコードを削除します。削除するレコードは、エンドポイントURLで渡されるGSIDで識別されます。

メソッド

削除

エンドポイントURL

https://companyapi.gainsightcloud.com/v1/data/objects/Company/{GSID}

このエンドポイントURLでは、

  • https://companyapi.gainsightcloud.comがGainsightに接続できるドメインです。あくまで参考です。
  • 会社は、レコードを削除する Gainsight 標準オブジェクトです。
  • GSIDは、会社オブジェクトの既存のレコードの一意のIDであり、たとえば、 1I0054U9FAKXZ0H26H4H0U5VRD65H9JW66FJです。

実際の削除エンドポイントURLは以下のようになります https://companyapi.gainsightcloud.co...5VRD65H9JW66FJ。

応答成功のサンプル

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "8863e73c-a465-4fc6-a385-f7b3200720dc",
  "data": "Record with GSID: 1I0054U9FAKXZ0H26H4H0U5VRD65H9JW66FJ successfully deleted.",
  "message": null
}

失敗応答のサンプル


{
  "result": false,
  "errorCode": "GSOBJ_1XXX",
  "errorDesc": "No data found for given criteria",
  "requestId": "58222b97-eaf0-402e-854d-1914987c4b49",
  "data": null,
  "message": null
}

エラーコード

関係APIのエラーコードに関する詳細情報については、 会社、関係、カスタムオブジェクトAPIのエラーコード の記事を参照。

  1. このページのトップへ
  • この記事は役に立ちましたか？

おすすめの記事

  1. Article type
    Topic
  2. タグ
    1. Company API
    2. Delete API
    3. Insert API
    4. Read API
    5. Update API