Google acepta campañas. Consulta Campañas de búsqueda de Google y Campañas Performance Max de Google para ver lo específico de Google. Las demás redes rechazan una solicitud de campaña con
code: 101, y details indica el motivo. En Facebook, por ejemplo, dice campaignCreation is not supported on facebook.Endpoints
{platform} es la red de anuncios. {id} es el ID de la campaña que se devolvió al crearla. Solo puedes consultar y modificar las campañas creadas a través de Ayrshare por el mismo perfil de usuario.
Parámetros del encabezado
string
requerido
Obligatorio para crear una campaña. Envía un valor único nuevo, como un UUID, para cada campaña nueva. Si repites una solicitud con la misma clave, Ayrshare devuelve la primera respuesta, marcada con
idempotentReplayed: true, y no crea nada nuevo. También puedes enviar la clave en el cuerpo como idempotencyKey. Si envías ambas, deben coincidir.Crear una campaña
POST /ads/{platform}/campaigns
Las campañas nuevas comienzan en paused a menos que envíes status: "active", por lo que no se gasta nada hasta que decidas iniciarlas.
string
requerido
La cuenta publicitaria en la que se creará la campaña.
string
requerido
El nombre de la campaña, de 1 a 255 caracteres.
string
requerido
El tipo de campaña:
search o performanceMax. Cada red admite solo algunos tipos. Un tipo que la red no admite responde code: 101 y enumera los tipos admitidos.object
requerido
object
requerido
boolean
requerido
Indica si la campaña es publicidad política en la UE. Siempre debes enviarlo. Ayrshare nunca lo completa por ti.
object
object
Cada red admite solo cierta segmentación. Un campo que la red no admite responde
code: 101.string
predeterminado:"paused"
active o paused.object
Opciones para una sola red, bajo el nombre de esa red, por ejemplo
{ "facebook": { ... } }. Las opciones para cualquier otra red responden code: 101.status: "success", el campaignId y el estado propio de la campaña como campaignStatus (active o paused). Las operaciones de obtener y actualizar responden de la misma forma.
Obtener una campaña
GET /ads/{platform}/campaigns/{id}
Devuelve la campaña tal como la informa la red. Una campaña que no es tuya, o que no existe, responde code: 400.
Actualizar una campaña
PUT /ads/{platform}/campaigns/{id}
Envía al menos uno de estos campos. No puedes cambiar type, accountId ni euPoliticalAdvertising después de crear la campaña.
string
El nuevo nombre de la campaña.
string
active o paused. Una solicitud que solo envía status: "paused" no se bloquea cuando Ayrshare ha pausado los anuncios en esa red. Aun así necesita una red vinculada y puede fallar si la propia red no está disponible.object
{ "amount": number }: el nuevo monto a gastar por día.object
{ "end": string }: la nueva fecha de finalización, en el mismo formato que schedule.start. Debe ser posterior al inicio de la campaña. Una red que programa días completos, como Google, también acepta el mismo día del inicio.Errores
Estos errores incluyen uncode de Ayrshare:
Una creación también puede responder con uno de estos estados HTTP. Su cuerpo no tiene
code, solo { "action": "createAdCampaign", "status": "error", "message": "..." }: