Skip to main content
Die Ads-Operationen erhalten die Ads-Plattform als Argument, sodass dieselbe Operation auf jeder von Ayrshare unterstützten Ads-Plattform funktioniert. Aktuell sind das FACEBOOK und INSTAGRAM. Jede Operation ruft den passenden REST-Ads-Endpunkt auf und gibt dessen Antwort unverändert zurück. Authentifizierung und Limits sind dieselben wie bei REST. Ein fehlgeschlagener Aufruf gibt einen GraphQL-Fehler zurück: extensions.status enthält den REST-Status und extensions.code den Ayrshare-Fehlercode, sofern der REST-Fehler einen hat. Siehe Fehler. Ads-Operationen erfordern das Ads-Add-on. Ohne dieses gibt jeder Aufruf einen Fehler mit extensions.status 403 und extensions.code 399 zurück.

Operationen

Jede Operation akzeptiert außerdem ein optionales profileKey, um auf ein User Profile (Benutzerprofil) zu wirken. Alle geben die REST-Antwort als JSON zurück und erlauben daher keine Feldauswahl.

Werbekonten auflisten

Beginnen Sie hier. Verwenden Sie die accountId-Werte aus der Antwort überall dort, wo eine Operation nach accountId fragt.

Targeting-Optionen suchen

kind legt die Suche fest: INTERESTS für das Zielgruppen-Targeting, REGIONS oder CITIES für Standorte. Jede Art akzeptiert nur ihre eigenen Argumente. So funktionieren countryCode und regionId beispielsweise nur mit CITIES, und INTERESTS erfordert search.

Anzeigen auflisten

Übergeben Sie mindestens eines der Argumente campaignId, accountId, adId, postId oder socialPostId. socialPostId ist die eigene Beitrags-ID des Netzwerks, für Beiträge, die nicht über Ayrshare veröffentlicht wurden.

Sehen, was eine Anzeige gekostet hat

Eine Anzeige pausieren oder fortsetzen

updateAd verändert echte Werbeausgaben. PAUSED stoppt die Ausgaben, ACTIVE setzt sie fort, und DELETED oder ARCHIVED beendet die Anzeige endgültig. Derselbe Status wird auch für die Anzeigengruppe und die Kampagne der Anzeige gesetzt, sodass sich alle anderen Anzeigen in dieser Anzeigengruppe oder Kampagne ebenfalls ändern.
Das Bewerben eines Beitrags über diese Operationen ist in Vorbereitung. Bis dahin verwenden Sie boostFacebookPost oder instagramBoostPost oder den REST-Boost-Endpunkt für Facebook bzw. Instagram.
Die plattformspezifischen Operationen wie facebookAdAccounts und instagramAds funktionieren weiterhin und sind unverändert.