このページは Cloud Translation API によって翻訳されました。

カスタムリソースを使用して複雑なデータを表す

このガイドでは、Google Workspace フローのカスタムリソースを定義する方法について説明します。

カスタムリソースは、複数の変数をグループ化するために定義できるカスタムデータ構造です。たとえば、CRM リードを作成するには、メールアドレス、住所、名前を含むカスタムリソースを渡します。

カスタムリソースを定義する方法は次の 2 つです。

参照として: カスタムリソースを参照として出力する場合は、完全なカスタムリソースオブジェクトではなく、ID でカスタムリソースを返します。これにより、フローステップ間で転送されるデータが削減され、パフォーマンスが向上します。データでセカンダリルックアップが必要な場合、その ID を返すと、ルックアップの実行に役立ちます。
値として: 実行中にデータを取得する必要がある場合、またはカスタムリソースが小さく、機密データが含まれていない場合は、この方法を使用します。

カスタムリソースを参照として出力する

カスタムリソースを参照として出力することで、完全なカスタムリソースオブジェクトではなく、ID でカスタムリソースを返すことができます。カスタムリソースが大きい場合や複雑な場合は、ID のみを渡すことで、フローステップ間で転送されるデータが減り、パフォーマンスが向上します。

カスタムリソースを参照として出力するには、ステップのマニフェストファイルとコードを編集します。

マニフェストファイルを編集する

マニフェストファイルで:

workflowResourceDefinitions を指定し、id、fields[] 配列、providerFunction を割り当てます。workflowResourceDefinitions は、カスタムリソースのデータ型とコンテンツを定義する構造体です。
fields[] 配列内で、カスタムリソースを構成する個々のフィールド（この例では field_1 と field_2）を指定します。

providerFunction の値は、ステップのコード内の関数の名前と一致する必要があります。providerFunction は、必要に応じて実際のカスタムリソースコンテンツを取得します。

JSON

{
    "workflowResourceDefinitions": [
        {
            "id": "resource_id",
            "name": "Custom Resource",
            "fields": [
                {
                    "selector": "field_1",
                    "name": "Field 1",
                    "dataType": {
                        "basicType": "STRING"
                    }
                },
                {
                    "selector": "field_2",
                    "name": "Field 2",
                    "dataType": {
                        "basicType": "STRING"
                    }
                }
            ],
            "providerFunction": "onMessageResourceFunction"
        }
    ]
}

outputs[] で、出力変数の動的セットを返す出力変数を指定します。出力変数には、プロパティ resourceType を持つ dataType が含まれます。cardinality の値は SINGLE にする必要があります。

JSON

"outputs": [{
        "id": "resource_data",
        "description": "Resource Data",
        "cardinality": "SINGLE",
        "dataType": {
          "resourceType": { "workflowResourceDefinitionId": "resource_id" }
        }
      }]

カスタムリソースを定義する完全なマニフェストファイルを次に示します。

JSON

{
    "timeZone": "America/Los_Angeles",
    "exceptionLogging": "STACKDRIVER",
    "runtimeVersion": "V8",
    "addOns": {
        "common": {
            "name": "Calculator",
            "logoUrl": "https://www.gstatic.com/images/branding/productlogos/calculator_search/v1/web-24dp/logo_calculator_search_color_1x_web_24dp.png",
            "useLocaleFromApp": true
        },
        "flows": {
            "workflowElements": [
                {
                    "id": "getResourceData",
                    "state": "ACTIVE",
                    "name": "Get Resource by ID",
                    "description": "Get Resource by ID",
                    "workflowAction": {
                        "outputs": [
                            {
                                "id": "resource_data",
                                "description": "Resource Data",
                                "cardinality": "SINGLE",
                                "dataType": {
                                    "resourceType": {
                                        "workflowResourceDefinitionId": "resource_id"
                                    }
                                }
                            }
                        ],
                        "onConfigFunction": "onConfigResourceFunction",
                        "onExecuteFunction": "onExecuteResourceFunction"
                    }
                }
            ],
            "workflowResourceDefinitions": [
                {
                    "id": "resource_id",
                    "name": "Custom Resource",
                    "fields": [
                        {
                            "selector": "field_1",
                            "name": "Field 1",
                            "dataType": {
                                "basicType": "STRING"
                            }
                        },
                        {
                            "selector": "field_2",
                            "name": "Field 2",
                            "dataType": {
                                "basicType": "STRING"
                            }
                        }
                    ],
                    "providerFunction": "onMessageResourceFunction"
                }
            ]
        }
    }
}

コードを編集

アプリケーションコードで、次の操作を行います。

必要に応じてカスタムリソースコンテンツを取得する providerFunction（この例では onMessageResourceFunction()）を実装します。ステップのイベントオブジェクトの JSON ペイロードである入力 e を受け取り、そこからカスタムリソース ID を設定します。

Apps Script

function onMessageResourceFunction(e) {
  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  var field_1 = ...;
  var field_2 = ...;

  return {
    "hostAppAction": {
      "workflowAction": {
        "resourceRetrievedAction": {
          "resourceJson": JSON.stringify({
            "field_1": field_1,
            "field_2": field_2,
          })
        }
      }
    }
  };
}

プロバイダ関数は、API の呼び出しやデータベースの読み取りなどの適切なメカニズムでカスタムリソースの値を取得し、その値を返す必要があります。

ID でカスタムリソースを取得して返すには、onExecuteResourceFunction() に示すように、returnOutputVariablesAction として返します。

Apps Script

function onExecuteResourceFunction(e) {
  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  return {
    "hostAppAction": {
      "workflowAction": {
        "returnOutputVariablesAction": {
          "variableValues": [{
            "variableId": "resource_data",
            "variableData": {
              "resourceReferences" : [ resource_id ]
            }
          }]
        }
      }
    }
  };
}

