Kintone
Kintone コネクタを使用すると、Kintone データベースに対して、挿入、削除、更新、読み取りオペレーションを実行できます。
始める前に
Kintone コネクタを使用する前に、次の作業を行います。
- Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに 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)
サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
コネクタを構成する
コネクタを構成するには、データソース(バックエンド システム)への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、接続のロケーションを選択します。
- リージョン: プルダウン リストからロケーションを選択します
サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
- [NEXT] をクリックします。
- リージョン: プルダウン リストからロケーションを選択します
- [接続の詳細] セクションで、次の操作を行います。
- コネクタ: 使用可能なコネクタのプルダウン リストから [Kintone] を選択します。
- コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 49 文字以内で指定してください。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Error
に設定されています。 - サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- 特殊文字を許可する: 特殊文字を許可するかどうかを指定します。true の場合、特殊文字は置き換えられません。
- Check for Subtables In: サブテーブルの取得元の Kintone アプリのカンマ区切りのリスト。
- ゲストスペース ID: クエリ結果をゲストスペースに制限します。
- Number Map To Double: 数値フィールドのデータ型を decimal から double に変更するかどうかを決定します。
- サブテーブルの区切り文字: tablename + char + subtable の形式でサブテーブルからテーブルを分割するために使用される文字。
- Code for Field Name を使用: Label と Code for Field Name のどちらを使用するかを決定します。
- カーソルを使用: レコードを取得するためにカーソルを使用するかどうかを決定するブール値。
- ユーザー定義ビュー: カスタムビューを含む JSON 構成ファイルを指すファイルパス。
- プロキシを使用: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
-
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] をクリックします。
- 宛先の種類: 宛先の種類を選択します。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
Kintone 接続でサポートされる認証タイプは次のとおりです。
- ユーザー名とパスワードを指定する
- API トークン
- [NEXT] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- Review: 接続と認証の詳細を確認します。
- [作成] をクリックします。
認証を構成する
使用する認証に基づいて詳細を入力します。
-
ユーザー名とパスワード
- ユーザー名: コネクタのユーザー名
- パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。
- Basic Auth Password: ベーシック認証を使用するドメインに必要な追加のパスワード。
- Basic Auth User: ベーシック認証を使用するドメインに必要な追加のユーザー名。
-
API トークン
- API トークン: 認証用の API トークンを含む Secret Manager の Secret。
- App Id: APIToken とともに認証に使用される AppId。
エンティティ、オペレーション、アクション
すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。
- エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、
Entities
リストは空になります。 - オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは
Operations
リストに含まれません。 - アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、
Actions
リストが空になります。
システムの上限
Kintone コネクタは、ノードごとに 1 秒あたり 5 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます(可用性を高めるため)。
Integration Connectors に適用される上限の詳細については、上限をご覧ください。
アクション
このセクションには、コネクタでサポートされているアクションが一覧表示されます。アクションの構成方法については、アクションの例をご覧ください。
AppsDeployStatus アクション
このアクションは、アプリのデプロイ ステータスを取得します。
AppsDeployStatus アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
AppIds | 文字列 | ○ | アプリの ID。カンマ区切りの ID のリストを使用できます。 |
GuestSpaceId | 文字列 | × | このパラメータは、ゲストスペースにあるアプリに使用されます。接続文字列に接続プロパティ GuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
AppsDeployStatus
アクションの構成方法の例については、アクションの例をご覧ください。
CreateApp アクション
このアクションにより、アプリが作成されます。
CreateApp アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
名前 | 文字列 | ○ | アプリケーションの名前を 64 文字未満で指定します。 |
Space | 文字列 | × | スペースの ID。接続文字列で接続プロパティ GuestSpaceId が設定されている場合は、指定しないでください。 |
ThreadId | 文字列 | × | スペースの ID。接続文字列で接続プロパティ GuestSpaceId が設定されている場合は、指定しないでください。 |
IsGuestSpace | ブール値 | × | Space パラメータが通常のスペースかゲスト スペースかを示すブール値です。ゲスト スペースの場合は、この値を true に設定します。デフォルト値は false です。 |
CreateApp
アクションの構成方法の例については、アクションの例をご覧ください。
DeleteGuests アクション
このアクションにより、ユーザーはゲストを削除できます。
DeleteGuests アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ゲスト | 文字列 | ○ | ゲストユーザーのメールアドレスのリスト。最大 100 人のゲストを削除できます。 |
DeleteGuests
アクションの構成方法の例については、アクションの例をご覧ください。
DeployApps アクション
この操作により、アプリをデプロイできます。
DeployApps アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
AppId | 文字列 | ○ | アプリ ID。カンマ区切りの ID のリストを使用できます。 |
リビジョン | 文字列 | × | 操作環境を反映した設定のリビジョンを指定します。指定されたリビジョンが最新でない場合、リクエストは失敗します。 |
元に戻す | ブール値 | × | アプリケーション設定の変更をキャンセルする場合は、true に設定します。デフォルト値は false です。 |
GuestSpaceId | 文字列 | × | このパラメータは、ゲストスペースにあるアプリに使用されます。接続文字列に接続プロパティ GuestSpaceid が指定されている場合は、このパラメータを追加しないでください。 |
DeployApps
アクションの構成方法の例については、アクションの例をご覧ください。
DownloadFile アクション
このアクションを使用すると、ユーザーはアプリの添付ファイル フィールドからファイルをダウンロードできます。
DownloadFile アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
FileKey | 文字列 | ○ | ファイルの ID。 |
HasBytes | ブール値 | × | コンテンツをバイトとしてダウンロードするかどうか。有効な値は true または false です。
true に設定すると、ファイルは Base64 エンコード文字列としてダウンロードされます。デフォルトでは、 |
DownloadFile
アクションの構成方法の例については、アクションの例をご覧ください。
UpdateAssignees アクション
このアクションにより、ユーザーは割り当て先を更新できます。
UpdateAssignees アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
AppId | 文字列 | ○ | アプリ ID。 |
RecordId | 文字列 | ○ | RecordId |
Assignees | 文字列 | ○ | 割り当て先のユーザーコード。空白の場合、ユーザーは割り当てられません。割り当て先の最大数は 100 です。 |
リビジョン | 文字列 | × | 割り当て先を更新する前のレコードのリビジョン番号。指定されたリビジョンが最新のリビジョンでない場合、リクエストはエラーになります。 |
GuestSpaceId | 文字列 | × | このパラメータは、ゲストスペースにあるアプリに使用されます。接続文字列に接続プロパティ GuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
UpdateAssignees
アクションの構成方法の例については、アクションの例をご覧ください。
AddGuests アクション
このアクションにより、ユーザーはゲストを追加できます。
AddGuests アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
名前 | 文字列 | false | ユーザーの表示名です。1 ~ 128 文字でなければなりません。 |
コード | 文字列 | × | ゲストユーザーのメールアドレス(ログイン名)。 |
パスワード | 文字列 | × | ゲストユーザーのログイン パスワード。英数字で指定してください。 |
Timezone | 文字列 | × | ゲストユーザーのタイムゾーン。 |
Locale | 文字列 | × | ゲストユーザーの言語設定。使用可能な値は、auto、en、zh、ja です。指定しない場合、デフォルトとして auto が設定されます。 |
画像 | 文字列 | × | ゲストユーザーのプロフィール画像。アップロードされたファイルの fileKey を指定します。 |
SurNameReading | 文字列 | × | ゲストユーザーの表音の姓の設定。最大文字数は 64 文字です。 |
GivenNameReading | 文字列 | × | ゲストユーザーの表音の名の設定。最大文字数は 64 文字です。 |
会社 | 文字列 | × | ゲストユーザーのプロフィールに表示する会社名。 |
部門 | 文字列 | × | ゲストユーザーのプロファイルに表示する部門名。 |
Phone | 文字列 | × | ゲストユーザーのプロフィールに表示する電話番号。 |
CallTo | 文字列 | × | ゲストユーザーの Skype 名。 |
GuestsAggregate | 文字列 | × | ゲストの総計。 |
AddGuests
アクションの構成方法の例については、アクションの例をご覧ください。
UploadFile アクション
このアクションにより、ファイルをアップロードできます。
UploadFile アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
FileName | 文字列 | ○ | ドキュメントに付ける名前。指定しない場合、FullPath 入力で指定されたファイル名が使用されます。 |
コンテンツ | 文字列 | × | FullPath が指定されていない場合にアップロードする InputStream としてのコンテンツ。 |
ContentBytes | 文字列 | × | ファイルとしてアップロードするバイト コンテンツ(Base64 文字列として)。バイナリデータをアップロードする場合に使用します。 |
AppId | 文字列 | × | Kintone アプリ ID。AttachToApp が true に設定されている場合は必須です。 |
HasBytes | ブール値 | × | コンテンツをバイトとしてアップロードするかどうか。有効な値は true または false です。
true に設定した場合、ファイルのコンテンツは Base64 エンコード文字列である必要があります。デフォルトでは、 |
AddThreadComment アクション
このアクションにより、ユーザーはスレッドにコメントを追加できます
AddThreadComment アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
SpaceId | Integer | ○ | スペースの ID。 |
ThreadId | Integer | ○ | スレッドの ID。 |
テキスト | 文字列 | × | コメントの内容。改行は LF で指定できます。コメントの最大文字数は 65,535 文字です。files が設定されていない場合は必須です。 |
名前リンク付きメッセージ | 文字列 | × | 他の Kintone ユーザーに通知する、メンションを含む配列。 |
ファイル | 文字列 | × | 添付ファイルのデータを含む配列。ファイルの上限数は 5 個です。テキストが設定されていない場合は必須です。 |
AddThreadComment
アクションの構成方法の例については、アクションの例をご覧ください。
UpdateThread アクション
このアクションにより、スレッドを更新できます
UpdateThread アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ThreadId | Integer | ○ | スレッド ID。スレッド ID は、スレッドの URL で確認できます。 |
名前 | 文字列 | × | スレッドの新しい名前。1 ~ 128 文字でなければなりません。このパラメータが無視された場合、名前は更新されません。シングル スレッド形式のスペースのスレッド名は更新できません。 |
本文 | 文字列 | × | スレッド本文の内容。 |
UpdateThread
アクションの構成方法の例については、アクションの例をご覧ください。
アクションの例
このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。
例 - アプリのデプロイ ステータスを取得する
この例では、アプリのデプロイ ステータスを取得します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
AppsDeployStatus
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "AppIds": "4" }
アクションが成功すると、AppsDeployStatus
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
{ "AppId": "4", "Status": "SUCCESS", "success": "true" }
例 - アプリを作成する
この例では、新しいアプリを作成します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CreateApp
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Name": "NewApp" }
アクションが成功すると、CreateApp
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "AppId": "20", "Revision": "2", "Success": "true" }]
例 - アプリをデプロイする
この例では、アプリをデプロイします。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeployApps
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "AppId": "19", "Revision": "2" }
アクションが成功すると、DeployApps
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
例 - ファイルをダウンロードする
この例では、アプリに存在するファイルをダウンロードします。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadFile
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049" }
アクションが成功すると、DownloadFile
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "True", "Content": "Record number, Number, Text\n49, 162, Hello" }]
例 - 割り当て先を更新する
この例では、割り当て先を更新します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UpdateAssignees
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049" }
アクションが成功すると、UpdateAssignees
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "True", "Content": "Record number, Number, Text\n49, 162, Hello" }]
例 - ゲストを追加する
この例では、ゲストを追加します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
AddGuests
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "GuestsAggregate": "[{\"name\":\"Testuser\",\"code\":\"testuser1@test.com\", \"password\":\"test@123\",\"timezone\":\"America/Los_Angeles\", \"company\":\"Company Name\",\"division\": \"Sales\", \"callto\":\"SkypeCallTo\",\"locale\":\"en\"}]" }
アクションが成功すると、AddGuests
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
例 - ゲストを削除する
この例では、ゲストを削除します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeleteGuests
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Guests": "[\"testuser1@test.com\"]" }
アクションが成功すると、DeleteGuests
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
例 - ファイルをアップロードする
この例では、ファイルをアップロードする方法を示します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UploadFile
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "FileName": "GoogleCloud_Upload_File.txt", "AppId": "9", "Content": "Hello" }
アクションが成功すると、UploadFile
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35", "Success": "true", "Id": null, "Revision": null }]
例 - スレッド コメントを追加する
この例は、スレッド コメントを追加する方法を示しています。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
AddThreadComment
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "SpaceId": 1.0, "ThreadId": 1.0, "Text": "Test Comment" }
アクションが成功すると、AddThreadComment
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Id": "3", "Success": "true" }]
例 - スレッドを更新する
この例では、スレッドを更新する方法を示します。
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UpdateThread
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ThreadId": 1.0, "Name": "updated thread" }
アクションが成功すると、UpdateThread
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "true" }]
エンティティ オペレーションの例
このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。
例 - すべてのアプリを一覧表示する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からApps
を選択します。- [
List
] オペレーションを選択してから、[完了] をクリックします。 - 必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。フィルタ句の値は、常に単一引用符(')内で指定します。
例 - アプリを取得する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からApps
を選択します。- [
Get
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] フィールドに
4
を入力します。ここで、
4
はApps
エンティティ内の一意のレコード ID です。
例 - レコードを削除する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からRecord
を選択します。- [
Delete
] オペレーションを選択し、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに
6
を入力します。
例 - レコードを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
リストからRecord
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Text": "HelloDemo" }
この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "RecordId": 29.0 }
例 - レコードを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からRecord
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Text_area": "updatedemo" }
- [エンティティ ID] をクリックし、[デフォルト値] フィールドに「
22
」と入力します。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "RecordId": "22" }
Terraform を使用して接続を作成する
Terraform リソースを使用して、新しい接続を作成できます。Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。
接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。
Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
allow_special_characters | BOOLEAN | False | 特殊文字を許可するかどうかを決定します。true の場合、特殊文字は置き換えられません。 |
check_for_subtables_in | STRING | True | サブテーブルの取得元の Kintone アプリのカンマ区切りのリスト。 |
guest_space_id | STRING | False | クエリ結果をゲストスペースに制限します。 |
number_map_to_double | BOOLEAN | False | 数値フィールドのデータ型を decimal から double に変更するかどうかを決定します。 |
subtable_separator_character | STRING | True | tablename + char + subtable の形式でサブテーブルからテーブルを分割するために使用される文字。 |
use_code_for_field_name | BOOLEAN | False | Label と Code for Field Name のどちらを使用するかを指定します。 |
use_cursor | BOOLEAN | False | レコードを取得するためにカーソルを使用するかどうかを決定するブール値。 |
user_defined_views | STRING | False | カスタムビューを含む JSON 構成ファイルを指すファイルパスです。 |
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 です。 |
統合で Kintone 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。