Google accepte les campagnes. Consultez Campagnes sur le Réseau de Recherche Google et Campagnes Google Performance Max pour ce qui est propre à Google. Les autres réseaux refusent une requête de campagne avec
code: 101, et details en indique la raison. Sur Facebook, par exemple, le message est campaignCreation is not supported on facebook.Endpoints
{platform} est le réseau publicitaire. {id} est l’ID de campagne renvoyé lors de sa création. Vous ne pouvez consulter et modifier que les campagnes créées via Ayrshare par le même profil utilisateur.
Paramètres d’en-tête
string
requis
Obligatoire pour créer une campagne. Envoyez une nouvelle valeur unique, comme un UUID, pour chaque nouvelle campagne. Si vous répétez une requête avec la même clé, Ayrshare renvoie la première réponse, marquée
idempotentReplayed: true, et ne crée rien de nouveau. Vous pouvez aussi envoyer la clé dans le corps sous la forme idempotencyKey. Si vous envoyez les deux, elles doivent correspondre.Créer une campagne
POST /ads/{platform}/campaigns
Les nouvelles campagnes démarrent en paused sauf si vous envoyez status: "active", afin que rien ne soit dépensé tant que vous n’avez pas décidé de les lancer.
string
requis
Le compte publicitaire dans lequel créer la campagne.
string
requis
Le nom de la campagne, de 1 à 255 caractères.
string
requis
Le type de campagne :
search ou performanceMax. Chaque réseau ne prend en charge que certains types. Un type non pris en charge par le réseau renvoie code: 101 et liste les types pris en charge.object
requis
object
requis
boolean
requis
Indique si la campagne constitue de la publicité politique dans l’UE. Vous devez toujours l’envoyer. Ayrshare ne le renseigne jamais à votre place.
object
object
Chaque réseau ne prend en charge qu’une partie du ciblage. Un champ non pris en charge par le réseau renvoie
code: 101.string
défaut:"paused"
active ou paused.object
Options propres à un seul réseau, sous le nom de ce réseau, par exemple
{ "facebook": { ... } }. Les options destinées à tout autre réseau renvoient code: 101.status: "success", le campaignId et l’état propre de la campagne dans campaignStatus (active ou paused). La consultation et la modification répondent de la même manière.
Obtenir une campagne
GET /ads/{platform}/campaigns/{id}
Renvoie la campagne telle que le réseau la rapporte. Une campagne qui ne vous appartient pas, ou qui n’existe pas, renvoie code: 400.
Modifier une campagne
PUT /ads/{platform}/campaigns/{id}
Envoyez au moins l’un de ces champs. Vous ne pouvez pas modifier type, accountId ou euPoliticalAdvertising après la création de la campagne.
string
Le nouveau nom de la campagne.
string
active ou paused. Une requête qui envoie uniquement status: "paused" n’est pas bloquée lorsque Ayrshare a mis en pause les annonces sur ce réseau. Elle nécessite tout de même un réseau lié, et peut encore échouer si le réseau lui-même est indisponible.object
{ "amount": number } : le nouveau montant à dépenser par jour.object
{ "end": string } : la nouvelle date de fin, au même format que schedule.start. Elle doit être postérieure au début de la campagne. Un réseau qui planifie des journées entières, comme Google, accepte aussi le même jour que le début.Erreurs
Ces erreurs comportent uncode Ayrshare :
Une création peut aussi renvoyer l’un de ces statuts HTTP. Son corps ne contient pas de
code, seulement { "action": "createAdCampaign", "status": "error", "message": "..." } :