Какие поля необходимы для файла загрузки параметров посетителя
Обновлено: 05.07.2024
Добро пожаловать в документацию по API Dwolla. Этот API даст вам возможность подключить свое программное обеспечение к банковской инфраструктуре для перевода денег, хранения средств, проверки личности клиентов и проверки банковских счетов.
Все запросы должны содержать заголовок Accept: application/vnd.dwolla.v1.hal+json. Запросы POST должны указывать заголовок Content-Type: application/vnd.dwolla.v1.hal+json. Тексты запросов и ответов кодируются в формате JSON.
Чтобы предотвратить выполнение операции более одного раза, Dwolla поддерживает передачу заголовка Idempotency-Key с уникальным ключом в качестве значения. Несколько POST-запросов с одним и тем же ключом идемпотентности и телом запроса не приведут к созданию нескольких ресурсов. Рекомендуется использовать случайное значение для ключа идемпотентности, например UUID (т. е. - Ключ идемпотентности: d2adcbab-4e4e-430b-9181-ac9346be723a ).
Например, если запрос на инициацию переноса завершается неудачно из-за проблемы с сетевым подключением, вы можете повторить запрос с тем же ключом идемпотентности, чтобы гарантировать создание только одного переноса.
Если вы повторите запрос POST с тем же значением Idempotency-Key вместо создания новых или потенциально дублирующихся ресурсов, вы получите сообщение 201 Created с исходным ответом созданного ресурса. Если сервер Dwolla все еще обрабатывает исходный запрос POST, вы получите ответ об ошибке 409 Conflict на последующий запрос. Несколько POST-запросов с одним и тем же ключом идемпотентности, включая тело запроса на точное совпадение, не приведут к созданию нескольких ресурсов. Ключи идемпотентности предназначены для предотвращения конфликтов в течение короткого периода времени, поэтому срок действия ключей, связанных с телом запроса, истекает через 24 часа.
Чтобы предотвратить повторное создание ресурсов, мы настоятельно рекомендуем сделать все запросы идемпотентными.
Пример передачи с использованием ключа идемпотентности
Следующие ошибки характерны для всех конечных точек API.
Ответы с кодом ошибки верхнего уровня ValidationError возвращаются, когда можно исправить конкретную проблему с вашим запросом. Ответ будет содержать сообщение: «Присутствуют ошибки проверки. Дополнительные сведения см. в списке встроенных ошибок». Как минимум одна, а возможно и больше подробно описанных ошибок будет присутствовать в списке встроенных ошибок. Несколько ошибок представлены в коллекции встроенных объектов ошибок.
_встроенный объект JSON
Поле пути — это указатель JSON на конкретное поле в запросе, в котором возникла проблема. Сообщение представляет собой удобочитаемое описание проблемы. Код представляет собой подробный код ошибки, который может иметь одно из следующих значений:
Связи и доступные действия для ресурса представлены ссылками. Все ресурсы имеют атрибут _links. Как минимум, все ресурсы будут иметь ссылку на себя, которая указывает URL-адрес самого ресурса.
Некоторые ссылки, такие как источники финансирования, содержат URL-адрес, по которому можно перейти для доступа к соответствующим ресурсам. Например, у ресурса клиента есть ссылка на источники финансирования, при переходе по которой будут перечислены доступные источники финансирования клиента.
Ответы, содержащие набор ресурсов, имеют ссылки на страницы: first , next , last и prev .
В следующем разделе описаны инструменты разработки, которые вы можете использовать для интеграции с Dwolla API. Доступные инструменты могут помочь улучшить рабочий процесс тестирования и разработки, а также помочь в решении сложной проблемы (например, создание пользовательского интерфейса) при интеграции Dwolla в ваше приложение.
Dwolla HAL-Forms — это расширение спецификации HAL, созданное для описания того, как Dwolla представляет формы в API.Расширение начинается с типа носителя. Тип носителя следует использовать в качестве ссылки на профиль как часть заголовка Accept запроса в сочетании с типом носителя в стиле Dwolla HAL. Включив эти два идентификатора типа мультимедиа в заголовок Accept, API узнает, что вы ищете форму для данного ресурса.
Пример значения заголовка Accept
Дополнительную информацию о свойствах, которые могут быть возвращены в ответе Dwolla HAL-FORMS, см. в спецификации. Или прочитайте запись в блоге одного из наших разработчиков о создании этой функции.
Прежде чем участники вашей команды смогут войти в систему и использовать службы Google вашей организации (например, Google Workspace или Cloud Identity), им потребуется учетная запись пользователя. Если у вас много новых пользователей, вы можете сразу добавить их учетные записи из электронной таблицы.
Вы также можете обновить несколько существующих аккаунтов из электронной таблицы.
Прежде чем начать
- Убедитесь, что это правильный вариант: загрузите пользователей с электронной таблицей, если вы добавляете до 150 000 пользователей. Однако если у вас есть сервер LDAP, такой как Microsoft Active Directory, или вы обладаете навыками программирования, мы рекомендуем другие варианты для крупных организаций. Подробнее см. в разделе «Параметры добавления пользователей».
Если вы обновляете учетные записи пользователей, обратите внимание, что электронная таблица может включать до 200 существующих пользователей, которым назначаются новые лицензии.
Добавить пользователей из электронной таблицы
Если вы используете файл CSV для создания новых учетных записей, пользователи не получат электронное приветствие нового пользователя со своими учетными данными. Вы должны отправить новым пользователям их учетные данные отдельно.
Совет. Если вы забыли пароль нового пользователя, сбросьте пароль, а затем отправьте новый пароль пользователю по электронной почте.
В файле есть столбцы для атрибутов, которые могут отображаться в профиле каждого пользователя. Профили отображаются в консоли администратора и в диспетчере контактов пользователей.
Путь организационного подразделения: введите / (косая черта), чтобы поместить пользователей в ваше организационное подразделение верхнего уровня. Это можно сделать, если вы не настроили организационную иерархию в консоли администратора.
Описания столбцов и сведения о форматировании см. в приведенных ниже рекомендациях.
Ваша таблица должна выглядеть примерно так:
Заполнив таблицу, сохраните ее как файл CSV (.csv).
Примечания:
- Максимальный размер CSV-файла – 35 МБ.
- Максимальное количество записей в файле – 150 000.
Если ваш файл больше или содержит слишком много записей, откройте его в программе для работы с электронными таблицами, разделите таблицу на отдельные файлы и сохраните каждый из них как файл CSV. Убедитесь, что вы включили строку заголовков столбцов во все файлы CSV.
- В верхней части страницы "Пользователи" нажмите Массовое обновление пользователей.
- Нажмите "Прикрепить CSV-файл".
- Перейдите в папку на своем компьютере и прикрепите CSV-файл.
- Нажмите «Загрузить». Если произошла ошибка, введите недостающую информацию в таблицу и снова загрузите файл. Дополнительную информацию см. в разделе Устранение распространенных ошибок ниже.
Список ваших задач открывается автоматически и показывает ход загрузки. После завершения обработки вы получите отчет по электронной почте.
Если возникла ошибка обработки, загрузите файл журнала из списка задач. Дополнительную информацию см. в разделе Устранение распространенных ошибок ниже.
Чтобы новые пользователи получили доступ к службам Google и появились в Каталоге, может пройти до 24 часов. Узнайте больше о Каталоге.
Следуйте рекомендациям по формату электронных таблиц
Заключите значения в двойные кавычки, например, "123 Anystreet, Anytown"
Обязательные столбцы
Если вы обновляете данные существующих пользователей и не хотите менять их пароли, введите **** (4 звездочки).
Если также указана хэш-функция пароля, столбец пароля должен содержать хешированный пароль. Например, если вы используете SHA-1, а хэш пароля abc — xyz, введите xyz в столбце «Пароль».
Для размещения пользователей в организационном подразделении.
Если вы еще не настроили организационную иерархию: введите / (косая черта), чтобы поместить всех пользователей в родительское организационное подразделение верхнего уровня. Вы можете переместить пользователей в другие организационные подразделения, которые создадите позже.
Если вы уже настроили организационную иерархию: используйте формат в следующих примерах, чтобы поместить каждого пользователя в организационное подразделение — либо в родительское организационное подразделение верхнего уровня, либо в дочернее организационное подразделение ниже него.
/ (для родителя верхнего уровня — не вводите имя своего домена)
/Продажи (для дочернего элемента ниже родителя верхнего уровня)
/Студенты/Первоклассники
Необязательные столбцы
Столбец «Пароль» должен содержать хешированный пароль. Например, если вы используете SHA-1, а хэш пароля abc — xyz, введите xyz в столбце «Пароль».
Совет. В Интернете можно найти утилиты для создания хешированных паролей с использованием поддерживаемых хеш-функций.
За предоставление информации для восстановления, используемой для проблем со входом в систему.
-
Резервный адрес электронной почты — адрес электронной почты за пределами вашего домена.
Резервный номер телефона – должен быть в формате E.164. Они должны начинаться со знака плюс (+), за которым следует код страны, код города и номер телефона. Записи могут содержать не более 15 цифр. Пример: +16505551212.
Примечание. Резервный телефон должен быть уникальным для каждого пользователя. Если один и тот же резервный номер телефона используется несколькими пользователями, этот номер автоматически блокируется из соображений безопасности.
Только для редактирования существующих учетных записей пользователей. Чтобы назначить пользователю другую лицензию, введите идентификатор SKU для лицензии. Разделяйте несколько идентификаторов лицензий запятыми, например: 1010020020, Google-Drive-storage-20GB, 1010330002
В электронной таблице может быть указано до 200 пользователей, которым назначается новая лицензия.
Устранение распространенных ошибок
| Ошибка | Причина/решение |
|---|---|
| Файл пуст | Ваш файл не содержит никакой информации. |
| Неверный формат файла или неизвестное имя столбца | Столбцы в вашем файле должны называться Имя [Обязательно], Фамилия Имя [Требуется], Адрес электронной почты [Требуется], Пароль [Требуется] и Путь организационного подразделения [Требуется]. |
| Файл должен иметь "имя столбца" столбец | Отсутствует обязательный столбец. |
| Пустой "имя столбца" в строке nn< /em> | Столбец, требующий информации, пуст в определенной строке. |
Например, вы увидите сообщение об ошибке Пусто "Путь к организационному подразделению [Обязательно]" в строке 2, если вы не ввели организационное подразделение, в которое хотите поместить учетную запись пользователя. Перейдите к пути организационного подразделения выше.
Эта ошибка обычно означает одну из следующих ошибок форматирования:
- Столбец "Путь организационного подразделения" имеет неправильный формат.
- Одно или несколько введенных вами организационных подразделений не существуют в консоли администратора. Убедитесь, что названия организационных подразделений совпадают с названиями в вашей организационной иерархии в консоли администратора.
Если вы добавляете пользователя в организационное подразделение, в котором включено автоматическое лицензирование, настройки автоматического лицензирования имеют приоритет над лицензией, назначенной пользователю в CSV-файле. Ошибка не будет отображаться в файле журнала.
Обновите существующие учетные записи пользователей
Если вам нужно изменить несколько аккаунтов, вы можете сэкономить время, загрузив список аккаунтов из консоли администратора.
Прежде чем начать
- Любая информация в столбцах, которые вы можете редактировать, заменяет существующую информацию в консоли администратора при загрузке файла.
- Столбцы, которые вы не хотите изменять, можно либо удалить (если столбец не требуется), либо оставить их информацию в файле, либо удалить их информацию.
- Если вы удалите всю ненужную информацию из столбца, но оставите этот столбец в электронной таблице, существующая информация не будет удалена из учетной записи пользователя при загрузке файла.
- Если вы не хотите менять пароль пользователя, убедитесь, что столбец "Пароль" содержит символы **** (4 звездочки).
- Если вы не хотите изменять информацию о конкретном пользователе, вы можете оставить его строку в электронной таблице или удалить ее. Если вы удалите всю информацию о пользователе из файла, его учетная запись не будет удалена.
- Чтобы изменить имя пользователя, введите новый адрес электронной почты в столбце "Новый основной адрес электронной почты".
- Если вы изменили основной домен для своего аккаунта Google Workspace, подробные инструкции см. в разделе Массовое переименование адресов пользователей после изменения основного домена.
Редактировать несколько учетных записей пользователей
Ваш список задач откроется автоматически и покажет ход загрузки.
В файле есть столбцы для атрибутов в профиле каждого пользователя.
Список ваших задач открывается автоматически и показывает ход загрузки. После завершения обработки вы получите отчет по электронной почте.
Если возникла ошибка обработки, загрузите файл журнала из списка задач. Дополнительные сведения см. в разделе Устранение распространенных ошибок.
Если у вас есть сервер LDAP, например Microsoft Active Directory, вы можете использовать Google Cloud Directory Sync для синхронизации ваших пользователей, групп и общих контактов Google в соответствии с информацией на вашем сервере LDAP.
Хотите, чтобы кто-нибудь сделал это за вас? Получите профессиональную помощь по настройке.
Статьи по теме
Google, Google Workspace и связанные с ними знаки и логотипы являются товарными знаками Google LLC. Все остальные названия компаний и продуктов являются товарными знаками компаний, с которыми они связаны.
Атрибуты профиля в Adobe Target — это параметры, относящиеся к посетителю. Эти атрибуты хранятся в профиле посетителя, чтобы предоставить информацию о посетителе, которую можно использовать в ваших действиях.
Профиль пользователя содержит демографические данные и информацию о поведении посетителя веб-страницы.Эта информация может включать возраст, пол, приобретенные продукты, время последнего посещения и т. д., которые Target использует для персонализации контента, предоставляемого посетителю.
Когда посетитель просматривает ваш веб-сайт или когда посетитель возвращается для другого сеанса, сохраненные атрибуты профиля в профиле можно использовать для таргетинга контента или регистрации информации для фильтрации сегментов.
Чтобы настроить атрибуты профиля:
Нажмите Аудитории > Скрипты профиля.
Нажмите «Создать сценарий».
Доступны следующие типы атрибутов профиля:
Атрибуты сценария профиля
Определите атрибут сценария профиля со связанным с ним фрагментом кода JavaScript.
Вы можете использовать сценарии профилей для сбора атрибутов посетителей при нескольких посещениях. Скрипты профиля — это фрагменты кода, определенные в Target с использованием формы серверного JavaScript. Например, вы можете использовать сценарий профиля, чтобы отслеживать, как часто посетитель посещает ваш сайт и когда этот посетитель посещал его в последний раз.
Скрипты профиля — это не то же самое, что параметры профиля. Параметры профиля собирают информацию о посетителях, используя реализацию Target в коде mbox.
Создать скрипты профиля
Сценарии профилей доступны на вкладке "Аудитории" в целевом интерфейсе.
Чтобы добавить сценарий профиля, перейдите на вкладку "Сценарии профиля", выберите "Создать сценарий" и напишите свой сценарий.
Чтобы скопировать существующий сценарий профиля, в списке "Сценарии профиля" щелкните значок с многоточием рядом с нужным сценарием, затем нажмите "Дублировать".
Затем вы можете отредактировать аудиторию, чтобы создать похожую аудиторию.
Скрипты профиля запускают «ловушки» атрибутов профиля при каждом запросе местоположения. Когда получен запрос местоположения, Target определяет, какое действие следует запустить, и отображает контент, соответствующий этому действию и этому опыту. Target также отслеживает успех действия и запускает все соответствующие сценарии профиля. Этот процесс позволяет отслеживать информацию о посещении, такую как местонахождение посетителя, время суток, количество посещений сайта посетителем, совершали ли они ранее покупки и т. д. Затем эта информация добавляется в профиль посетителя, чтобы вы могли лучше отслеживать действия этого посетителя на вашем сайте.
Атрибуты скрипта профиля имеют пользователя. тег, вставленный перед именем атрибута. Например:
Запомните следующую информацию:
- Обратитесь к атрибутам скрипта профиля (включая самого себя) в коде с помощью user.get('parameterName') .
- Сохраните переменные, к которым можно будет получить доступ при следующем запуске скрипта (при следующем запросе mbox) с помощью user.setLocal('variable_name', 'value') . Ссылайтесь на переменную с помощью user.getLocal('variable_name') . Этот процесс полезен в ситуациях, когда вы хотите сослаться на дату и время последнего запроса.
- Параметры и значения вводятся с учетом регистра. Соответствуйте регистру параметров и значений, которые вы получаете во время действия или теста.
- Дополнительные сведения о синтаксисе JavaScript см. в разделе "Справочник по JavaScript для параметров профиля скрипта" ниже.
- Параметр остается в профиле после отключения скрипта. Пользователи, чьи профили уже содержат параметр, который используется в аудитории действия, могут участвовать в этом действии.
- Скрипты профиля нельзя удалить, пока они используются в действии.
- Создание зависимых сценариев профиля, использующих результат одного сценария профиля в другом сценарии профиля, не рекомендуется. Порядок выполнения скрипта профиля не гарантируется.
Просмотр информационных карточек сценария профиля
Вы можете просматривать всплывающие карточки с информацией о сценариях профилей, аналогичные информационным карточкам с предложениями. Эти карточки с информацией о сценарии профиля позволяют просматривать список действий, которые ссылаются на выбранный сценарий профиля, а также другие полезные метаданные.
Например, доступ к следующей информационной карточке сценария профиля можно получить, щелкнув значок информации для нужного сценария профиля из списка (Аудитории > Сценарии профиля).
Вкладка "Информация о скрипте" содержит следующую информацию: имя, описание и код скрипта.
< /p>
Нажмите Просмотреть все подробности, чтобы просмотреть аудитории и действия, которые ссылаются на выбранный скрипт профиля.
На вкладке «Использование сценария» не отображаются действия, которые ссылаются на выбранный сценарий профиля, в следующих случаях:
- Действие находится в состоянии "Черновик".
- Контент или предложение, используемые в действии, используют переменные скрипта (либо встроенное предложение в действии, либо предложение в библиотеке предложений).
Target отключает скрипты профиля в определенных ситуациях
Target автоматически отключает сценарии профилей в определенных ситуациях, например, если они выполняются слишком долго или содержат слишком много инструкций.
Если сценарий профиля отключен, рядом со сценарием профиля в целевом пользовательском интерфейсе отображается желтый значок предупреждения, как показано ниже:
При наведении на сообщение об ошибке отображаются подробности, как показано ниже:
Обычные причины, по которым система отключает сценарии профиля, включают следующее:
- Неопределенная переменная для ссылки.
- Указано недопустимое значение. Эта ошибка часто возникает из-за ссылки на значения URL и другие введенные пользователем данные без надлежащей проверки.
- Используется слишком много инструкций JavaScript. У Target есть ограничение в 2000 инструкций JavaScript на сценарий, но это ограничение нельзя просто рассчитать, прочитав код JavaScript вручную. Например, Rhino обрабатывает все вызовы функций и «новые» вызовы как 100 инструкций. Любой вызов любой функции требует 100 инструкций. Кроме того, размер любых входных данных, таких как значения URL, может повлиять на количество инструкций.
- Не следовать пунктам, выделенным в разделе "Рекомендации" ниже.
Рекомендации
Следующие рекомендации призваны помочь в написании упрощенных сценариев профилей, максимально исключающих сбои, за счет написания кода, который корректно завершает работу, поэтому сценарии обрабатываются без принудительной остановки системного сценария. Эти рекомендации являются результатом передового опыта, эффективность которого доказана. Эти рекомендации должны применяться вместе с принципами и рекомендациями, составленными сообществом разработчиков Rhino.
Установите текущее значение скрипта в локальную переменную в пользовательском скрипте, задайте для аварийного переключения пустую строку.
Проверьте локальную переменную, убедившись, что это не пустая строка.
Используйте функции обработки строк, а не регулярные выражения.
Используйте ограниченные циклы for вместо открытых циклов for или while.
Не превышайте 1300 символов или 50 итераций цикла.
Не более 2000 инструкций JavaScript. У Target есть ограничение в 2000 инструкций JavaScript на сценарий, но это ограничение нельзя просто рассчитать, прочитав код JavaScript вручную. Например, Rhino обрабатывает все вызовы функций и «новые» вызовы как 100 инструкций. Кроме того, размер любых входных данных, таких как значения URL, может повлиять на количество инструкций.
Учитывайте не только производительность скрипта, но и совокупную производительность всех скриптов. Adobe рекомендует в общей сложности менее 5000 инструкций. Подсчет количества инструкций не является очевидным, но важно отметить, что сценарии, превышающие 2000 инструкций, автоматически отключаются. Количество активных сценариев профиля не должно превышать 300. Каждый сценарий выполняется при каждом отдельном вызове mbox. Запускайте столько скриптов, сколько необходимо.
В регулярном выражении наличие точки-звезды в начале (например: /.*match/ , /a|.*b/ ) почти никогда не требуется. Поиск по регулярному выражению начинается со всех позиций в строке (если не связан с ^ ), поэтому точка-звезда уже предполагается. Выполнение скрипта может быть прервано, если такое регулярное выражение сопоставляется с достаточно длинными входными данными (которые могут содержать всего несколько сотен символов).
Если ничего не помогает, оберните скрипт в try/catch.
Следующие рекомендации помогут ограничить сложность сценария профиля. Скрипты профиля могут выполнять ограниченное количество инструкций.
Рекомендуется:
- Скрипты профиля должны быть небольшими и максимально простыми.
- Избегайте регулярных выражений или используйте только простые регулярные выражения. Для вычисления даже простых выражений может потребоваться много инструкций.
- Избегайте рекурсии.
- Перед добавлением в Target сценарии профилей должны быть протестированы на производительность. Все сценарии профилей выполняются при каждом запросе mbox. Если скрипты профиля выполняются неправильно, запросы mbox выполняются дольше, что может повлиять на трафик и конверсию.
- Если сценарии профиля становятся слишком сложными, рассмотрите возможность использования вместо них токенов ответа.
Дополнительную информацию см. в документации по движку JS Rhino.
Отладка скриптов профиля
Для отладки скриптов профилей можно использовать следующие методы:
Использование console.log в сценарии профиля не выводит значение профиля, поскольку сценарии профиля выполняются на стороне сервера.
Добавить сценарии профиля в качестве токенов ответа для отладки сценариев профиля:
В Target нажмите «Администрирование», нажмите «Токены ответа», затем включите скрипт профиля, который вы хотите отлаживать.
Каждый раз, когда вы загружаете страницу своего сайта с Target, часть ответа от Target содержит ваше значение для данного скрипта профиля, как показано ниже:
Используйте средство отладки mboxTrace для отладки скриптов профилей.
Для этого метода требуется токен авторизации, который можно сгенерировать, нажав «Цель» > «Администрирование» > «Реализация» > «Создать токен авторизации» в разделе «Инструменты отладчика».
Затем вы добавляете эти два параметра в URL своей страницы после «?»: mboxTrace=window&authorization=YOURTOKEN .
Добавление этих параметров немного более информативно, чем токен ответа, поскольку вы получаете моментальный снимок своего профиля до и после выполнения. Он также показывает все ваши доступные профили.
Часто задаваемые вопросы по скрипту профиля
Можно ли использовать сценарии профилей для сбора информации со страницы, которая находится на уровне данных?
Скрипты профиля не могут читать страницу напрямую, поскольку они выполняются на стороне сервера. Данные должны быть переданы через запрос mbox или с помощью других методов получения данных в Target. После того, как данные находятся в Target, сценарии профиля могут считывать данные как параметр mbox или параметр профиля.
Справочник по JavaScript для параметров профиля скрипта
Для эффективного использования
параметров профиля скрипта требуется простое знание Javascript. Этот раздел служит кратким справочником, который поможет вам продуктивно использовать эту функцию всего за несколько минут.
Параметры профиля скрипта находятся на вкладке mboxes/profiles. Вы можете писать программы Javascript, которые возвращают любой тип Javascript (строка, целое число, массив и т. д.).
Примеры параметров профиля скрипта
Имя: user.recency
Создает переменную для дня, измеряемую в миллисекундах. Если имя mbox — order ThankyouPage , установите локальный (невидимый) атрибут профиля пользователя с именем lastPurchaseTime, чтобы отображать значение текущей даты и времени. Считывается значение времени последней покупки, и, если оно определено, Target возвращает время, прошедшее с момента последней покупки, деленное на количество миллисекунд в дне (что дает количество дней с момента последней покупки).< /p>
Имя: user.частота
Создает переменную с именем Frequency , инициализируя ее либо предыдущим значением, либо 0, если предыдущего значения не было. Если имя mbox — order ThankyouPage , возвращается увеличенное значение.
Имя: user.monetaryValue
Создает переменную с именем moneyValue , которая ищет текущую стоимость для данного посетителя (или устанавливает значение 0, если предыдущего значения не было). Если имя mbox — order ThankyouPage , новое денежное значение возвращается путем добавления предыдущего значения и значения параметра orderTotal, передаваемого в mbox.
Название: adobeQA
Создает переменную с именем adobeQA для отслеживания пользователя для контроля качества активности.
Объекты и методы
С помощью параметров профиля скрипта можно ссылаться на следующие объекты и методы:
<р>. Например, если пользователь задает параметр профиля с именем «пол», значение можно извлечь с помощью «профиль.гендер». Возвращает значение профиля.» для текущего посетителя; возвращает null, если значение не установлено. Обратите внимание, что profile.get(
Распространенные операторы
Все стандартные операторы JavaScript присутствуют и могут использоваться. Операторы JavaScript можно использовать со строками и числами (и другими типами данных). Краткий брифинг:
| Оператор | Описание |
|---|---|
| == | Обозначает равенство. Имеет значение true, когда операнды с обеих сторон равны. |
| != | Указывает на неравенство. Имеет значение true, если операнды с обеих сторон не равны. |
| Указывает, что переменная слева меньше, чем переменная справа. Возвращает значение false, если переменные равны. | |
| > | Указывает, что переменная слева больше, чем переменная справа. Возвращает значение false, если переменные равны. |
| То же самое, за исключением того, что если переменные равны, то оно оценивается как значение true. | |
| >= | То же, что >, за исключением того, что если переменные равны, то он оценивается как истина. |
| && | Логически «И». ” выражения слева и справа от него – истинно только тогда, когда истинны обе стороны (ложь в противном случае). |
| ` | |
| // | Проверяет, содержит ли источник все элементы из целевого логического значения (источник массива, цель массива). // извлекает из цели подстроку (соответствующую регулярному выражению) и декодирует ее Array/*String*/ decode(String encoding, String regexp, String target) . Функция также поддерживает использование константных строковых значений , группировка (`условие1 |
Обучающее видео: сценарии профиля ![Значок обучения]()
Это видео содержит информацию об использовании и создании сценариев профиля.
На этой странице описаны настройки действий и параметров для намерений, а также то, как они используются, когда намерения сопоставляются во время выполнения.
Где найти эти данные
При создании агента чаще всего используется консоль Dialogflow ES (см. документацию, откройте консоль). В приведенных ниже инструкциях основное внимание уделяется использованию консоли. Чтобы получить доступ к данным о действиях и параметрах:
- Перейдите в консоль Dialogflow ES.
- Выберите агента.
- Выберите «Намерения» в меню левой боковой панели.
- Выберите намерение.
- Прокрутите вниз до раздела "Действие и параметры".
Если вы создаете агент с помощью API вместо консоли, см. справку по намерениям. Имена полей API аналогичны именам полей консоли. В приведенных ниже инструкциях отмечены все важные различия между консолью и API.
Действия
Поле action – это простое поле для удобства, которое помогает выполнять логику в вашей службе.
При создании агента вы можете указать в этом поле любой текст, который посчитаете нужным.
Когда намерение совпадает во время выполнения, Dialogflow предоставляет значение действия для вашего запроса веб-перехватчика выполнения или ответа на взаимодействие с API. Его можно использовать для запуска определенной логики в вашем сервисе.
Параметры
Когда намерение совпадает во время выполнения, Dialogflow предоставляет извлеченные значения из выражения конечного пользователя в качестве параметров. У каждого параметра есть тип, называемый типом объекта, который определяет, как именно извлекаются данные. В отличие от необработанного ввода конечного пользователя, параметры представляют собой структурированные данные, которые можно легко использовать для выполнения некоторой логики или генерирования ответов.
При создании агента вы управляете извлечением данных, добавляя аннотации к частям обучающих фраз и настраивая связанные параметры.
В следующем списке показаны поля конфигурации параметра. Показаны примеры обучающей фразы "забронировать номер во вторник", где есть аннотация "вторник".
- Обязательный. Установите этот флажок, если параметр необходим для выполнения намерения. См. раздел Заполнение слота необходимыми параметрами ниже.
- Имя параметра: имя, которое идентифицирует параметр. Пример: дата .
- Сущность: тип сущности, связанный с параметром. Пример: @sys.date .
- Значение: в большинстве случаев задается ссылка на параметр, например $parameter-name , которая используется в качестве заполнителя для извлеченного значения во время выполнения. Однако это поле также можно использовать для выбора альтернативных значений. См. раздел «Значения параметров и ссылки на параметры» ниже. Пример: $date .
- Список. Установите этот флажок, если значения должны быть возвращены в виде списка. См. раздел "Параметры списка" ниже.
- Подсказки: вопросы, которые агент будет задавать конечному пользователю, если этот параметр не указан. Это поле используется только в том случае, если отмечено поле «Обязательно». См. раздел Заполнение слота необходимыми параметрами ниже.
- Значение по умолчанию: это значение по умолчанию для параметра, если конечный пользователь не указывает его. Чтобы изменить значение по умолчанию с помощью консоли, необходимо навести указатель мыши на строку параметра и щелкнуть меню справа.
Когда намерение совпадает во время выполнения, Dialogflow предоставляет данные параметров для вашего запроса веб-перехватчика выполнения или ответа на взаимодействие с API. Они предоставляются как сопоставление имен параметров со значениями параметров.
При создании агента ваши ответы могут включать значения параметров. См. Значения параметров и ссылки на параметры ниже.
Список параметров
При создании агента с помощью консоли установка флажка «Список» настраивает параметр как список. Списки могут содержать несколько элементов. Например, агент по заказу продукции может ожидать следующих выражений конечного пользователя:
- "Я хочу яблоки"
- "Я хочу яблоки и апельсины"
- "Я хочу яблоки, апельсины и бананы"
При аннотировании обучающих фраз параметрами списка ваши фразы могут содержать один или несколько примеров параметров, и вы аннотируете каждый из них отдельно:
Значения параметров и ссылки на параметры
Ссылки на параметры — это переменные, которые содержат значения параметров, извлеченные во время выполнения. При создании агента вы можете использовать ссылки на параметры в ответах о намерениях, запросах параметров и в поле "Значение параметра".
Например, вы можете использовать $parameter-name в ответе о намерениях. Когда Dialogflow отвечает пользователю, он заменяет эту ссылку на параметр значением параметра, извлеченным во время выполнения. Это полезно для обобщения информации, предоставленной конечным пользователем. Например, ваш намеренный ответ может выглядеть так: "Хорошо, я забронировал для вас номер на $date".
Справочник по основным параметрам
Чтобы сослаться на значение параметра, извлеченное связанным объектом, используйте следующий формат:
Например, если имя параметра — date , вы можете сослаться на него как $date .
Ссылка на параметр для исходного значения
Когда текст сопоставляется с определенным объектом, он часто преобразуется в текст, более удобный для обработки. Например, слово «яблоки» в выражении конечного пользователя может быть извлечено как «яблоко» для фруктового объекта. Чтобы сослаться на значение параметра точно так, как оно было написано или произнесено конечным пользователем, используйте следующий формат:
Например, если имя параметра — date , вы можете сослаться на исходное значение как $date.original .
Справочник по параметрам для неоднозначных дат
Если параметр связан с системным объектом @sys.date, а конечный пользователь указывает неполную дату (без указания месяца, дня и года), Dialogflow будет соответствовать ближайшей дате в будущем. Однако вы также можете получить варианты этой даты.
Вы можете получить явное частичное совпадение, когда Dialogflow заменяет неизвестную часть буквой U, используя следующий формат:
Вы можете получить ближайшую дату в прошлом, используя следующий формат:
Например, если сегодняшняя дата – 11 августа 2021 года, имя параметра – date , а пользователь говорит "13 августа":
Справочник по параметрам составного объекта
Составные объекты — это объекты, которые содержат другие вложенные объекты. Чтобы сослаться на значение подсущности параметра, используйте следующий формат:
Например, если имя параметра — move , а имя подсущности — direction , вы можете сослаться на значение подсущности как $move.direction .
Справочник по параметрам для активного контекста
Контексты могут служить временным хранилищем значений параметров. Чтобы сослаться на значение параметра, полученное из активного контекста, используйте следующий формат:
Ссылка на параметр события
Для ссылки на параметр события используйте следующий формат:
Поле значения параметра
Ссылки на параметры в поле "Значение параметра" имеют особое значение. Содержимое этого поля определяет разрешенное значение имени $parameter-name в ответах о намерениях и запросах параметров. Dialogflow обрабатывает данные параметров в следующем порядке:
- Извлеките значение параметра из выражения конечного пользователя, используя связанный объект.
- Исправьте содержимое поля "Значение параметра".
- Задайте для параметра $parameter-name разрешенное содержимое поля "Значение параметра". Если в поле Значение не задано значение $parameter-name , это сбрасывает значение $parameter-name на другое значение.
- Разрешить контент для ответов о намерениях и запросов параметров.
Вот несколько примеров, иллюстрирующих влияние такого порядка на выражение конечного пользователя "Я хочу купить маленькую рубашку".
| Расположение ссылки на параметр | Настроенное содержимое | Разрешенное содержимое |
|---|---|---|
| Поле значения параметра | $size | S |
| Намеренный ответ | Вы выбрали размер : $size | Вы выбрали размер: S |
| Расположение ссылки на параметр | Настроенное содержимое | Разрешенное содержимое |
|---|---|---|
| Поле значения параметра | $size.original | small |
| Намеренный ответ | Вы выбрали размер: $size | Вы выбрали размер: small | < /tr>
| Расположение ссылки на параметр | Настроенное содержимое | Разрешенное содержимое |
|---|---|---|
| Поле значения параметра | $size | S |
| Намеренный ответ | Вы выбрали размер: $size.original | Вы выбрали размер: small |
Заполнение слота необходимыми параметрами
При создании агента вы можете пометить необходимые параметры. Намерение не считается завершенным, пока конечный пользователь не предоставит данные для каждого из этих обязательных параметров.
Когда намерение совпадает во время выполнения, агент Dialogflow продолжает собирать информацию от конечного пользователя до тех пор, пока конечный пользователь не предоставит данные для каждого из требуемых параметров. Этот процесс называется заполнение слота.
Dialogflow не отправляет запрос веб-перехватчика выполнения до тех пор, пока не соберет все необходимые данные от конечного пользователя, если не включен веб-перехватчик для заполнения слота.
Dialogflow отправляет ответ взаимодействия API для каждого шага заполнения слота. Для каждого из этих ответов на заполнение слота намерение и действие будут одинаковыми, и будут предоставлены собранные параметры.
При создании агента вы предоставляете подсказки, которые агент будет использовать для получения данных параметров от конечного пользователя. Вы также можете предоставить варианты подсказок, чтобы агент не всегда задавал один и тот же вопрос.
Например, предположим, что у агента вашего магазина одежды есть намерение с обязательными параметрами для:
Выполнение намерения может выглядеть следующим образом:
Пользователь: Я хотел бы купить футболку.
Агент: Сколько вам нужно?
Пользователь: 3
Агент: Какой цвет вы хотите?
Пользователь: Черный
Агент: Какой размер?
Пользователь: Medium
Агент: Понятно, это три черные футболки среднего размера
Если конечный пользователь предоставляет данные для более чем одного параметра в одном выражении, Dialogflow собирает предоставленные данные и продолжает запрашивать недостающие данные. Например, конечный пользователь может сказать: «Я хотел бы купить три черных футболки». Dialogflow запросит у пользователя размер.
Параметры заказа
При создании агента вы можете упорядочить параметры, которые определяют порядок, в котором агент будет запрашивать у конечного пользователя отсутствующие данные.
При создании агента из консоли при наведении курсора на параметр справа отображается значок изменения порядка. Вы можете перетащить этот значок, чтобы изменить положение параметра в списке.
Ссылки на параметры в подсказках
При построении агента вы можете использовать ссылки на параметры в подсказках, но только для обязательных параметров перед подсказкой. Например, если параметр цвета находится перед параметром количества, вы можете использовать следующую подсказку для параметра количества: Сколько футболок $color вы хотите купить?
Отменить заполнение слота
Когда конечный пользователь произносит фразу выхода, например "Отмена", "Прекрати", "Достаточно" и т. д., агент отвечает "Хорошо, отменено" и очищает контексты заполнения слотов.
Если не указано иное, содержимое этой страницы предоставляется по лицензии Creative Commons Attribution 4.0, а образцы кода — по лицензии Apache 2.0. Подробнее см. в Правилах сайта Google Developers. Java является зарегистрированным товарным знаком Oracle и/или ее дочерних компаний.
Читайте также: