Pular para o conteúdo

API de tags de objeto (beta)

As tags de objeto armazenam dados estruturados sobre um usuário em uma única tag. Uma tag do tipo Object contém um objeto com campos nomeados, como o último order com seu amount e status. Uma tag do tipo ObjectList contém um array desses objetos, como todos os orders. Um campo pode ser, por sua vez, um objeto ou uma lista de objetos, como o address de um profile. Você define os campos uma vez, grava e lê os valores pela API de tags, cria segmentos pelos valores dos campos e insere os valores nas mensagens com Liquid.

Como funcionam as tags de objeto

Anchor link to

Uma tag de objeto tem um esquema e um valor. O esquema é o nome da tag e uma lista de campos, cada um com seu próprio tipo. O valor é armazenado nos campos, separadamente para cada usuário.

  • Campo. Cada campo é uma tag com o nome <object>.<field>, por exemplo order.amount. Você segmenta por campos e pode gravar um campo de uma tag Object por esse nome.
  • Valor Object. Um objeto por usuário, por exemplo "order": {"amount": 120, "status": "paid"}.
  • Valor ObjectList. Um array de objetos com os mesmos campos, por exemplo "orders": [{"amount": 120, "status": "paid"}, {"amount": 50}].
  • Objeto aninhado. Um campo do tipo OBJECT com campos próprios, por exemplo profile.address com o campo profile.address.city.
  • Lista aninhada. Um campo do tipo OBJECT_LIST, um array de objetos dentro de uma tag de objeto, por exemplo profile.visits. Consulte Objetos e listas aninhados.

Na API, os tipos de tag e de campo são OBJECT e OBJECT_LIST. No Painel de Controle, eles são Objeto e Lista de objetos. Nesta página, uma lista de objetos significa uma tag ObjectList ou uma lista aninhada.

As tags de objeto são sempre User-specific, o que significa que o valor pertence ao usuário, não a um único dispositivo, e é copiado para todos os dispositivos do usuário. Consulte a API de Tags para tags comuns.

Objetos e listas aninhados

Anchor link to

Um campo de uma tag de objeto pode conter seus próprios campos em vez de um único valor. Um objeto aninhado, um campo do tipo OBJECT, contém um objeto. Uma lista aninhada, um campo do tipo OBJECT_LIST, contém uma lista de objetos. Um elemento de uma lista também pode conter objetos aninhados e listas aninhadas. Cada campo mantém seu nome completo com pontos, como profile.address.city, e você segmenta por esses nomes.

Por exemplo, uma tag profile do tipo OBJECT e uma tag orders do tipo OBJECT_LIST podem ter esta estrutura:

profile OBJECT
├── address OBJECT
│ ├── city STRING
│ └── geo OBJECT
│ └── lat STRING
└── visits OBJECT_LIST
└── code STRING
orders OBJECT_LIST
├── sku STRING
├── meta OBJECT
│ └── color STRING
└── lines OBJECT_LIST
└── qty INTEGER

Campos pesquisáveis e campos apenas armazenados

Anchor link to

O que você pode fazer com um campo depende de quantas listas de objetos existem acima dele:

  • Nenhuma lista acima do campo. Você pode segmentar por um campo como profile.address.city, gravá-lo isoladamente pelo seu nome completo e usá-lo nas mensagens.
  • Uma lista acima do campo. Você pode segmentar por um campo como profile.visits.code ou orders.meta.color e usá-lo nas mensagens. Grave-o apenas como parte da lista inteira.
  • Duas listas acima do campo. Um campo como orders.lines.qty é apenas armazenado. Use-o nas mensagens, mas não nos segmentos.

A Pushwoosh aplica estes limites às tags de objeto, incluindo objetos aninhados e listas aninhadas:

