Invocación de un recurso mediante una clave de identificación compuesta calling-a-resource-using-a-composite-identification-key
En algunos casos, es posible que tenga que definir para un recurso una clave de identificación que esté formada 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 del Campaign Standard o desde las API.
En este caso de uso, el recurso Perfil se ha ampliado con los campos personalizados "CRM ID" y "category". Crearemos una clave de identificación para el recurso de perfil, que se compone de estos dos campos. A continuación, configuraremos una definición de filtro para que podamos acceder al recurso de perfil mediante la clave de identificación.
Los pasos principales para este caso de uso son:
- Configure la clave de identificación para el recurso de perfil en función de los dos campos.
- Configure la definición del filtro para poder llamar al recurso de perfil con su clave de identificación.
- Llame al recurso de perfil desde la interfaz o desde las API de.
Temas relacionados:
Paso 1: Configuración de la clave de identificación step-1-configure-the-identification-key
-
Antes de configurar la clave de identificación, asegúrese de que el recurso se ha ampliado con los campos deseados y de que se ha publicado. Para obtener más información, consulte esta sección.
-
Vaya al menú Administration / Development / Custom resources y, a continuación, abra el recurso Profile.
-
En la sección Identification keys, haga clic en el botón Create element.
-
Agregue los dos campos personalizados "CRM ID" y "Category" y haga clic en Confirm.
note note NOTE 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. -
Ahora puede configurar la definición del filtro para poder llamar al recurso mediante su clave de identificación.
Paso 2: Configurar la definición del filtro step-2-configure-the-filter-definition
-
En la ficha Filter definition, haga clic en Add an element y, a continuación, escriba la etiqueta y el identificador de la definición del filtro.
-
Edite las propiedades de la definición del filtro para configurar sus reglas.
-
Arrastre y suelte en el espacio de trabajo la tabla que contiene los campos utilizados en la clave de identificación.
-
Seleccione el primer campo utilizado en la clave de identificación ("ID de CRM") y, a continuación, active la opción Switch to parameters.
-
En la sección Filter conditions, mantenga el operador Equal, defina el nombre del parámetro y haga clic en el signo más para crearlo.
note note NOTE Una vez que haya hecho clic en el botón +, el nombre del parámetro se generará automáticamente. Tenga en cuenta esta información, ya que la necesitará para utilizar el filtro de las API. -
Repita los pasos anteriores con todos los campos que componen la clave de identificación ("categoría") y, a continuación, guarde los cambios.
-
La definición del filtro ya está configurada. Puede publicar el recurso para que el filtro esté disponible.
Paso 3: Invocar al recurso en función de su clave de identificación step-3-call-the-resource-based-on-its-identification-key
Una vez configuradas la clave de identificación y su definición de filtro, puede utilizarlas para llamar al recurso, ya sea desde la interfaz de Campaign estándar o desde las API de REST.
Para usar la definición de filtro de la interfaz, use una actividad Query en un flujo de trabajo (vea esta sección). A continuació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>
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 Documentación de las API de REST de Campaign Standard.