Llamadas a la API

Consulta ejemplos de llamadas a la API para usar el motor de reglas de anuncios.

Leer todas las reglas de una cuenta

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_library

Leer una regla

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Actualizar una regla

Para actualizar una especificación, proporciona todos los campos, incluidos los que no hayan cambiado. A continuación se incluye un ejemplo de actualización del activador de las reglas para que sea cada 1000 impresiones. Para actualizar el estado de una regla no se requieren cambios en la especificación.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "trigger" : {
        "type": "STATS_MILESTONE",
        "field": "impressions",
        "value": 1000,
        "operator": "EQUAL"
      },
      "filters": ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

A continuación se incluye un ejemplo de actualización de los filtros para seleccionar todos los anuncios que tienen más de 200 clics. Otros filtros, como entity_type y time_preset, deben seguir estando en esta actualización.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "filters" : [
       {
         "field": "clicks",
         "value": 200,
         "operator": "GREATER_THAN",
       },
       {
       ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Eliminar una regla

curl -X DELETE \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Acceder al historial de ejecución de una regla

Hay un extremo para acceder a datos históricos de las ejecuciones de cada regla. De forma predeterminada, este extremo proporciona datos pertinentes, como resultados y acciones. También puedes comprobar el estado de la regla en cada ejecución para hacer un seguimiento de los cambios.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

Además, este extremo admite tres mecanismos de filtración en los datos: object_id, action y hide_no_changes. Puedes filtrar los resultados por object_id o action si quieres ver resultados solo para ese valor de object_id o tipo de action.

También puedes filtrar los resultados con la marca hide_no_changes si quieres excluir todas las ejecuciones para las que no haya ningún cambio. Puedes combinar estos filtros para acotar aún más los resultados.

curl -G   \
-d 'object_id=123' \
-d 'action=CHANGED_BID' \
-d 'hide_no_changes=true' \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

Acceder al historial de ejecución de una cuenta

Hay un extremo para acceder a los datos históricos agregados de todas las reglas de tu cuenta. De forma predeterminada, este extremo proporciona los mismos datos pertinentes que el historial de ejecución de la regla, pero también incluye el identificador de la regla para cada entrada.

Las entradas de este extremo se ordenan de más recientes a más antiguas. Este extremo también admite los mismos mecanismos de filtración que se han señalado anteriormente: object_id, action y hide_no_changes.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_history

Obtener la vista previa de una regla

Hay un extremo para obtener la vista previa de la evaluación de una regla basada en programaciones. Cuando se envía una solicitud POST, este extremo devuelve una lista de objetos que satisfacen todos los filtros especificados de la regla en ese momento.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/preview

Ejecutar una regla manualmente

Hay un extremo para ejecutar manualmente una regla basada en programaciones. Cuando se envía una solicitud POST a este extremo, la regla se programará inmediatamente para ejecutarse.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/execute

Los resultados se pueden obtener del historial de ejecución cuando la ejecución de la regla se ha completado.

Leer las reglas de regulación de un objeto

Hay extremos para leer todas las reglas que regulan cada anuncio, conjunto de anuncios y campaña publicitaria. De forma predeterminada, una regla regula un objeto si hace referencia a él de forma estática mediante el filtro id o si hace referencia a él de forma dinámica mediante el filtro entity_type.

Este extremo también admite un parámetro pass_evaluation opcional. Con dicho parámetro, puedes limitar aún más la lista de reglas, en función de si el objeto cumpliría con los filtros de la regla en ese momento. Si pass_evaluation es true, devolvemos todas las reglas que, cuando se obtiene una vista previa de ellas, devuelven el objeto. Si es false, devolvemos todas las reglas que no lo devuelven.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_OBJECT_ID>/adrules_governed