LimiteValorQuando é excedido
Profundidade de aninhamento3 níveis de objetos e listas. A própria tag é o primeiro nível, então profile.address.geo é o objeto mais profundo permitidoO método de esquema retorna HTTP 400, consulte Erros
Campos em um objetoDe 1 a 20, para a tag e para cada objeto aninhado ou lista aninhadaO método de esquema retorna HTTP 400, consulte Erros
Campos com valores em uma tag de objeto50, incluindo os campos aninhados. Campos dos tipos OBJECT e OBJECT_LIST não contamO método de esquema retorna HTTP 400, consulte Erros
Nome completo do campo64 caracteres, como profile.address.cityO método de esquema retorna HTTP 400, consulte Erros
Elementos em uma lista de objetos100, para a tag e para cada lista aninhadaTodo o valor gravado é rejeitado
Tamanho de um valor gravado64 KB de JSONTodo o valor gravado é rejeitado

Um valor rejeitado é tratado da mesma forma que um valor com um tipo de campo errado, consulte A gravação substitui o valor inteiro.

Regras do esquema

Anchor link to

A Pushwoosh verifica estas regras quando você cria uma tag de objeto ou adiciona um campo:

  • Os nomes de objetos e campos contêm apenas letras latinas, dígitos e _.
  • A tag e cada objeto aninhado ou lista aninhada têm de 1 a 20 campos. Os outros limites também se aplicam. Os nomes dos campos não diferenciam maiúsculas de minúsculas, portanto Amount e amount são o mesmo campo.
  • Um campo tem um destes tipos: INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, OBJECT, OBJECT_LIST. Um campo do tipo OBJECT ou OBJECT_LIST precisa dos seus próprios fields. Campos de fuso horário não são suportados.
  • Um campo não pode ter um nome que outra tag já tenha. Se existir uma tag order.note, adicionar o campo note a order falha com tag order.note already exists.
  • Um objeto não pode perder seu último campo. Em vez disso, exclua o objeto.
  • Um campo ou uma tag de objeto em uso não pode ser excluído. Um objeto aninhado ou uma lista aninhada conta como em uso quando qualquer coisa dentro dele é usada. O erro lista onde ele é usado, por exemplo field is in use: segment Big buyers, in-app Spring sale. Segmentos, in-apps, campanhas de Customer Journey em execução, presets, modelos de e-mail e outros itens que fazem referência à tag contam como usos.

Gerenciar tags de objeto no Painel de Controle

Anchor link to

Crie uma tag de objeto sem objetos aninhados e listas aninhadas no Painel de Controle:

  1. Na página Tags do seu Painel de Controle, clique em Criar tag.
  2. Insira o Nome da tag.
  3. Em Tipo de valor, escolha Objeto ou Lista de objetos.
  4. Em Campos, insira o nome do primeiro campo.
  5. Escolha o tipo do campo.
  6. Para adicionar outro campo, clique em Adicionar campo.
  7. Clique em Criar.

Na página da tag, adicione um campo ou clique em Remover ao lado de um campo para excluí-lo. O Painel de Controle não consegue criar um objeto aninhado ou uma lista aninhada nem alterar os seus campos. Ele mostra um objeto aninhado ou uma lista aninhada criados pela API como um único campo do tipo Objeto ou Lista de objetos. Excluir esse campo o exclui com tudo o que está dentro dele.

Gerenciar o esquema

Anchor link to

Crie e altere tags de objeto com os métodos REST abaixo. Use /json/1.3/addTag apenas para tags comuns, porque ele não consegue definir campos.

https://rpc-api.svc-nue.pushwoosh.com

Autenticação

Anchor link to

Toda solicitação deve incluir um cabeçalho Authorization com o seu token de API do Servidor. Um token de API do Dispositivo recebe HTTP 403 a device API token cannot call this method, use an account API token.

Authorization: Api YOUR_API_TOKEN

Estes métodos gerenciam o esquema das tags de objeto e leem os valores dos seus campos:

MétodoCaminhoDescrição
POST/api/tagsCriar uma tag de objeto com seus campos
GET/api/tags/{name}Obter uma tag de objeto com seus campos
GET/api/tagsListar tags. Uma tag de objeto vem com todos os seus fields, incluindo os aninhados, e os campos não são listados como tags separadas
POST/api/tags/{name}/fieldsAdicionar um campo a uma tag de objeto, a um objeto aninhado ou a uma lista aninhada
DELETE/api/tags/{name}/fields/{field}Excluir um campo, um objeto aninhado ou uma lista aninhada
DELETE/api/tags/{name}Excluir uma tag de objeto com todos os seus campos
GET/api/tags:valuesListar os valores armazenados de um campo, consulte Valores armazenados de um campo

