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 que seja composta de dois campos. Depois que a chave de identificação estiver configurada, é necessário configurar uma definição de filtro para poder chamar o recurso com essa chave de identificação, da interface do Campaign Standard ou das APIs.

Nesse caso de uso, o recurso Profile foi estendido com os campos "CRM ID" e "category" personalizados. 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 de Perfil usando a chave de identificação.

As principais etapas para este caso de uso são:

  1. Configure a chave de identificação do recurso Perfil, com base nos dois campos.
  2. Configure a definição de filtro, para poder chamar o recurso Perfil usando sua chave de identificação.
  3. Chame o recurso Perfil da interface ou da APIs.

Tópicos relacionados:

Etapa 1: Configurar a chave de identificação

OBSERVAÇÃO

Os conceitos globais ao configurar chaves de identificação são detalhados em this section.

  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 / Development / Custom resources e abra o recurso Profile.

  3. Na seção Identification keys, clique no botão Create element.

  4. Adicione os dois campos personalizados "ID do CRM" e "Categoria" e, em seguida, clique em Confirm.

    OBSERVAÇÃO

    Se quiser exibir os dois campos personalizados na interface do perfil, configure a guia Screen definition. Para obter mais informações, consulte esta seção.

  5. Agora você pode configurar a definição de filtro para poder chamar o recurso usando sua chave de identificação.

Etapa 2: Configurar a definição de filtro

OBSERVAÇÃO

Os conceitos globais ao configurar definições de filtro são detalhados em this section.

  1. Na guia Filter definition, clique em Add an element e insira o rótulo e a ID da definição de 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 opção Switch to parameters.

  5. Na seção Filter conditions, mantenha o operador Equal, defina o nome do parâmetro e clique no sinal de mais para criá-lo.

    OBSERVAÇÃO

    Depois de clicar no botão +, 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 está configurada. Você pode publicar o recurso para que o filtro esteja disponível.

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

Depois que a chave de identificação e sua definição de filtro forem configuradas, você poderá usá-las para chamar o recurso, na interface padrão do Campaign ou em APIs REST.

Para usar a definição de filtro da interface, use uma atividade Query em um workflow (consulte esta seção). O filtro estará 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>
OBSERVAÇÃO

Para chamar um filtro personalizado, use o prefixo "by" seguido do nome do filtro definido ao configurar a definição do filtro na etapa 2.

No 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 REST APIs do Campaign Standard.

Nesta página