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

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

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

カスタムリソースは、複数の変数をグループ化するために定義できるカスタムデータ構造です。ステップの出力が静的な構造を持つ場合は、カスタムリソースで表します。たとえば、CRM リードを作成するには、複数の変数を出力する必要があります。

メールアドレス
番地
名前

CRM リードの作成に必要なすべてのデータが存在することを確認するには、メールアドレス、番地、名前を含むカスタムリソースを出力します。

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

カスタムリソースを参照として出力することで、完全なカスタムリソースオブジェクトではなく、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": "Custom Resource (as reference)",
      "logoUrl": "https://www.gstatic.com/images/icons/material/system/1x/pets_black_48dp.png",
      "useLocaleFromApp": true
    },
    "flows": {
      "workflowElements": [
        {
          "id": "getResourceDataReference",
          "state": "ACTIVE",
          "name": "Custom Resource (as reference)",
          "description": "Output a custom resource as a reference",
          "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) {
  console.log("Payload in onMessageResourceFunction: " + JSON.stringify(e));

  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  let fieldValue_1;
  let fieldValue_2;

  // Using a if-condition to mock a database call.
  if (resource_id == "sample_resource_reference_id") {
    fieldValue_1 = AddOnsResponseService.newVariableData()
      .addStringValue("value1");
    fieldValue_2 = AddOnsResponseService.newVariableData()
      .addStringValue("value2");
  } else {
    fieldValue_1 = AddOnsResponseService.newVariableData()
      .addStringValue("field_1 value not found");
    fieldValue_2 = AddOnsResponseService.newVariableData()
      .addStringValue("field_2 value not found");
  }

  let resourceData = AddOnsResponseService.newResourceData()
    .addVariableData("field_1", fieldValue_1)
    .addVariableData("field_2", fieldValue_2)

  let workflowAction = AddOnsResponseService.newResourceRetrievedAction()
    .setResourceData(resourceData)

  let hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(workflowAction);

  return AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();
}

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

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

Apps Script

function onExecuteResourceFunction(e) {
  console.log("Payload in onExecuteResourceFunction: " + JSON.stringify(e));

  let outputVariables = AddOnsResponseService.newVariableData()
    .addResourceReference("sample_resource_reference_id");

  let workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
    .addVariableData("resource_data", outputVariables);

  let hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(workflowAction);

  return AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();
}

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

Apps Script

function onConfigResourceFunction() {
  let section = CardService.newCardSection()
    .addWidget(
      CardService.newTextParagraph()
        .setText("This is the Custom Resource Demo card")
    );

  const card = CardService.newCardBuilder()
    .addSection(section)
    .build();

  return card;
}

function onMessageResourceFunction(e) {
  console.log("Payload in onMessageResourceFunction: " + JSON.stringify(e));

  var resource_id = e.workflow.resourceRetrieval.resourceReference.resourceId;
  let fieldValue_1;
  let fieldValue_2;

  // Using a if-condition to mock a database call.
  if (resource_id == "sample_resource_reference_id") {
    fieldValue_1 = AddOnsResponseService.newVariableData()
      .addStringValue("value1");
    fieldValue_2 = AddOnsResponseService.newVariableData()
      .addStringValue("value2");
  } else {
    fieldValue_1 = AddOnsResponseService.newVariableData()
      .addStringValue("field_1 value not found");
    fieldValue_2 = AddOnsResponseService.newVariableData()
      .addStringValue("field_2 value not found");
  }

  let resourceData = AddOnsResponseService.newResourceData()
    .addVariableData("field_1", fieldValue_1)
    .addVariableData("field_2", fieldValue_2)

  let workflowAction = AddOnsResponseService.newResourceRetrievedAction()
    .setResourceData(resourceData)

  let hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(workflowAction);

  return AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();
}

function onExecuteResourceFunction(e) {
  console.log("Payload in onExecuteResourceFunction: " + JSON.stringify(e));

  let outputVariables = AddOnsResponseService.newVariableData()
    .addResourceReference("sample_resource_reference_id");

  let workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
    .addVariableData("resource_data", outputVariables);

  let hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(workflowAction);

  return AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();
}

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

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

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

JSON

JSON

JSON

コードを編集

Apps Script

Apps Script

Apps Script

関連トピック

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

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

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