POST /api/tags retorna a tag de objeto, e ambos os métodos de campos retornam o objeto indicado em {name} após a alteração, envolvido em {"tag": {...}}. DELETE /api/tags/{name} retorna {}.

Se as tags de objeto não estiverem habilitadas na sua conta, POST /api/tags com um tipo de objeto e ambos os métodos de campos falham com HTTP 403 object tags are not enabled for the account. GET /api/tags/{name} e DELETE /api/tags/{name} retornam HTTP 404 tag not found, e GET /api/tags não lista as tags de objeto. Sem as tags de objeto habilitadas, você não consegue criar nenhuma, então não há onde gravar valores.

Criar uma tag de objeto

Anchor link to

POST /api/tags

Corpo da solicitação
Anchor link to
NomeTipoDescrição
name*stringNome da tag de objeto.
type*stringOBJECT para um objeto ou OBJECT_LIST para uma lista de objetos.
fields*arrayCampos do objeto, de 1 a 20.
fields[].name*stringNome do campo. O campo se torna a tag <name>.<fields[].name>.
fields[].type*stringTipo do campo: INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, OBJECT ou OBJECT_LIST.
fields[].fieldsarrayCampos de um objeto aninhado ou lista aninhada, de 1 a 20, no mesmo formato. Obrigatório para os tipos OBJECT e OBJECT_LIST e ignorado para os outros tipos.
Exemplo
{
"name": "orders",
"type": "OBJECT_LIST",
"fields": [
{ "name": "amount", "type": "INTEGER" },
{ "name": "status", "type": "STRING" }
]
}
Resposta
{
"tag": {
"name": "orders",
"type": "OBJECT_LIST",
"system": false,
"user_specific": true,
"has_right_ace_modify": true,
"fields": [
{ "name": "amount", "type": "INTEGER", "fields": [] },
{ "name": "status", "type": "STRING", "fields": [] }
]
}
}

A tag é criada como User-specific independentemente do valor de user_specific. GET /api/tags/{name} retorna o mesmo objeto sem o invólucro tag. Os campos são ordenados por nome, e um campo sem campos aninhados vem com um array fields vazio.

Para criar objetos aninhados e listas aninhadas, dê a um campo o tipo OBJECT ou OBJECT_LIST e seus próprios fields. Uma única solicitação cria toda a estrutura:

Exemplo: a tag profile de Objetos e listas aninhados
{
"name": "profile",
"type": "OBJECT",
"fields": [
{
"name": "address",
"type": "OBJECT",
"fields": [
{ "name": "city", "type": "STRING" },
{ "name": "geo", "type": "OBJECT", "fields": [{ "name": "lat", "type": "STRING" }] }
]
},
{
"name": "visits",
"type": "OBJECT_LIST",
"fields": [{ "name": "code", "type": "STRING" }]
}
]
}

Os campos aninhados voltam com nomes relativos ao seu objeto, como city dentro de address. GET /api/tags/{name} aceita apenas o nome da própria tag. Um nome aninhado como profile.address retorna HTTP 404 tag not found.

Adicionar um campo

Anchor link to

POST /api/tags/{name}/fields

Exemplo: POST /api/tags/orders/fields
{
"field": { "name": "note", "type": "STRING" }
}

Para adicionar um campo a um objeto aninhado ou lista aninhada, coloque o nome completo dele em {name}, por exemplo POST /api/tags/profile.address/fields ou POST /api/tags/profile.visits/fields. O novo campo pode ser um objeto aninhado ou uma lista aninhada com seus próprios fields:

Exemplo: POST /api/tags/profile/fields
{
"field": {
"name": "company",
"type": "OBJECT",
"fields": [{ "name": "title", "type": "STRING" }]
}
}

Você pode gravar o novo campo imediatamente como parte do valor completo da tag. Adicionar um campo falha se o objeto já tiver 20 campos, se o campo violar outro limite ou se existir uma tag com o nome completo do campo, consulte Erros.

Excluir um campo

Anchor link to

DELETE /api/tags/{name}/fields/{field}

