Show Menu
TÓPICOS×

Chamada de um recurso usando uma chave de identificação composta

Em alguns casos, pode ser necessário definir para um recurso uma chave de identificação composta por dois campos. Depois que a chave de identificação é configurada, é necessário configurar uma definição de filtro para poder chamar o recurso com essa chave de identificação, seja na interface do Campaign Standard ou em APIs.
Nesse caso de uso, o recurso Perfil foi estendido com os campos personalizados "ID do CRM" e "categoria" . Criaremos uma chave de identificação para o recurso Perfil, que será composto desses dois campos. Em seguida, configuraremos uma definição de filtro para que possamos acessar o recurso Perfil usando a chave de identificação.
As principais etapas para este caso de uso são:
  1. Configure a chave de identificação para o recurso Perfil, com base nos dois campos.
  2. Configure a definição do filtro para poder chamar o recurso Perfil usando sua chave de identificação.
  3. Chame o recurso Perfil da interface ou do APis.
Tópicos relacionados:

Etapa 1: Configurar a chave de identificação

Os conceitos globais ao configurar as chaves de identificação são detalhados nesta seção .
  1. Antes de configurar a chave de identificação, verifique se o recurso foi estendido com os campos desejados e se foi publicado. Para obter mais informações, consulte esta seção .
  2. Vá para o menu Administration / Developement / Custom resources e abra o Profile recurso.
  3. Na Identification keys seção, clique no Create element botão.
  4. Adicione os dois campos personalizados "ID do CRM" e "Categoria" e clique em Confirm .
    Se quiser exibir os dois campos personalizados na interface do perfil, configure a Screen definition guia. Para obter mais informações, consulte esta seção .
  5. Agora você pode configurar a definição do filtro para poder chamar o recurso usando sua chave de identificação.

Etapa 2: Configurar a definição do filtro

Os conceitos globais ao configurar definições de filtro são detalhados na presente seção .
  1. Na Filter definition guia, clique em Add an element e insira o rótulo e a ID da definição do filtro.
  2. Edite as propriedades da definição de filtro para configurar suas regras.
  3. Arraste e solte no espaço de trabalho a tabela que contém os campos usados na chave de identificação.
  4. Selecione o primeiro campo usado na chave de identificação ("ID do CRM") e ative a Switch to parameters opção.
  5. Na Filter conditions seção, mantenha o Equal operador, defina o nome do parâmetro e clique no sinal de mais para criá-lo.
    Depois de clicar no botão mais, o nome do parâmetro é gerado automaticamente. Observe essas informações, pois será necessário usar o filtro das APIs.
  6. Repita as etapas acima com todos os campos que compõem a chave de identificação ("categoria") e salve as alterações.
  7. A definição do filtro agora está configurada. Você pode publicar o recurso para que o filtro esteja disponível.

Etapa 3: Chame o recurso com base em sua chave de identificação

Depois que a chave de identificação e sua definição de filtro estiverem configuradas, você poderá usá-las para chamar o recurso, seja da interface padrão do Campaign ou REST APIs.
Para usar a definição de filtro da interface, use uma Query atividade em um fluxo de trabalho (consulte esta seção ). O filtro fica disponível no painel esquerdo.
Para usar a definição de filtro das APIs REST do Campaign Standard, use a sintaxe abaixo:
GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>

Para chamar um filtro de cliente, use o prefixo "por" seguido do nome do filtro definido ao configurar a definição do filtro na etapa 2 .
Em nosso caso, a sintaxe para recuperar um perfil da categoria "spring" com a ID do CRM "123456" seria:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456

Para obter mais detalhes, consulte a documentação das APIs REST do Campaign Standard.