Invocación de un recurso mediante una clave de identificación compuesta

En algunos casos, es posible que necesite definir para un recurso una clave de identificación compuesta por dos campos. Una vez configurada la clave de identificación, debe configurar una definición de filtro para poder llamar al recurso con esta clave de identificación, ya sea desde la interfaz de Campaign Standard o las API.

En este caso de uso, el recurso Profile se ha ampliado con los campos personalizados "CRM ID" y "category". Crearemos una clave de identificación para el recurso Perfil , que se compone de estos dos campos. A continuación, configuraremos una definición de filtro para que podamos acceder al recurso Perfil mediante la clave de identificación.

Los pasos principales para este caso de uso son:

  1. Configure la clave de identificación para el recurso Perfil , en función de los dos campos.
  2. Configure la definición del filtro para poder llamar al recurso Perfil mediante su clave de identificación.
  3. Llame al recurso Perfil desde la interfaz o desde el APis.

Temas relacionados:

Paso 1: Configuración de la clave de identificación

NOTA

Los conceptos globales al configurar claves de identificación se detallan en esta sección.

  1. Antes de configurar la clave de identificación, asegúrese de que el recurso se ha ampliado con los campos deseados y que se ha publicado. Para obtener más información, consulte esta sección.

  2. Vaya al menú Administration / Development / Custom resources y, a continuación, abra el recurso Profile .

  3. En la sección Identification keys , haga clic en el botón Create element .

  4. Agregue los dos campos personalizados "CRM ID" y "Category" y haga clic en Confirm.

    NOTA

    Si desea mostrar los dos campos personalizados en la interfaz del perfil, configure la pestaña Screen definition . Para obtener más información, consulte esta sección.

  5. Ahora puede configurar la definición del filtro para poder llamar al recurso mediante su clave de identificación.

Paso 2: Configuración de la definición del filtro

NOTA

Los conceptos globales al configurar definiciones de filtro se detallan en esta sección.

  1. En la pestaña Filter definition, haga clic en Add an element e introduzca la etiqueta y el ID de la definición del filtro.

  2. Edite las propiedades de la definición del filtro para configurar sus reglas.

  3. Arrastre y suelte en el espacio de trabajo la tabla que contiene los campos utilizados en la clave de identificación.

  4. Seleccione el primer campo utilizado en la clave de identificación ("CRM ID") y, a continuación, active la opción Switch to parameters.

  5. En la sección Filter conditions, mantenga el operador Equal, luego defina el nombre del parámetro y haga clic en el signo más para crearlo.

    NOTA

    Una vez que haya hecho clic en el botón +, el nombre del parámetro se genera automáticamente. Tenga en cuenta esta información, ya que necesitará que utilice el filtro de las API.

  6. Repita los pasos anteriores con todos los campos que componen la clave de identificación ("categoría") y, a continuación, guarde los cambios.

  7. La definición del filtro ya está configurada. Puede publicar el recurso para que el filtro esté disponible.

Paso 3: Llame al recurso en función de su clave de identificación

Una vez configurados la clave de identificación y su definición de filtro, puede utilizarla para llamar al recurso, ya sea desde la interfaz estándar de Campaign o las API de REST.

Para utilizar la definición de filtro de la interfaz, utilice una actividad Query en un flujo de trabajo (consulte esta sección). El filtro está disponible en el panel izquierdo.

Para utilizar la definición de filtro de las API de REST de Campaign Standard, utilice la siguiente sintaxis:

GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>
NOTA

Para llamar a un filtro personalizado, utilice el prefijo "by" seguido del nombre del filtro definido al configurar la definición del filtro en paso 2.

En nuestro caso, la sintaxis para recuperar un perfil de la categoría "primavera" con el ID de CRM "123456" sería:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456

Para obtener más información, consulte la documentación de las API de REST del Campaign Standard.

En esta página