Por exemplo, DELETE /api/tags/orders/fields/note exclui o campo orders.note. Para excluir um campo de um objeto aninhado ou lista aninhada, coloque o nome completo dele em {name}: DELETE /api/tags/profile.address/fields/city.

Excluir um objeto aninhado ou uma lista aninhada exclui tudo o que está dentro dele: DELETE /api/tags/profile/fields/address também exclui profile.address.city e profile.address.geo. Você não pode excluir o último campo de um objeto, nem um campo, um objeto aninhado ou uma lista aninhada em uso, consulte Erros.

Os erros vêm no formato {"code": <n>, "message": "...", "details": [...]}. Quando você cria uma tag de objeto, uma mensagem 400 tem a forma validate: rpc error: code = InvalidArgument desc = <message>, em que <message> é o texto da tabela. Nessas mensagens, <object> é o nome completo do objeto, como profile.address.

Status HTTPMensagemCausa
400object tag and field names must contain only letters, digits and underscoresUm nome tem outro caractere.
400<object>: an object needs 1 to 20 fieldsNa criação, a tag, um objeto aninhado ou uma lista aninhada não tem campos ou tem mais de 20 campos.
400an object has at most 20 fieldsO objeto ao qual você adiciona um campo já tem 20 campos.
400<object>.<field>: objects nest at most 3 levels deepUm campo OBJECT ou OBJECT_LIST ficaria no quarto nível.
400an object tag holds at most 50 fields with values, nested ones includedA tag de objeto teria mais de 50 campos com valores.
400field <name> is given twiceDois campos têm o mesmo nome, ignorando maiúsculas e minúsculas.
400<object>.<field>: object and field names together cannot be longer than 64 charactersO nome completo do campo é longo demais.
400<object>.<field>: field type must be INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, OBJECT or OBJECT_LISTTipo de campo não suportado.
400an object needs at least one field; delete the object insteadVocê tentou excluir o último campo de um objeto.
400field is in use: ..., tag is in use: ...O campo, algo dentro do objeto aninhado ou da lista aninhada, ou a tag de objeto é usado em segmentos, in-apps, campanhas de Customer Journey ou outros itens.
403object tags are not enabled for the accountAs tags de objeto não estão habilitadas na conta.
403a device API token cannot call this method, use an account API tokenA solicitação usa um token de API do Dispositivo.
404tag not foundGET ou DELETE /api/tags/{name}: a tag não existe, o nome é um campo ou as tags de objeto não estão habilitadas.
404object tag not found, field not foundMétodos de campos: a tag de objeto, o objeto aninhado, a lista aninhada ou o campo não existe. Um {name} que é um campo com valor também retorna object tag not found.
409tag already existsExiste uma tag com o nome da tag de objeto.
409tag <object>.<field> already existsExiste uma tag com o nome completo do campo.

Gravar valores

Anchor link to

Grave os valores das tags de objeto com /setTags e /bulkSetTags. Esses métodos mantêm sua própria autenticação: /setTags recebe um token de API do Dispositivo no cabeçalho Authorization: Token, e /bulkSetTags recebe o token de acesso à API em auth. Envie um valor Object como um objeto JSON e um valor ObjectList como um array de objetos:

Exemplo: /json/1.3/setTags
{
"request": {
"application": "XXXXX-XXXXX",
"userId": "user_42",
"tags": {
"order": { "amount": 120, "status": "paid" },
"orders": [
{ "amount": 120, "status": "paid" },
{ "amount": 50 }
]
}
}
}

Se você definir o valor por HWID, ele é armazenado no usuário desse dispositivo. POST /api/devices:set_tags na URL base dos métodos de esquema grava tags de objeto pelas mesmas regras. A resposta dele lista os campos dos objetos como nomes planos, como "profile.address.city".

Um objeto aninhado recebe um objeto JSON, e uma lista aninhada recebe um array de objetos:

Exemplo: valores aninhados em /json/1.3/setTags
"tags": {
"profile": {
"address": { "city": "Berlin", "geo": { "lat": "52.5" } },
"visits": [{ "code": "v1" }]
},
"orders": [
{ "sku": "A-1", "meta": { "color": "red" }, "lines": [{ "qty": 2 }, { "qty": 3 }] }
]
}

