Filtrando 10 resultados de DLC

Obtenha todos os 10 DLCs Pontos de extremidade da API permitem que você refine seus resultados usando filtros.

Por exemplo, em vez de obter a lista de todas as marcas, talvez você tenha interesse nas marcas que fazem parte do IMÓVEIS vertical. Nesse caso, você pode aplicar um filtro para retornar IMÓVEIS apenas marcas relacionadas.

Estrutura da solicitação

Os filtros são passados para o endpoint como parâmetros de consulta. Na sua consulta, você usará a palavra-chave filter como a chave, seguida pela consulta na forma de um objeto JSON.

Aqui está um exemplo:

https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns?filter=[[{"field":"vertical","type":"==","value":"REAL_ESTATE"}]]

Objeto de filtro

Um objeto de filtro é um objeto JSON que contém uma consulta de filtro. Um objeto de filtro contém três pares chave/valor:

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      }
   ]
]

Campo: é o nome do campo cujo valor você deseja usar para filtrar.

Tipo: é a condição de correspondência que você deseja aplicar na pesquisa com filtro. Acesse o condições de filtragem seção para ver as condições disponíveis.

Valor: é o valor pelo qual você deseja filtrar.

Condições de filtragem

  • regexp: Expressão regular - Retorna registros que correspondem ao valor do filtro com base na expressão regular fornecida.
  • ==: Igual a - Retorna registros que correspondem exatamente ao valor do filtro.
  • = : Dobradura igual - Corresponde a registros sem distinção entre maiúsculas e minúsculas (isso se aplica a caracteres UTF-8).
  • ^=: Começa com - Identifica registros que começam com o valor do filtro.
  • =$: Termina com - Identifica registros que terminam com o valor do filtro.
  • ~=: Contém - Identifica registros que contêm o valor do filtro.
  • <: Menos que - corresponde a registros com valor inferior ao do filtro.
  • <=: Menor ou igual a - seleciona registros cujos valores sejam menores ou iguais ao valor do filtro.
  • >: Maior do que - corresponde a registros com valores maiores do que o valor do filtro especificado.
  • >=: Maior ou igual a - seleciona registros maiores ou iguais ao valor do filtro.

É possível recuperar registros opostos negando qualquer uma das condições acima, colocando o prefixo ! símbolo. Por exemplo, !== é equivalente a Não é igual.

Regras de filtragem

Você pode ter no máximo três filtrar objetos em uma consulta. Isso significa que você pode encontrar resultados que correspondam a, no máximo, três campos. Os objetos de filtro também podem ser combinados de diferentes maneiras.

Por exemplo, você pode obter resultados que correspondam a um objeto de filtro OU outro. Além disso, resultados que correspondam a um objeto de filtro E outro.

Vamos considerar o caso em que queremos recuperar marcas nas quais o vertical é ou IMÓVEIS OU ONG E onde o ID do revendedor (reseller_id) é 12345.

Podemos expressar isso como uma proposição lógica: ( (vertical == REAL_ESTATE OR vertical == NGO) AND (reseller_id == 12345) )

Filtrar consultas que envolvam OU as expressões são representadas por meio do colchete []. Por exemplo, a seguinte expressão(vertical == REAL_ESTATE OR vertical == NGO) torna-se [ [{filter object 1}, {filter object 2}] ].

O colchete interno indica que você deseja obter resultados que correspondam a qualquer um dos seguintes objeto de filtro 1 OU objeto de filtro 2.

O colchete externo marca o início de uma consulta de filtro e é obrigatório em todas as consultas desse tipo.

Exemplos de regras de filtro

  1. Partida objeto de filtro 1; [ [{filter object 1}] ].
  2. Partida objeto de filtro 1 E objeto de filtro 2; [ [{filter object 1}], [{filter object 2}] ]
  3. Partida objeto de filtro 1 OU objeto de filtro 2; [ [{filter object 1},{filter object 2}] ]
  4. Partida (objeto de filtro 1 OU objeto de filtro 2) E objeto de filtro 3 ; [ [{filter object 1},{filter object 2}], [{filter object 3}] ].

Observação: Os objetos de filtro devem estar sempre entre colchetes, mesmo que se trate de um único objeto. Um bom exemplo é o objeto de filtro 3 no exemplo 4 acima.

Além disso, ao expandir ainda mais os objetos de filtro do exemplo 4, obtemos a seguinte consulta de filtro:

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      },
      {
         "field":"vertical",
         "type":"==",
         "value":"NGO"
      }
   ],
   [{
      "field":"reseller_id",
      "type":"==",
      "value":"12345"
   }]
]