Zendesk
Zendesk コネクタを使用すると、Zendesk データベースに対して、挿入、削除、更新、読み取りオペレーションを実行できます。
サポート対象のバージョン
このコネクタは、Zendesk のバージョン 2 API をサポートしています。
始める前に
Zendesk コネクタを使用する前に、次の作業を行います。
- Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、ネットワーク接続をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。
- 次のサービスを有効にします。
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
- メールアドレスとパスワードを使用して Zendesk API にアクセスする場合は、Zendesk の管理センターで
password access
を有効にします。詳細については、基本認証をご覧ください。 - Zendesk アカウントの作成については、Zendesk アカウントを作成するをご覧ください。
コネクタを構成する
コネクタを構成するには、データソース(バックエンド システム)への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、接続のロケーションを選択します。
- リージョン: プルダウン リストからロケーションを選択します
サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
- [NEXT] をクリックします。
- リージョン: プルダウン リストからロケーションを選択します
- [接続の詳細] セクションで、次の操作を行います。
- コネクタ: 使用可能なコネクタのプルダウン リストから [Zendesk] を選択します。
- コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 49 文字以内で指定してください。
- イベント サブスクリプションをサポートするコネクタの場合、接続名の先頭に接頭辞「goog」は使用できません。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Error
に設定されています。 - サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- イベント サブスクリプションの接続を使用するには、[イベント サブスクリプションを有効にする] を選択します。これを選択すると、次のオプションが表示されます。
- エンティティとアクションを使用したイベント サブスクリプションを有効にする: このオプションを選択すると、イベント サブスクリプションとコネクタ オペレーション(エンティティとアクション)の両方に対して接続が使用されます。
- イベント サブスクリプションのみを有効にする: イベント サブスクリプションに対してのみ接続を使用するには、このオプションを選択します。このオプションを選択した場合は、[次へ] をクリックして、イベント サブスクリプションを構成します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- プロキシを使用: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
-
Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
- 基本: 基本的な HTTP 認証。
- ダイジェスト: ダイジェスト HTTP 認証。
- Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
- プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
-
Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
- 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
- 常に: 接続は常に SSL 対応です。
- なし: 接続は SSL に対応していません。
- トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
- [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
- [+ 宛先を追加] をクリックします。
- [宛先の種類] を選択します。
- Host address: 宛先のホスト名または IP アドレスを指定します。
バックエンドへのプライベート接続を確立する場合は、次のようにします。
- PSC サービス アタッチメントを作成します。
- エンドポイント アタッチメントを作成し、続いて [Host address] フィールドにあるエンドポイント アタッチメントの詳細を入力します。
- Host address: 宛先のホスト名または IP アドレスを指定します。
- 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
- [NEXT] をクリックします。
- [宛先] セクションに、接続するリモートホスト(バックエンド システム)の詳細を入力します。
- 宛先の種類: 宛先の種類を選択します。
- リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
- バックエンド システムへのプライベート接続を確立する場合は、リストからエンドポイント アタッチメントを選択し、次にエンドポイント アタッチメントリストから必要なエンドポイント アタッチメントを選択します。
セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。
他の宛先を入力するには、[+ 宛先を追加] をクリックします。
- [NEXT] をクリックします。
- 宛先の種類: 宛先の種類を選択します。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
Zendesk 接続でサポートされる認証タイプは次のとおりです。
- ユーザー名とパスワードを指定する
- ユーザーと API トークン
- [NEXT] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- イベント サブスクリプションを有効にしている場合は、接続作成ページに [イベント サブスクリプションの詳細] セクションが表示されます。イベント サブスクリプションの詳細の構成方法については、イベント サブスクリプションを構成するをご覧ください。
- Review: 接続と認証の詳細を確認します。
- [作成] をクリックします。
認証を構成する
使用する認証に基づいて詳細を入力します。
- ユーザー名とパスワード
- ユーザー名: 接続に使用する Zendesk ユーザー名。
- パスワード: Zendesk ユーザー名に関連付けられたパスワードを含む Secret Manager の Secret。
-
ユーザー トークンと API トークン
- ユーザー: 認証に使用される Zendesk ユーザー アカウント。
- API トークン: 認証されたユーザーの API トークン。
イベント サブスクリプションを構成する
イベント サブスクリプションを有効にしている場合は、[イベント サブスクリプションの詳細] セクションに次の値を入力します。
- [宛先の種類] を選択します。
- ホストアドレス: [ホスト] フィールドにバックエンド システムの登録 URL を入力します。
- 認証の詳細を入力します。
- ユーザー名: ユーザー名を入力します。
- パスワード: ユーザー名に関連付けられたパスワードを含む Secret Manager の Secret を選択します。
- Secret のバージョン: Secret のバージョンを選択します。
- 必要に応じて、バックエンド システムのレスポンスに付加される情報を追加するには、[データ拡充を有効にする] を選択します。
追加情報は、イベントを構成したエンティティに固有のものです。詳しくは、イベント通知のデータ拡充をご覧ください。
- バックエンド アプリケーションと接続間を安全に接続するには、[プライベート接続を有効にする] を選択します。このオプションを選択した場合は、接続の作成後に追加の構成手順を実行する必要があります。詳細については、イベント サブスクリプションのプライベート接続をご覧ください。
- デッドレター構成を入力します。デッドレターを構成すると、指定された Pub/Sub トピックに未処理のイベントが書き込まれます。次の詳細情報を入力します。
- デッドレター プロジェクト ID: デッドレター Pub/Sub トピックを構成した Google Cloud プロジェクト ID。
- デッドレター トピック: 未処理イベントの詳細を書き込む Pub/Sub トピック。
- プロキシを使用してバックエンドに接続する場合(イベント サブスクリプションの場合)は、次の詳細を入力します。
- Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次のいずれかの認証タイプを選択します。
- 常に: イベント サブスクリプションの接続は常に SSL 対応です。
- なし: イベント サブスクリプションの接続は SSL に対応していません。
- Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。
次の認証タイプがサポートされています。
- 基本: 基本的な HTTP 認証。
- Proxy User: プロキシ サーバーでの認証に使用されるユーザー名を入力します。
- Proxy Password: ユーザーのパスワードの Secret Manager シークレットを選択します。
- Secret のバージョン: Secret のバージョンを選択します。
- [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
- [+ 宛先を追加] をクリックし、[宛先タイプ] を [ホストアドレス] として選択します。
- プロキシ サーバーのホスト名または IP アドレスと、プロキシ サーバーのポート番号を入力します。
接続構成のサンプル
基本認証接続タイプ
フィールド名 | 詳細 |
---|---|
場所 | us-east4 |
コネクタ | Zendesk |
コネクタのバージョン | 1 |
接続名 | CONNECTION_NAME |
Cloud Logging を有効にする | ○ |
サービス アカウント | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
ホスト | HOST_ADDRESS |
UserPassword | ○ |
ユーザー名 | USERNAME |
パスワード | パスワード |
シークレットのバージョン | 1 |
Zendesk への接続ではデフォルトで SSL が使用されます。標準の Zendesk URL(https://yoursubdomain.zendesk.com など)を使用している場合、追加の構成は必要ありません。
エンティティ、オペレーション、アクション
すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。
- エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、
Entities
リストは空になります。 - オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは
Operations
リストに含まれません。 - アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、
Actions
リストが空になります。
システムの上限
Zendesk コネクタは、ノードごとに 1 秒あたり 5 つのトランザクションを処理でき、この上限を超えるトランザクションをスロットルします。 デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます(可用性を高めるため)。
Integration Connectors に適用される上限の詳細については、上限をご覧ください。
アクション
Zendesk コネクタには、ticket ID
に基づいてチケットを管理するためのアクションが用意されています。アクションの構成方法については、アクションの例をご覧ください。
アクションの例
このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。
例 - チケットを削除する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeleteTicketsPermanently
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Id": "18" }
この例では、チケットを完全に削除します。アクションが成功すると、コネクタタスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
例 - チケットを統合する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
MergeTickets
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Id": "25", "Id": "26" }
この例では、2 つのチケットを統合します。アクションが成功すると、コネクタタスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": null, "Message": null }]
例 - チケットを復元する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
RestoreTicket
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "id": "20" }
この例では、チケットを復元します。アクションが成功すると、コネクタタスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
例 - 一時停止されたチケットを復元する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
RecoverSuspendedTicket
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "id": "18726501985809" }
この例では、一時停止されたチケットを復元します。アクションが成功すると、コネクタタスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Id": "60921" }]
エンティティ オペレーションの例
例 - チケットに対する List オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTickets
を選択します。- [
List
] オペレーションを選択してから、[完了] をクリックします。
List オペレーションは、次のエンティティに対して実行できます。
アタッチメント、チケット コメント、チケット フォーム、チケット フィールド、リクエスト、チケット監査、チケット指標、停止中のチケット、共有契約、ユーザー、ユーザー ID、ユーザー関連情報、ユーザー フィールド、組織フィールド、ジョブステータス
例 - チケットに対する Get オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTickets
を選択します。- [
Get
] オペレーションを選択し、[完了] をクリックします。 - ここでは、entityId が 34.0 に設定されています。entityId を設定するには、[コネクタ] タスクの [タスク入力] セクションで
entityId
をクリックし、Default Value
フィールドに 34.0 を入力します。
Get オペレーションは、次のエンティティに対して実行できます。
チケット フォーム、チケット フィールド、リクエスト、チケット監査、停止中のチケット、ユーザー フィールド、ユーザー ID、ユーザー
例 - チケットに対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTickets
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Subject": "Zendesk_Create_Ticket", "RawSubject": "Zendesk_Create", "Description": "this ticket is related to application integration Create operation", "Type": "incident", "Priority": "urgent", "Status": "open", "Recipient": null, "HasIncidents": false, "DueAt": null, "RequesterId": 3.84625885158E11, "SubmitterId": 3.84625883418E11, "AssigneeId": 3.84625883418E11, "OrganizationId": "16665992392721", "GroupId": 3.60008282358E11, "TicketFormId": 3.60001719218E11, "BrandId": 3.60003285058E11, "Tags": null, "ViaChannel": "web", "ViaSource": "{\r\n \"from\": null,\r\n \"to\": null,\r\n \"rel\": null\r\n}", "CustomFields": null, "SatisfactionRating": null, "SharingAgreementIds": null, "AllowChannelback": false, "IsPublic": true, "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json" }
統合に成功すると、コネクタタスクの
connectorOutputPayload
フィールドの値は次のようになります。{ "Id": 38.0 }
例 - TicketForms に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTicketForms
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Name": "Altostrat_Zendesk1", "RawName": "Altostrat_Zendesk1", "DisplayName": "Altostrat_Issues1", "RawDisplayName": "Altostrat_Issues1", "Position": 2.0, "Active": true, "EndUserVisible": true, "Default": false, "InAllBrands": true, "RestrictedBrandIds": null, "FallbackToDefault": null, "AssociatedToBrand": null }
統合が成功すると、
TicketForms
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id":1.8104712053393E13 }
例 - TicketFields に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTicketFields
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Type": "text", "Title": "New field created", "RawTitle": null, "Description": "Please create the new field", "RawDescription": null, "Position": 2.0, "Active": true, "Required": false, "CollapsedForAgents": false, "RegexpForValidation": null, "VisibleInPortal": true, "EditableInPortal": true, "Tag": null, "CreatedAt": "2021-07-06 06:35:19.0", "UpdatedAt": "2021-07-06 06:35:19.0", "SystemFieldOptions": null, "CustomFieldOptions": null, "Removable": false }
統合が成功すると、
TicketFields
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 1.7139061374865E13 }
例 - SharingAgreements に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からSharingAgreements
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Name": "altostrat.zendesk.com", "RemoteSubdomain": "altostrat" }
統合が成功すると、
SharingAgreements
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 1.7142672288273E13 }
例 - Users に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUsers
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Email": "cloudysanfrancisco@gmail.com", "Name": "Altostrat Team" }
統合が成功すると、
Users
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 1.7156912480273E13 }
例 - UserIdentities に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUserIdentities
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "UserId": 3.84637722338E11, "Type": "email", "Value": "cloudysanfrancisco@gmail.com", "Verified": false, "Primary": true, "DeliverableState": "reserved_example", "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json" }
統合が成功すると、
UserIdentities
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 1.6961185982353E13 }
例 - UserFields に対する Create オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUserFields
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Title": "Support description", "Type": "text", "Key": "support_description" }
統合が成功すると、
UserFields
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 1.7157236761873E13 }
例 - チケットに対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTickets
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Subject": "Google_Altostrat_Zendesk Update", "RawSubject": "Google_Altostrat_Zendesk Update", "Description": "this ticket is related to googlecloud application integration update check", "RequesterId": 1.6854335860497E13 }
- ここでは、entityId が 35.0 に設定されています。エンティティ ID を設定するには、[entityId] をクリックし、[デフォルト値] フィールドに「
35
」と入力します。[entityId] を指定する代わりに、[filterClause] を
35
に設定することもできます。統合に成功すると、コネクタタスクの
connectorOutputPayload
フィールドの値は次のようになります。{ Id": 35.0 }
例 - TicketForms に対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTicketForms
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Name": "Ticketforms Updated", "DisplayName": "Altostrat_Issues1", "RawDisplayName": "Altostrat_Issues1" }
- ここでは、entityId が 1.7137314972689E13 に設定されています。エンティティ ID を設定するには、[entityId] をクリックし、[デフォルト値] フィールドに「
1.7137314972689E13
」と入力します。[entityId] を指定する代わりに、[filterClause] を
1.7137314972689E13
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ Id": 1.7137314972689E13 }
例 - TicketFields に対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTicketFields
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Description": "Updated description for testing" }
- ここでは、entityId が 3.60022990118E11 に設定されています。エンティティ ID を設定するには、[entityId] をクリックし、[デフォルト値] フィールドに「
3.60022990118E11
」と入力します。[entityId] を指定する代わりに、[filterClause] を
3.60022990118E11
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ Id": 3.60022990118E11 }
例 - Users に対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUsers
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Name": "The Customer update", "Last Name": "Alex", "First Name": "Charlie" }
- ここでは、entityId が 3.84625885158E11 に設定されています。エンティティ ID を設定するには、[entityId] をクリックし、[デフォルト値] フィールドに「
3.84625885158E11
」と入力します。[entityId] を指定する代わりに、[filterClause] を
3.84625885158E11
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ Id": 3.84625885158E11 }
例 - UserFields に対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUserFields
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Title": "Support description updated", "Type": "text", "Key": "support_description" }
- ここでは、entityId が 1.7157236761873E13 に設定されています。エンティティ ID を設定するには、[entityId] をクリックし、[デフォルト値] フィールドに「
1.7157236761873E13
」と入力します。[entityId] を指定する代わりに、[filterClause] を
1.7157236761873E13
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ Id": 1.7157236761873E13 }
例 - UserIdentities に対する更新オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUserIdentities
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Verified": true }
- このエンティティでは、フィルタ句と複合主キーを使用して更新オペレーションを実行できるため、entityId は必要ありません。
entityId を指定する代わりに、filterClause を UserId='384625885158' and Id='368234205078'
に設定することもできます。
この例を実行すると、コネクタ タスクの connectorOutputPayload
出力変数で次のようなレスポンスが返されます。
{ "Id": 3.68234205078E11 }
例 - チケットに対する削除オペレーション
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTickets
を選択します。- [
Delete
] オペレーションを選択し、[完了] をクリックします。 - ここでは、entityId が 35.0 に設定されています。entityId を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに
35
を入力します。
Delete オペレーションは、次のエンティティに対して実行できます。
チケット フィールド、停止中のチケット、ユーザー ID、ユーザー フィールド、ユーザー
Terraform を使用して接続を作成する
Terraform リソースを使用して、新しい接続を作成できます。Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。
接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。
Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
proxy_enabled | BOOLEAN | False | 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。 |
proxy_auth_scheme | ENUM | False | ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。 |
proxy_user | STRING | False | ProxyServer プロキシへの認証に使用されるユーザー名です。 |
proxy_password | SECRET | False | ProxyServer プロキシの認証に使用されるパスワード。 |
proxy_ssltype | ENUM | False | ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。 |
統合で Zendesk 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。