Cada campo recebe um valor no formato do seu tipo:

Tipo de campoValor de exemplo
INTEGER120
STRING"paid"
LIST["gift", "express"]
DATE"2026-10-02 22:11" (UTC), "2026-10-02" ou um timestamp Unix em segundos
BOOLEANtrue ou false
PRICE19.95
VERSION"1.0.0"

A gravação substitui o valor inteiro

Anchor link to

Cada gravação substitui o valor armazenado da tag de objeto:

  • Um campo ausente no novo valor é excluído. Um campo enviado como null também é excluído.
  • null, [] ou "" exclui o valor inteiro.
  • {} exclui todos os campos de uma tag Object.
  • Uma chave que não é um campo do objeto é ignorada.
  • Se o valor de um campo em qualquer profundidade não corresponder ao tipo do campo, o valor inteiro da tag é rejeitado e o valor armazenado permanece como estava. O mesmo acontece se o valor violar um limite: uma lista com mais de 100 elementos ou mais de 64 KB de JSON.

/setTags não informa um valor rejeitado na sua resposta e retorna HTTP 200. Verifique o resultado com /getTags ou use /bulkSetTags, que informa um resultado para cada tag.

Campos ocultos

Anchor link to

Um campo oculto é um campo que o Pushwoosh marca como oculto para uso próprio. Você não pode criar nem ocultar um campo com os métodos de esquema desta página. /getTags não retorna campos ocultos, então um valor que você lê e grava de volta nunca os contém. O que acontece com eles em uma gravação depende do tipo:

  • Object. Um campo oculto ausente no novo valor é mantido, em qualquer profundidade. Um objeto aninhado visível ausente no novo valor é excluído com tudo o que há dentro dele, incluindo os campos ocultos. Excluir o valor inteiro também exclui os campos ocultos.
  • ObjectList. Gravar a lista substitui todos os seus elementos, e os campos ocultos dos elementos antigos são perdidos. Um elemento não tem identificador, então um elemento novo não pode ser associado a um antigo. O mesmo se aplica a uma lista aninhada.

Gravar parte de um Object

Anchor link to

Grave um único campo, um objeto aninhado ou uma lista aninhada de uma tag Object pelo nome completo, em vez do valor inteiro da tag. increment e as outras operações de /setTags funcionam com campos:

"tags": {
"order.status": "shipped",
"order.amount": { "operation": "increment", "value": 5 }
}

O mesmo funciona para um campo de um objeto aninhado que tem apenas objetos acima dele, como "profile.address.city": "Paris".

Um objeto aninhado ou uma lista aninhada que tem apenas objetos acima dele pode ser gravado isoladamente pelo nome completo, como profile.address ou profile.visits. O valor substitui apenas ele, e o restante de profile permanece como estava. Os limites de 100 elementos e de 64 KB contam a partir desse valor:

"tags": {
"profile.address": { "city": "Paris" },
"profile.visits": [{ "code": "v2" }]
}

Nada dentro de uma lista de objetos pode ser gravado isoladamente, porque não fica claro qual elemento alterar. Isso inclui um campo de uma tag ObjectList, como orders.sku, e tudo dentro de um elemento, como orders.meta ou profile.visits.code. /setTags ignora esse valor. Em vez disso, envie a lista inteira.

Tags de objeto não são criadas automaticamente

Anchor link to

Um valor com um objeto ou um array de objetos para uma tag que não existe é ignorado. A criação automática de tags não cria tags de objeto, então crie o esquema primeiro com POST /api/tags.

Resultados de bulkSetTags

Anchor link to

Com detailed=true, o status de /bulkSetTags retorna um destes resultados para uma tag de objeto, além de ok, tag not found e wrong value. expect :<type>:

ResultadoCausa
object tags are stored on the user onlyA tag de objeto não é User-specific.
cannot load the fields of the objectA Pushwoosh não conseguiu ler os campos da tag de objeto.
wrong value. expect an object (a map) or, for a list of objects, an array of mapsO valor não se ajusta à tag de objeto, o valor de um campo em qualquer profundidade não corresponde ao seu tipo, ou o valor viola um limite.
a field of a list of objects cannot be set on its own, set the whole listO valor é definido em algo dentro de uma lista de objetos, como orders.sku ou orders.meta.

