【ノーコード】Zendesk のデータを Google スプレッドシートにインポートする方法
CData API Server は、Zendesk をREST API(OData) として公開することによりWeb サービスから接続することを可能にします。Google スプレッドシートでは、ImportData 関数を使ってWeb サービスデータをSCV フォーマットで取得することができます。次の手順で Google スプレッドシートでImportData 関数を使ってZendesk のデータ にアクセスする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなZendesk OData サービスを作成していきましょう。
Zendesk への接続
Google スプレッドシートからZendesk のデータを操作するには、まずZendesk への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zendesk」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Zendesk への接続設定を行っていきましょう！
-
Zendesk 接続プロパティの取得・設定方法
Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証
Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。
API トークン認証
API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Zendesk 接続プロパティの取得・設定方法
Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証
Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。
API トークン認証
API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
API Server のユーザー設定
次に、API Server 経由でZendesk にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Zendesk 用のAPI エンドポイントの作成
ユーザーを作成したら、Zendesk のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でZendesk への接続を設定してユーザーを作成し、API Server でZendesk データのAPI を追加しました。これで、OData 形式のZendesk データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
作成したAPI にGoogle シートから接続
- 次にGoogle Sheet からの接続のために、認証トークンをクエリ文字列で渡せるようにします。
クエリ文字列パラメータとして認証トークンを使用する HTTP フォームポストデータ、もしくはクエリパラメータの一部として提供される_@authtoken_ パラメータの値として認証トークンを指定することができます。ただし、デフォルトではAPI Server はクエリ文字列パラメータにおいて認証トークンを渡すことをサポートしていません。 settings.cfg のアプリケーションセクションにて、次のオプションを設定することで有効化できます。クエリ文字列パラメータとして認証トークンを使用する を参照してください。 - エンドポイントURL をAPI Server が自動生成するAPI ドキュメントからコピーします。authtoken はAPI Server の［ユーザー］を作成し、生成されたトークンを使います。
-
新しいGoogle スプレッドシートで、=ImportData() 関数をつかって、公開されたデータソースからCSV ファイルでデータをリクエストします。このサンプルでは、Tickets テーブル全体をリクエストします。 Google は定期的に関数の結果を更新し、シートが最新のデータを保有している状態に保ちます。次のように関すを設定してみます。:
=ImportData("https://your-server/api.rsc/Tickets?@csv&@authtoken=your-authtoken")
