Эта страница переведена с помощью Cloud Translation API.

Представление сложных данных с помощью пользовательского ресурса

В этом руководстве объясняется, как определять пользовательские ресурсы для Google Workspace Studio.

Пользовательские ресурсы — это пользовательские структуры данных, которые можно определить для группировки нескольких переменных. Если выходные данные шага имеют статическую структуру, представьте их с помощью пользовательского ресурса. Например, для создания лида в CRM ваши выходные данные должны содержать несколько переменных:

Адрес электронной почты
адрес улицы
Имя

Для обеспечения наличия всех данных, необходимых для создания потенциального клиента в CRM, выведите пользовательский ресурс, содержащий адрес электронной почты, почтовый адрес и имя.

Вывести пользовательский ресурс в качестве ссылки.

Выводя пользовательский ресурс в виде ссылки, вы можете вернуть его по идентификатору, а не по полному объекту. Если пользовательский ресурс большой или сложный, передача только идентификатора повышает производительность за счет уменьшения объема данных, передаваемых между этапами.

Чтобы вывести пользовательский ресурс в качестве ссылки, отредактируйте файл манифеста и код шага.

Отредактируйте файл манифеста.

В файле манифеста:

Укажите структуру 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[] укажите выходную переменную, которая возвращает динамический набор выходных переменных. Выходная переменная имеет dataType с свойством resourceType . Значение параметра 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() и извлекает содержимое пользовательского ресурса по мере необходимости. Она принимает на вход объект e , представляющий собой JSON-данные события шага, и на их основе устанавливает идентификатор пользовательского ресурса.

Скрипт приложений

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 или считывая данные из базы данных.

Чтобы получить и вернуть пользовательский ресурс по его идентификатору, верните его в качестве значения returnOutputVariablesAction , как показано в onExecuteResourceFunction() .

Скрипт приложений

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();
}

Вот полный пример:

Скрипт приложений

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

Отредактируйте код

Скрипт приложений

Скрипт приложений

Скрипт приложений

Связанные темы