Ler valores

Anchor link to

/getTags retorna um valor Object como um objeto JSON e um valor ObjectList como um array de objetos:

Resposta
{
"status_code": 200,
"status_message": "OK",
"response": {
"result": {
"order": { "amount": 120, "status": "paid" },
"orders": [
{ "amount": 120, "status": "paid" },
{ "amount": 50 }
]
}
}
}

Objetos aninhados e listas aninhadas voltam em qualquer profundidade com a mesma forma em que você os grava, por exemplo "profile": {"address": {"city": "Berlin"}, "visits": [{"code": "v1"}]}.

Os valores dos campos são retornados da mesma forma que os valores de tags comuns em /getTags: um Date como timestamp Unix em segundos, um Price como string, por exemplo "120.00", e um Boolean como 1 ou 0.

Valores armazenados de um campo

Anchor link to

GET /api/tags:values na URL base lista os valores distintos que um campo contém, com o número de assinantes de cada valor. Passe o nome completo do campo em name, como profile.address.city ou orders.sku.

Parâmetros de consulta
Anchor link to
NomeTipoDescrição
application*stringCódigo do aplicativo, XXXXX-XXXXX.
name*stringNome completo do campo.
likestringRetornar apenas os valores que contêm este texto, na posição definida por like_op.
like_opstringSTARTS_WITH (padrão), ENDS_WITH ou CONTAINS.
order_bystringVALUE (padrão) ou COUNT.
order_directionstringASC (padrão) ou DESC.
limitintegerNúmero de valores a retornar. O padrão é 100.
offsetintegerNúmero de valores a pular.
pageintegerNúmero da página, a partir de 0. Usado com per_page em vez de limit e offset.
per_pageintegerNúmero de valores por página.
Exemplo
GET /api/tags:values?application=XXXXX-XXXXX&name=orders.sku&order_by=COUNT&order_direction=DESC
Resposta
{
"values": [
{ "value": "A-1", "count": 120 },
{ "value": "B-2", "count": 45 }
],
"total": 2,
"page": 0,
"per_page": 100
}

Campos Integer e Price não retornam valores, da mesma forma que as tags comuns desses tipos. Uma tag de objeto, um objeto aninhado ou uma lista aninhada não tem valores próprios, então o nome dela retorna HTTP 404 tag not found.

Segmentar por campos

Anchor link to

Defina as condições do segmento nos campos, não na própria tag de objeto. Na linguagem de segmentação, um campo é uma tag com um nome com pontos e aceita os operadores do seu próprio tipo:

AT("XXXXX-XXXXX", "order.amount", gte, 100)

Um campo de um objeto aninhado ou lista aninhada usa o nome completo, como profile.address.city, profile.visits.code ou orders.meta.color. Uma condição na própria tag de objeto, em um objeto aninhado ou em uma lista aninhada, como profile.address, falha com object tag has no value of its own, use one of its fields.

Um campo com duas listas de objetos acima dele, como orders.lines.qty, é apenas armazenado. O segmento com essa condição é salvo, mas calculá-lo ou enviar para ele falha com a field inside a list nested in a list is stored only and cannot be searched.

Condições em um ObjectList

Anchor link to

Uma condição em um campo de uma tag ObjectList corresponde a um usuário quando pelo menos um elemento da lista atende à condição. Condições em campos da mesma lista unidas com AND devem corresponder ao mesmo elemento:

AT("XXXXX-XXXXX", "orders.amount", gte, 100) * AT("XXXXX-XXXXX", "orders.status", eq, "paid")

Este segmento contém usuários com pelo menos um pedido que seja ao mesmo tempo de 100 ou mais e pago. Um usuário com um pedido grande não pago e um pedido pequeno pago não corresponde. O mesmo elemento é verificado para os campos de um objeto dentro dele: orders.sku igual a A-1 AND orders.meta.color igual a red correspondem a um usuário com um pedido que tenha ambos. Condições unidas com OR não precisam corresponder ao mesmo elemento. Condições em duas listas diferentes são verificadas em cada lista separadamente.

