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 aquellos que no han cambiado. En el ejemplo siguiente, se actualiza el activador de reglas para que se aplique cada 1000 impresiones. No se requieren cambios específicos para actualizar el estado de una regla.

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 ofrece un ejemplo en el que se actualizan los filtros para seleccionar todos los anuncios que tengan más de 200 clics. Otros filtros, como entity_type y time_preset, deben hallarse 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

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

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

Además, este punto de conexión admite tres mecanismos de filtrado de los datos: object_id, action y hide_no_changes. Puedes filtrar los resultados con un object_id o un action para ver solo los de ese tipo object_id o action.

También puedes filtrar los resultados usando la marca hide_no_changes a fin de excluir todas las ejecuciones para las que no haya cambios. Puedes combinar estos filtros para acotar 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

Existe un punto de conexión para acceder a los datos agregados del historial de todas las reglas de tu cuenta. De forma predeterminada, este punto de conexión proporciona los mismos datos relevantes que el historial de ejecución de la regla, pero también incluye el identificador de las reglas de cada entrada.

Las entradas en este punto de conexión se ordenan desde la más nueva hasta la más antigua. Este punto de conexión también admite los mismos mecanismos de filtrado anteriores: object_id, action y hide_no_changes.

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

Vista previa de una regla

Existe un punto de conexión para obtener una vista previa de la evaluación de una regla basada en programación. Cuando se envía una solicitud POST, este punto de conexión 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 manualmente una regla

Existe un punto de conexión para ejecutar manualmente una regla basada en programación. Cuando se envía una solicitud POST a este punto de conexión, la ejecución de la regla se programa de manera inmediata.

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 se complete la ejecución de la regla.

Leer las reglas que rigen un objeto

Hay puntos de conexión para leer todas las reglas que rigen cada anuncio, conjunto de anuncios y campaña publicitaria. De forma predeterminada, una regla rige un objeto si hace referencia a este de manera estática mediante el filtro id o de manera dinámica mediante el filtro entity_type.

Este punto de conexión también admite un pass_evaluation opcional. Con él, puedes limitar aún más la lista de reglas, dependiendo de si el objeto supera o no los filtros de la regla en ese momento. Si pass_evaluation es true, devolvemos todas las reglas que, durante la vista previa, hubieran devuelto el objeto. Si es false, devolvemos todas las reglas que no lo hubieran hecho.

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