完全な例を次に示します。

Apps Script

function onMessageResourceFunction(e) {
  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  var field_1 = ...;
  var field_2 = ...;

  return {
    "hostAppAction": {
      "workflowAction": {
        "resourceRetrievedAction": {
          "resourceJson": JSON.stringify({
            "field_1": field_1,
            "field_2": field_2,
          })
        }
      }
    }
  };
}

function onExecuteResourceFunction(e) {
  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  return {
    "hostAppAction": {
      "workflowAction": {
        "returnOutputVariablesAction": {
          "variableValues": [{
            "variableId": "resource_data",
            "variableData": {
              "resourceReferences" : [ resource_id ]
            }
          }]
        }
      }
    }
  };
}

カスタムリソースを値として出力する

カスタムリソースを参照として出力する場合は、完全なカスタムリソースオブジェクトではなく、ID でカスタムリソースを返します。リソースオブジェクト全体を渡す必要がある場合は、resourceValues を使用して渡すことができます。

resourceValues では、ステップの出力を定義します。

カスタムリソースを値として出力するには、ステップのマニフェストファイルとコードを編集します。

マニフェストファイルを編集する

マニフェストファイルで:

workflowResourceDefinitions を指定して ID を割り当てます。workflowResourceDefinitions は、カスタムリソースのデータ型とコンテンツを定義する構造です。workflowResourceDefinitions 内で、カスタムリソースを構成する個々のフィールド（この例では field_1 と field_2）を指定します。

値がステップのコード内の関数の名前である providerFunction を指定します。providerFunction は、必要に応じて実際のカスタムリソースコンテンツを取得します。

JSON

{
    "workflowResourceDefinitions": [
        {
            "id": "resource_id",
            "name": "Custom Resource",
            "fields": [
                {
                    "selector": "field_1",
                    "name": "Field 1",
                    "dataType": {
                        "basicType": "STRING"
                    }
                },
                {
                    "selector": "field_2",
                    "name": "Field 2",
                    "dataType": {
                        "basicType": "STRING"
                    }
                }
            ],
            "providerFunction": "onExecuteResourceAsValuesFunction"
        }
    ]
}

outputs[] で、resourceValues を返す出力変数を指定します。cardinality の値は SINGLE にする必要があります。

JSON

{
    "outputs": [
        {
            "id": "resource_data",
            "description": "Resource Data",
            "cardinality": "SINGLE",
            "dataType": {
                "resourceValues": {
                    "value1": "value one"
                }
            }
        }
    ]
}

カスタムリソースを定義する完全なマニフェストファイルは次のとおりです。

JSON

{
    "timeZone": "America/Los_Angeles",
    "exceptionLogging": "STACKDRIVER",
    "runtimeVersion": "V8",
    "addOns": {
        "common": {
            "name": "Calculator",
            "logoUrl": "https://www.gstatic.com/images/branding/productlogos/calculator_search/v1/web-24dp/logo_calculator_search_color_1x_web_24dp.png",
            "useLocaleFromApp": true
        },
        "flows": {
            "workflowElements": [
                {
                    "id": "getResourceData",
                    "state": "ACTIVE",
                    "name": "Get Resource by ID",
                    "description": "Get Resource by ID",
                    "workflowAction": {
                        "outputs": [
                            {
                                "id": "resource_data",
                                "description": "Resource Data",
                                "cardinality": "SINGLE",
                                "dataType": {
                                    "resourceValues": {
                                        "value1": "value one"
                                    }
                                }
                            }
                        ],
                        "onConfigFunction": "onConfigResourceFunction",
                        "onExecuteFunction": "onExecuteResourceFunction"
                    }
                }
            ],
            "workflowResourceDefinitions": [
                {
                    "id": "resource_id",
                    "name": "Custom Resource",
                    "fields": [
                        {
                            "selector": "field_1",
                            "name": "Field 1",
                            "dataType": {
                                "basicType": "STRING"
                            }
                        },
                        {
                            "selector": "field_2",
                            "name": "Field 2",
                            "dataType": {
                                "basicType": "STRING"
                            }
                        }
                    ],
                    "providerFunction": "onExecuteResourceAsValuesFunction"
                }
            ]
        }
    }
}

コードを編集

アプリケーションコードで、providerFunction（この例では onExecuteResourceAsValuesFunction()）を実装します。これは、カスタムリソースを JSON として定義して返すもので、ここでは resourceJSON として抽象化されています。

Apps Script

function onExecuteResourceAsValuesFunction() {
  var field_1 = "value 1";
  var field_2 = "value 2";
  var resourceJSON = JSON.stringify({
    "field_1": field_1,
    "field_2": field_2,
  });
  return {
    "hostAppAction": {
      "workflowAction": {
        "returnOutputVariablesAction": {
          "variableValues": [{
            "variableId": "resource_data",
            "variableData": {
              "resourceValues" : [ resourceJSON ]
            }
          }]
        }
      }
    }
  };
}

カスタム リソースを使用して複雑なデータを表す コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

カスタム リソースを参照として出力する

マニフェスト ファイルを編集する

JSON

JSON

JSON

コードを編集

Apps Script

Apps Script

Apps Script

カスタム リソースを値として出力する

マニフェスト ファイルを編集する

JSON

JSON

JSON

コードを編集

Apps Script

関連トピック

カスタムリソースを使用して複雑なデータを表す

カスタムリソースを参照として出力する

マニフェストファイルを編集する

カスタムリソースを値として出力する

マニフェストファイルを編集する