Chamada de um recurso usando uma chave de identificação composta calling-a-resource-using-a-composite-identification-key

Em alguns casos, pode ser necessário definir para um recurso uma chave de identificação composta de dois campos. Depois que a chave de identificação for configurada, será necessário configurar uma definição de filtro para poder chamar o recurso com essa chave de identificação, seja da interface Campaign Standard ou de APIs.

Neste caso de uso, o recurso Perfil foi estendido com campos "ID do CRM" e "categoria" personalizados. Criaremos uma chave de identificação para o recurso Perfil, que será composta 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 esse 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 de Perfil usando sua chave de identificação.
  3. Chame o recurso de Perfil da interface ou do APis.

Tópicos relacionados:

Etapa 1: configurar a chave de identificação step-1-configure-the-identification-key

NOTE
Os conceitos globais ao configurar chaves de identificação estão detalhados em esta 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 / 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 de CRM" e "Categoria" e clique em Confirm.

    note note
    NOTE
    Para 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 do filtro step-2-configure-the-filter-definition

NOTE
Os conceitos globais ao configurar definições de filtro estão detalhados em esta seção.
  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.

    note note
    NOTE
    Depois de clicar no botão +, o nome do parâmetro é gerado automaticamente. Observe essas informações, pois elas serão necessárias para 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 fique disponível.

Etapa 3: chamar o recurso com base em sua chave de identificação step-3-call-the-resource-based-on-its-identification-key

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

Para usar a definição de filtro da interface, use uma atividade Query em um fluxo de trabalho (consulte esta seção). Em seguida, 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>
NOTE
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.

Em nosso caso, a sintaxe para recuperar um perfil da categoria "spring" com a ID de 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.

recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff