Zum Hauptinhalt springen
Eine Kampagne ist eine Anzeige, die nicht von einem Ihrer Beiträge ausgeht. Verwenden Sie sie für Formate wie Suchanzeigen, bei denen Sie ein Budget, eine Gebotsstrategie und das Targeting festlegen und das Netzwerk die Anzeigen erstellt. Um einen bereits veröffentlichten Beitrag zu bewerben, verwenden Sie stattdessen Beitrag bewerben.
Google akzeptiert Kampagnen. Was speziell für Google gilt, steht unter Google-Suchkampagnen und Google Performance Max-Kampagnen. Andere Netzwerke lehnen eine Kampagnenanfrage mit code: 101 ab, und details nennt den Grund. Bei Facebook lautet die Meldung beispielsweise campaignCreation is not supported on facebook.

Endpunkte

{platform} ist das Werbenetzwerk. {id} ist die Kampagnen-ID, die beim Erstellen zurückgegeben wurde. Sie können nur Kampagnen lesen und ändern, die über Ayrshare vom selben Benutzerprofil erstellt wurden.

Header-Parameter

string
erforderlich
Erforderlich, um eine Kampagne zu erstellen. Senden Sie für jede neue Kampagne einen neuen eindeutigen Wert, etwa eine UUID. Wenn Sie eine Anfrage mit demselben Schlüssel wiederholen, gibt Ayrshare die erste Antwort zurück, gekennzeichnet mit idempotentReplayed: true, und erstellt nichts Neues. Sie können den Schlüssel stattdessen auch im Body als idempotencyKey senden. Wenn Sie beide senden, müssen sie übereinstimmen.

Eine Kampagne erstellen

POST /ads/{platform}/campaigns Neue Kampagnen starten mit paused, sofern Sie nicht status: "active" senden. So wird kein Geld ausgegeben, bis Sie den Start selbst veranlassen.
string
erforderlich
Das Werbekonto, in dem die Kampagne erstellt werden soll.
string
erforderlich
Der Kampagnenname, 1 bis 255 Zeichen.
string
erforderlich
Der Kampagnentyp: search oder performanceMax. Jedes Netzwerk unterstützt nur einige Typen. Ein Typ, den das Netzwerk nicht unterstützt, gibt code: 101 zurück und listet die unterstützten Typen auf.
object
erforderlich
object
erforderlich
boolean
erforderlich
Gibt an, ob es sich bei der Kampagne um politische Werbung in der EU handelt. Sie müssen diesen Wert immer senden. Ayrshare füllt ihn niemals für Sie aus.
object
object
Jedes Netzwerk unterstützt nur einen Teil des Targetings. Ein Feld, das das Netzwerk nicht unterstützt, gibt code: 101 zurück.
string
Standard:"paused"
active oder paused.
object
Optionen nur für ein Netzwerk, unter dem Namen dieses Netzwerks, zum Beispiel { "facebook": { ... } }. Optionen für jedes andere Netzwerk geben code: 101 zurück.
Eine erfolgreiche Erstellung gibt status: "success", die campaignId und den eigenen Status der Kampagne als campaignStatus (active oder paused) zurück. Abrufen und Aktualisieren antworten auf dieselbe Weise.

Eine Kampagne abrufen

GET /ads/{platform}/campaigns/{id} Gibt die Kampagne so zurück, wie das Netzwerk sie meldet. Eine Kampagne, die nicht Ihnen gehört oder nicht existiert, gibt code: 400 zurück.

Eine Kampagne aktualisieren

PUT /ads/{platform}/campaigns/{id} Senden Sie mindestens eines dieser Felder. type, accountId und euPoliticalAdvertising können Sie nach dem Erstellen der Kampagne nicht mehr ändern.
string
Der neue Kampagnenname.
string
active oder paused. Eine Anfrage, die nur status: "paused" sendet, wird nicht blockiert, wenn Ayrshare Anzeigen in diesem Netzwerk pausiert hat. Sie erfordert dennoch ein verknüpftes Netzwerk und kann weiterhin fehlschlagen, wenn das Netzwerk selbst nicht erreichbar ist.
object
{ "amount": number }: der neue Betrag, der pro Tag ausgegeben werden soll.
object
{ "end": string }: das neue Enddatum, im selben Format wie schedule.start. Es muss nach dem Start der Kampagne liegen. Ein Netzwerk, das ganze Tage plant, wie Google, akzeptiert auch denselben Tag wie den Start.

Fehler

Diese Fehler enthalten einen Ayrshare-code: Eine Erstellung kann auch mit einem dieser HTTP-Status antworten. Der Body enthält dann keinen code, sondern nur { "action": "createAdCampaign", "status": "error", "message": "..." }: