Você está aqui:
Funções de matriz e lista do OmniStudio
Funções que operam em listas e matrizes.
- Função AVG do OmniStudio
Retorna a média de uma lista ou matriz JSON de valores numéricos. - Função de filtro do OmniStudio
Filtra uma lista de objetos JSON por uma condição especificada e retorna uma lista JSON de objetos correspondentes. - Função LIST do OmniStudio
Converte uma lista ou uma matriz JSON nomeada em uma matriz JSON anônima. - Função LISTMERGE do OmniStudio
Mescla nós de duas ou mais listas JSON de objetos em uma única lista JSON com base nos valores de uma ou mais chaves de mesclagem. - Função LISTMERGEPRIMARY do OmniStudio
Aumenta os nós de uma lista JSON primária de objetos com dados de uma ou mais outras listas JSON com base nos valores de uma ou mais chaves de mesclagem. - Função LISTSIZE do OmniStudio
Retorna o número de itens em uma lista ou matriz JSON. - Função MAPTOLIST do OmniStudio
Converte um objeto JSON ou uma hierarquia de objetos em uma lista JSON. - Função MAX do OmniStudio
Retorna o valor máximo de uma lista ou matriz JSON de valores numéricos. - Função MIN do OmniStudio
Retorna o valor mínimo de uma lista ou matriz JSON de valores numéricos. - Função SORTBY do OmniStudio
Classifica uma lista JSON de objetos por chaves especificadas e retorna uma lista JSON classificada. (Apenas Mapeadores de dados) - Função SUM do OmniStudio
Retorna a soma de uma lista ou matriz JSON de valores numéricos.
Função AVG do OmniStudio
Retorna a média de uma lista ou matriz JSON de valores numéricos.
Assinatura
AVG(list)
Valor de retorno
Número
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista de números |
Obrigatório |
Uma lista separada por vírgulas de valores numéricos ou uma lista de valores numéricos de uma matriz JSON. Valores nulos na lista contam para o denominador, o que reduz a média. |
Fórmula: AVG(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
Valor de retorno: 5.5
Dados de amostra:
"List": [
{
"Item": 3.5
},
{
"Item": 4.25
},
{
"Item": 5.75
}
]
Fórmula: AVG(List:Item)
Fórmula: AVG(%List:Item%)
Valor de retorno: 4.5
Função de filtro do OmniStudio
Filtra uma lista de objetos JSON por uma condição especificada e retorna uma lista JSON de objetos correspondentes.
A função realiza a correspondência de strings sem distinção entre maiúsculas e minúsculas.
Assinatura
FILTER(LIST(list), condition)
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista JSON |
Obrigatório |
Uma matriz JSON anônima de objetos a serem filtrados. Use a função |
|
Expressão |
Obrigatório |
Uma expressão de equivalência que identifica o nó a ser filtrado e o valor que o nó deve ter para qualificar como uma correspondência. Especifique o valor como uma string ou uma variável. Você deve colocar toda a expressão entre aspas e também cotar um valor de string dentro da expressão. |
Dados de amostra:
"NameList": [
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Fórmula: FILTER(LIST(NameList), 'LastName == "Xavier"')
Fórmula: FILTER(LIST(NameList), "LastName == 'Xavier'")
Valor de retorno:
[
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Zellie",
"LastName": "Xavier"
}
]
Dados de amostra:
"NameList": [
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
],
"FindName": "Xavier"
Fórmula: FILTER(LIST(NameList), 'LastName == "' + FindName + '"')
Fórmula: FILTER(LIST(NameList), "LastName == '" + FindName + "'")
Valor de retorno:
[
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Zellie",
"LastName": "Xavier"
}
]
Função LIST do OmniStudio
Converte uma lista ou uma matriz JSON nomeada em uma matriz JSON anônima.
Use a função LIST com outras funções que exigem uma matriz JSON anônima (uma lista JSON) como entrada: FILTER, LISTMERGE, LISTMERGEPRIMARY, SERIALIZE, SORTBY e um FUNCTION personalizado que passa uma lista JSON como um argumento.
Assinatura
LIST(expression)
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Matriz JSON nomeada ou de lista |
Obrigatório |
Uma expressão que é resolvida em uma lista de valores ou objetos JSON ou em uma matriz JSON nomeada de um ou mais valores ou objetos. Cada objeto pode conter um ou mais nós ou pares de chave e valor. Se você passar uma matriz JSON anônima, a função retornará uma matriz com um único objeto |
Fórmula: LIST("a", "b", "c")
Valor de retorno: [ "a", "b", "c" ]
Fórmula: LIST(1, 2, 2, 3, 3, 4)
Valor de retorno: [ 1, 2, 2, 3, 3, 4 ]
Dados de amostra:
"Contact": {
"FirstName": "Mike",
"LastName": "Smith"
}
Fórmula: LIST(Contact)
Valor de retorno:
[
{
"LastName": "Smith",
"FirstName": "Mike"
}
]
Dados de amostra:
"NameList": [
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Fórmula: LIST(NameList)
Valor de retorno:
[
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Dados de amostra:
"Account": [
{
"Cases": [
{
"Case1": {
"CreatedDate": "2/1/2004T16:35:30 GMT -0500 (EDT)",
"LastUpdate": "2/8/2024T09:15:00 GMT -0500 (EDT)"
}
},
{
"Case2": {
"CreatedDate": "2/2/2004T11:05:05 GMT -0500 (EDT)",
"LastUpdate": "2/3/2024T15:50:57 GMT -0500 (EDT)"
}
}
]
}
]
Fórmula: LIST(Account:Cases)
Valor de retorno:
[
{
"Case1": {
"CreatedDate": "2/1/2024T16:35:30 GMT -0500 (EDT)",
"LastUpdate": "2/8/2024T09:15:00 GMT -0500 (EDT)"
}
},
{
"Case2": {
"CreatedDate": "2/2/2025T11:05:05 GMT -0500 (EDT)",
"LastUpdate": "2/3/2025T15:50:57 GMT -0500 (EDT)"
}
}
]
Função LISTMERGE do OmniStudio
Mescla nós de duas ou mais listas JSON de objetos em uma única lista JSON com base nos valores de uma ou mais chaves de mesclagem.
A função combina nós das matrizes JSON anônimas especificadas quando os valores das chaves de mesclagem nomeadas correspondem. A lista resultante contém todos os nós e chaves de todas as listas mescladas. Se as listas contiverem nós com chaves de mesclagem idênticas, mas valores diferentes, os valores de nós posteriores substituirão os valores de nós anteriores. A função realiza a correspondência sem distinção entre maiúsculas e minúsculas de chaves de mesclagem.
Assinatura
LISTMERGE(mergeKey..., LIST(list)...)
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
String |
Obrigatório |
Uma lista separada por vírgulas de uma ou mais chaves. A função combina nós das listas quando os valores de suas chaves de mesclagem correspondem. |
|
Lista JSON |
Obrigatório |
Duas ou mais matrizes JSON anônimas a serem mescladas. Use a função |
Dados de amostra:
"ContactNames": [
{
"id": "0036ab",
"lastName": "Jones",
"firstName": "Cathy"
},
{
"id": "2787kq",
"lastName": "Smith",
"firstName": "Albert"
},
{
"id": "3610xr",
"lastName": "Smith",
"firstName": "Ben"
}
],
"ContactAddresses": [
{
"id": "0036ab",
"city": "Phoenix",
"state": "AZ"
},
{
"id": "2787kq",
"city": "San Francisco",
"state": "CA"
},
{
"id": "3610xr",
"city": "Portland",
"state": "OR"
}
],
"ContactBirthdates": [
{
"id": "0036ab",
"birthdate": "1976-10-04"
},
{
"id": "2787kq",
"birthdate": "1973-10-01"
},
{
"id": "3610xr",
"birthdate": "1974-10-02"
}
]
Fórmula: LISTMERGE("id", LIST(ContactNames), LIST(ContactAddresses), LIST(ContactBirthdates))
Valor de retorno:
[
{
"id": "0036ab",
"lastName": "Jones",
"firstName": "Cathy",
"city": "Phoenix",
"state": "AZ",
"birthdate": "1976-10-04"
},
{
"id": "2787kq",
"lastName": "Smith",
"firstName": "Albert",
"city": "San Francisco",
"state": "CA",
"birthdate": "1973-10-01"
},
{
"id": "3610fw",
"lastName": "Smith",
"firstName": "Ben",
"city": "Portland",
"state": "OR",
"birthdate": "1974-10-02"
}
]
Função LISTMERGEPRIMARY do OmniStudio
Aumenta os nós de uma lista JSON primária de objetos com dados de uma ou mais outras listas JSON com base nos valores de uma ou mais chaves de mesclagem.
A função aumenta os nós da primeira matriz JSON anônima (principal) especificada com dados de todas as outras matrizes JSON anônimas especificadas quando os valores das chaves de mesclagem nomeadas correspondem. A lista resultante contém todos os nós e chaves da primeira lista junto com chaves das outras listas correspondentes. Se nós de listas posteriores com chaves de mesclagem idênticas tiverem valores diferentes da primeira lista, os valores de nós posteriores substituirão os valores de nós anteriores. A função realiza a correspondência sem distinção entre maiúsculas e minúsculas de chaves de mesclagem.
Por exemplo, use a função quando você tiver uma lista de produtos qualificados que deseja aumentar com dados de listas relacionadas. A função não inclui produtos de listas posteriores que aparecem na lista primária.
Assinatura
LISTMERGEPRIMARY(mergeKey..., LIST(list)...)
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
String |
Obrigatório |
Uma lista separada por vírgulas de uma ou mais chaves. A função aumenta nós da primeira lista com chaves das outras listas quando os valores de suas chaves de mesclagem correspondem. |
|
Lista JSON |
Obrigatório |
Uma matriz JSON anônima primária a ser estendida com dados de uma ou mais outras matrizes JSON anônimas. A função inclui apenas nós da primeira lista na lista que retorna. Use a função |
Dados de amostra:
"ContactNames": [
{
"id": "0036ab",
"lastName": "Jones",
"firstName": "Cathy"
},
{
"id": "3610xr",
"lastName": "Smith",
"firstName": "Ben"
}
],
"ContactAddresses": [
{
"id": "0036ab",
"city": "Phoenix",
"state": "AZ"
},
{
"id": "7723hw",
"lastName": "Sacramento",
"firstName": "CA"
},
{
"id": "2787kq",
"city": "San Francisco",
"state": "CA"
},
{
"id": "3610xr",
"city": "Portland",
"state": "OR"
}
],
"ContactBirthdates": [
{
"id": "0036ab",
"birthdate": "1976-10-04"
},
{
"id": "7723hw",
"birthdate": "1974-07-04"
},
{
"id": "2787kq",
"birthdate": "1973-10-01"
},
{
"id": "3610xr",
"birthdate": "1974-10-02"
}
]
Fórmula: LISTMERGEPRIMARY("id", LIST(ContactNames), LIST(ContactAddresses), LIST(ContactBirthdates))
Valor de retorno:
[
{
"id": "0036ab",
"lastName": "Jones",
"firstName": "Cathy",
"city": "Phoenix",
"state": "AZ",
"birthdate": "1976-10-04"
},
{
"id": "3610fw",
"lastName": "Smith",
"firstName": "Ben",
"city": "Portland",
"state": "OR",
"birthdate": "1974-10-02
}
]
Função LISTSIZE do OmniStudio
Retorna o número de itens em uma lista ou matriz JSON.
Para testar uma matriz vazia, use a função ISBLANK.
Assinatura
LISTSIZE(list)
Valor de retorno
Número
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Matriz de lista ou JSON |
Obrigatório |
Uma lista separada por vírgulas de valores ou uma matriz JSON de valores ou nós. |
Fórmula: LISTSIZE(6, 7, 8, 9, 10)
Valor de retorno: 5
Fórmula: LISTSIZE()
Fórmula: LISTSIZE(())
Valor de retorno: 0
Dados de amostra:
"NameList": [
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Fórmula: LISTSIZE(NameList)
Valor de retorno: 3
Dados de amostra: "EmptyList": []
Fórmula: LISTSIZE([])
Fórmula: LISTSIZE(EmptyList)
Valor de retorno: 1
Fórmula: IF(ISBLANK(EmptyList), 0, LISTSIZE(EmptyList))
Valor de retorno: 0
Função MAPTOLIST do OmniStudio
Converte um objeto JSON ou uma hierarquia de objetos em uma lista JSON.
Assinatura
MAPTOLIST(jsonObject)
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Objeto JSON |
Obrigatório |
Um nó ou caminho de nó de um objeto JSON para converter em uma lista JSON. Cada nó pode conter um ou mais nós ou pares de chave e valor. |
Dados de amostra:
"Contact": {
"FirstName": "William",
"MiddleName": "Leslie",
"LastName": "Edison",
"Parents": {
"Father": {
"FirstName": "Thomas",
"MiddleName": "Alva",
"LastName": "Edison"
},
"Mother": {
"FirstName": "Mary",
"MiddleName": "Stilwell",
"LastName": "Edison"
}
}
}
Fórmula: MAPTOLIST(Contact)
Valor de retorno:
[
{
"LastName": "Edison"
},
{
"MiddleName": "Leslie"
},
{
"FirstName": "William"
},
{
"Parents": {
"Father": {
"MiddleName": "Alva",
"LastName": "Edison",
"FirstName": "Thomas"
},
"Mother": {
"MiddleName": "Stilwell",
"LastName": "Edison",
"FirstName": "Mary"
}
}
}
]
Fórmula: MAPTOLIST(Contact:Parents)
Valor de retorno:
[
{
"Mother": {
"MiddleName": "Stilwell",
"LastName": "Edison",
"FirstName": "Mary"
}
},
{
"Father": {
"MiddleName": "Alva",
"LastName": "Edison",
"FirstName": "Thomas"
}
}
]
Fórmula: MAPTOLIST(Contact:Parents:Mother)
Valor de retorno:
[
{
"LastName": "Edison"
},
{
"MiddleName": "Stilwell"
},
{
"FirstName": "Mary"
}
]
Função MAX do OmniStudio
Retorna o valor máximo de uma lista ou matriz JSON de valores numéricos.
Assinatura
MAX(list)
Valor de retorno
Número
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista de números |
Obrigatório |
Uma lista separada por vírgulas de valores numéricos ou uma lista de valores numéricos de uma matriz JSON. |
Fórmula: MAX(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
Valor de retorno: 10
Dados de amostra:
"List": [
{
"Item": 3
},
{
"Item": 4
},
{
"Item": 5
}
]
Fórmula: MAX(List:Item)
Valor de retorno: 5
Função MIN do OmniStudio
Retorna o valor mínimo de uma lista ou matriz JSON de valores numéricos.
Assinatura
MIN(list)
Valor de retorno
Número
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista de números |
Obrigatório |
Uma lista separada por vírgulas de valores numéricos ou uma lista de valores numéricos de uma matriz JSON. |
Fórmula: MIN(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
Valor de retorno: 1
Dados de amostra:
"List": [
{
"Item": 3
},
{
"Item": 4
},
{
"Item": 5
}
]
Fórmula: MIN(List:Item)
Valor de retorno: 3
Função SORTBY do OmniStudio
Classifica uma lista JSON de objetos por chaves especificadas e retorna uma lista JSON classificada. (Apenas Mapeadores de dados)
A função realiza a correspondência sem distinção entre maiúsculas e minúsculas de chaves e classificação de valores.
Assinatura
SORTBY(LIST(list), key..., [:DSC])
Valor de retorno
Lista JSON
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista JSON |
Obrigatório |
Uma matriz JSON anônima de objetos a serem classificados. Use a função |
|
String |
Obrigatório |
Uma ou mais chaves pelas quais os objetos JSON devem ser classificados. |
|
String |
Opcional |
Classifica os resultados em ordem decrescente. Você deve colocar o valor entre aspas simples ou duplas, por exemplo, |
Dados de amostra:
"NameList": [
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Fórmula: SORTBY(LIST(NameList), 'LastName', 'FirstName')
Valor de retorno:
[
{
"FirstName": "Mike",
"LastName": "Smith"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Zellie",
"LastName": "Xavier"
}
]
Dados de amostra:
"NameList": [
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Fórmula: SORTBY(LIST(NameList), 'LastName', 'FirstName', '[:DSC]')
Valor de retorno:
[
{
"FirstName": "Zellie",
"LastName": "Xavier"
},
{
"FirstName": "Aaron",
"LastName": "Xavier"
},
{
"FirstName": "Mike",
"LastName": "Smith"
}
]
Função SUM do OmniStudio
Retorna a soma de uma lista ou matriz JSON de valores numéricos.
Assinatura
SUM(list)
Valor de retorno
Número
Parâmetros
Parâmetro |
Tipo de dados |
Necessidade |
Descrição |
|---|---|---|---|
|
Lista de números |
Obrigatório |
Uma lista separada por vírgulas de valores numéricos ou uma lista de valores numéricos de uma matriz JSON. |
Fórmula: SUM(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
Valor de retorno: 55
Dados de amostra:
"List": [
{
"Item": 3.5
},
{
"Item": 4.25
},
{
"Item": 5.75
}
]
Fórmula: SUM(List:Item)
Fórmula: SUM(%List:Item%)
Valor de retorno: 13.5

