Para encontrar informações sobre um cliente específico, use o parâmetro filter da API Cloud Channel por meio do método customers.list.
Se você usar um filtro, haverá um pequeno atraso (geralmente, alguns segundos) durante a criação de um cliente. Se você precisar acessar um cliente imediatamente após
a criação, recomendamos usar customers.list sem filtro ou
customers.get.
Filtros disponíveis
As strings do parâmetro de filtro são compatíveis com correspondência exata ou correspondência exata mais a filtragem de prefixo. Os filtros não diferenciam maiúsculas de minúsculas.
A tabela a seguir descreve os campos disponíveis para pesquisa e os métodos compatíveis.
| Chave de pesquisa externa | Suporte a correspondência exata | Compatível com o prefixo |
|---|---|---|
| domínio | Sim | Sim |
| org_display_name | Sim | Sim |
| cloud_identity_id | Sim | Não |
| channel_partner_id | Sim | Não |
Encontre a sintaxe completa de filtro no guia de filtragem da API.
Sintaxe de correspondência exata
Os filtros de correspondência exata só vão encontrar clientes que tenham os mesmos campos da string enviada.
Sintaxe:
<domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>
Exemplo: domain = "domain.com" AND channel_partner_id = "12345"
Sintaxe de prefixos
Os filtros de prefixo permitem o uso de um asterisco como símbolo de curinga. Ele encontrará clientes que tenham campos com o prefixo, independentemente do conteúdo que vem depois dele.
Sintaxe: <domain | org_display_name> : <value>*
Exemplo: domain : "uw.com*" AND org_display_name : "prefix*"
Exemplos de filtros com operadores lógicos
Os filtros da API Cloud Channel são compatíveis com o uso dos operadores lógicos AND e OR. Você pode usar os dois operadores em um filtro usando uma instrução entre parênteses.
Exemplo de AND
domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name :
"display*"
Exemplo de OR
domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name :
"display*"
Exemplo de AND + OR
domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name :
"display*" )
Use parênteses se o filtro tiver uma instrução AND e outra OR. O exemplo a seguir não é uma string de filtro válida.
domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name :
"display*