入力の種類 - サーバーレス関数

関数からの入力値は、次の方法で取得できます。

パラメーター

パラメーターはクエリー文字列のURLで渡され、データはPOSTの「フォームデータ」セクションで渡されます。crmAPIRequestマップの「params」には、リクエストで渡されるすべての情報を含むこれらのパラメーターが含まれています。

POSTMANを使用したリクエストURL内でのパラメーターの送信:

POSTMANを使用して、フォームデータのJSONオブジェクトとしてパラメーターを送信します。

POSTMANを使用して、フォームデータのキーとしてパラメーターを送信します。

関数で定義された引数と関連するパラメーターは、自動的に同期されます。

リクエストで使用される追加パラメーターを取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストのパラメーターを取得する
parameters = crmAPIRequestMap.get("params");
/**
ロジックはこちら
**/
return crmAPIRequestMap;

  • 関数内で引数として「arguments」という名前を使用することは避けてください。名前が一致しないと、一部の引数が機能しないことがあります。
  • 関数の引数の関連付けは、「パラメーター」を介して渡されたとき、つまり、(URLの)クエリー文字列またはフォームデータを介して渡されたときに自動的に行われます。

ストリーム

リクエストの「ボディー」はリクエストにストリームとして渡されるコンテンツの取得に使用できます。通常、ボディーは、リクエストメソッドがPOSTの場合にのみ使用されます。

POSTMANを使用したストリーム(生データ)のボディーの送信:

POSTMANを使用したバイナリーファイルのボディーの送信:

関数内のリクエストのボディーのセクション全体を取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストボディーのコンテンツを取得する
request_body = crmAPIRequestMap.get("body");
/**
ロジックはこちら
**/
return crmAPIRequestMap;

POSTMANでは、ボディーのコンテンツは生データまたはバイナリーで渡すことができます。

  • 関数の引数がストリームを介して渡される場合、それらは関数の引数に関連付けされません。
  • 関数内で入力データをエンコード/デコードする必要がある場合は、Delugeの暗号化タスクを使用できます。

ファイルの内容

リクエストのコンテンツタイプがMultipartの場合、そのリクエストはファイルと見なされます。リクエストオブジェクトの関数内でファイルを取得できます。

現在サポートされているファイルタイプはテキストファイルです。ファイルをmultipartデータとして関数に送信するには、引数名「inputFile」でファイルを送信します。

関数で使用するためにアップロードされたファイルを取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストのファイルコンテンツを取得する
parameters = crmAPIRequestMap.get("file_content");
/**
ロジックはこちら
**/
return crmAPIRequestMap;

  • 関数の入力が「ファイル」として指定されている場合、ファイル内の引数は関数の引数に関連付けされません。

ヘッダー

通常、リクエストのヘッダーには、リクエストに関する追加情報が含まれています。ヘッダーで使用できる情報は、crmAPIRequest引数内の「headers」キーで取得できます。

リクエストのヘッダーを取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストのユーザー情報を取得する
header_request = crmAPIRequestMap.get("headers");
/**
ビジネスロジックはこちら
**/
return crmAPIRequestMap;

ユーザー情報

このキーを使用して、OAuth2メソッドを使用して関数を呼び出すユーザーと、そのユーザーの組織に関する情報を取得できます。

ユーザーに関する情報を取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストのユーザー情報を取得する
user_info = crmAPIRequestMap.get("user_info");
/**
ビジネスロジックはこちら
**/
return crmAPIRequestMap;

  • 関数がAPIキーとして呼び出される場合、取得されるユーザー情報はスーパー管理者の情報であり、関数を呼び出したユーザーの情報ではありません。

認証タイプと認証方式

これら2つのキーを使用して、認証情報(apikeyまたはoauth)とHTTPメソッド(GET/POST)を取得できます。

認証タイプに関する情報を取得するには:

crmAPIRequestMap = crmAPIRequest.toMap();
//リクエストのHTTPメソッドを取得する
user_info = crmAPIRequestMap.get("method");
// to get the authentication type of the request
user_info = crmAPIRequestMap.get("auth_type");
/**
ビジネスロジックはこちら
**/
return crmAPIRequestMap;