Alguns operadores funcionam de forma diferente em um campo de uma tag ObjectList:

  • notset. Nenhum elemento da lista tem um valor neste campo. Um usuário sem a lista também corresponde.
  • noteq. Pelo menos um elemento tem um valor neste campo, e esse valor é diferente do informado. Elementos sem o campo não contam. Um usuário com pedidos nos status paid e new corresponde a noteq "paid".
  • notin em um campo List. Nenhum elemento contém nenhum dos valores informados.
  • notin em um campo de outro tipo. Pelo menos um elemento tem um valor neste campo que não está entre os valores informados.

notset e notin em um campo List não estão vinculados ao mesmo elemento que as outras condições unidas com AND. Essas regras também se aplicam a listas aninhadas, como profile.visits.

Usar valores nas mensagens

Anchor link to

Insira campos de tags de objeto em notificações push, e-mails, SMS e mensagens de mensageiros como o WhatsApp com modelos Liquid. O Liquid funciona apenas se os modelos de conteúdo estiverem habilitados na sua conta. Escreva um campo pelo nome completo em qualquer profundidade:

Your city is {{ profile.address.city }}.

Pegue um elemento de uma lista de objetos pelo seu índice, a partir de 0:

Your first order is {{ orders[0].sku }}, quantity {{ orders[0].lines[0].qty }}.

Um índice além do fim da lista, ou uma lista que o usuário não tem, é renderizado como uma string vazia. Verifique o elemento primeiro ou defina um valor alternativo com default:

{% if orders[0] %}Your first order is {{ orders[0].sku }}.{% endif %}
Your first order is {{ orders[0].sku | default: "on its way" }}.

Percorra uma lista de objetos, incluindo uma lista dentro de um elemento:

{% for o in orders %}{{ o.meta.color }}{% for l in o.lines %}{{ l.qty }}{% endfor %}{% endfor %}

Campos apenas armazenados, como orders.lines.qty, funcionam nos modelos da mesma forma que os outros campos.

Exportar segmentos com tags de objeto

Anchor link to

/exportSegment exporta os campos das tags de objeto:

  • CSV. Cada campo com valor é uma coluna separada com o nome completo, como order.amount ou profile.address.city. As próprias tags de objeto, objetos aninhados e listas aninhadas não têm coluna. Um campo dentro de uma lista de objetos, em qualquer profundidade, contém os valores distintos de todos os elementos como um array JSON, da mesma forma que uma tag List: ["A-1","B-2"]. O array é ordenado e não mostra de qual elemento veio um valor, então também não mantém a ordem dos elementos. Para obter os elementos inteiros, exporte em json ou json_each_line.
  • json e json_each_line. As tags de objeto vêm aninhadas, com a mesma forma em que /getTags as retorna. Uma tag Object é uma entrada em tags com seus campos em object.fields, e um objeto aninhado dentro dela também traz seus próprios campos em object.fields, em todos os níveis. Uma tag ObjectList é uma entrada com seus elementos em object_list.items, assim como uma lista aninhada. Os campos têm nomes curtos, são ordenados por nome e trazem seu valor em uma chave com o nome do tipo: integer, string, list, date, boolean, price ou version:
{
"name": "profile",
"object": {
"fields": [
{ "name": "address", "object": { "fields": [{ "name": "city", "string": "Berlin" }] } },
{ "name": "visits", "object_list": { "items": [{ "fields": [{ "name": "code", "string": "v1" }] }] } }
]
}
}

Uma tag ObjectList tem esta forma. Os valores inteiros vêm como strings:

{
"name": "orders",
"object_list": {
"items": [
{ "fields": [{ "name": "amount", "integer": "120" }, { "name": "status", "string": "paid" }] },
{ "fields": [{ "name": "amount", "integer": "50" }] }
]
}
}

Um elemento com um objeto aninhado e uma lista aninhada tem esta forma:

{
"fields": [
{ "name": "meta", "object": { "fields": [{ "name": "color", "string": "red" }] } },
{ "name": "lines", "object_list": { "items": [{ "fields": [{ "name": "qty", "integer": "2" }] }] } }
]
}

Se tagsList nomear uma tag de objeto, todos os seus campos são exportados, incluindo os aninhados.