Kampagnen-API

Listet die Kampagnen des Projekts in Rangfolge auf (höchstens 100), in der Reihenfolge, in der die Auflösung sie liest. reserved ist bei jeder Kampagne vorhanden.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) sieht jede Kampagne, mit editable true nur dann, wenn die gesamte Zielgruppe innerhalb seines Bereichs liegt (ein Tag-Blatt und die Wurzelregel für jeden Bildschirm sind es nie; eine all-Regel braucht ein enthaltenes Kind, eine any-Regel jedes Kind) und der Aufrufer ändern darf, was abgespielt wird.

Erstellt eine Kampagne: Jeder Bildschirm in ihrer Zielgruppe wechselt zu playlist_id, solange from, until und windows in der Zeitzone des Bildschirms gelten (screenrig.schedule/v1; alle drei weglassen für immer), und wechselt zurück, wenn sie nicht mehr gelten.

Ein Bildschirm ermittelt seine Playlist als seine Übernahme, dann die erste Kampagne, die in der Rangfolge zutrifft (priority, höhere zuerst, dann die zuletzt erstellte), dann seinen Playlist-Zeitplan, dann seine Standard-Playlist. Eine Kampagne gilt nur für einen Bildschirm mit Standard-Playlist; eine mit from, until oder windows braucht die Zeitzone des Bildschirms.

Die Playlist muss existieren und genehmigt sein (playlist_not_approved). Bildschirme wechseln innerhalb einer Minute; GET /api/campaigns/{id}/screens zeigt den Stand jedes Bildschirms. Eine Organisation hat höchstens 100 Kampagnen über alle ihre Projekte (campaign_limit_reached).

Hängt campaign.created an. reserved true reserviert die Kampagne, und nur eine Person, die genehmigen kann, setzt es (reserved_item für einen Agenten, einen Service-Client oder jeden anderen), wobei campaign.reserved_changed angehängt wird.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) erstellt eine Kampagne nur für eine Zielgruppe innerhalb seines Bereichs (Blätter vom Typ folder und screen_id; kein Tag, nicht alle Bildschirme), sonst outside_screen_scope, und nur als Person, die genehmigen kann (approver_required).

Eine Kampagne, deren Zielgruppe einen geschützten Bildschirm erreicht, ist auf jeder Zugriffsstufe eine protected_change-Überprüfung, die eine zweite genehmigende Person entscheidet (202 pending_review). reserved true fällt unter die geschützten Ordner und paused true bei einer neuen Kampagne (einem Entwurf) unter die Änderungskontrolle für Zeitpläne, beide Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Was ein Schreibvorgang an einer Kampagne ändern würde, ohne ihn auszuführen. Mit id ist body der PATCH-Body dieser Kampagne; ohne id ist er der POST-Body einer neuen. Der Body wird so geprüft, wie der Schreibvorgang ihn prüft (eine Zielgruppenregel, ein Zeitfenster, eine nicht genehmigte Playlist, ein Bildschirmordner, den das Projekt nicht hat).

Die Antwort listet die Bildschirme auf, die die Kampagne auf ihrem Stack gewinnen würden, und die, die sie verlieren würden (count und die ersten 500 Bildschirm-IDs), sowie den Zeitplankalender der Bildschirme der alten und der neuen Zielgruppe, wie er ist (before) und wie er wäre (after), von from bis to (Standard: eine Woche ab jetzt; höchstens 93 Tage), gruppiert, wie GET /api/schedule/calendar gruppiert.

Eine pausierte Kampagne liegt auf keinem Stack, daher kommt beim Veröffentlichen einer solchen ihre Zielgruppe hinzu; eine Änderung, bei der die Kampagne auf dem Stack eines Bildschirms bleibt, lässt nichts hinzukommen oder wegfallen und erscheint in den Kalendern. Lesezugriff: Es wird nichts geschrieben.

Eine Kampagne. reserved ist immer vorhanden; editable ist bei einem auf Bildschirme beschränkten Aufrufer vorhanden (siehe listCampaigns).

Ändert die Mitglieder, die der Body setzt; null löscht from, until oder windows. paused true stoppt die Kampagne auf jedem Bildschirm, und false setzt sie fort. Eine pausierte Kampagne ist ein Entwurf: Sie liegt auf dem Stack keines Bildschirms, und ein Schreibvorgang, der sie pausiert lässt, löst keinen Bildschirm neu auf.

Das Veröffentlichen für einen Test ist dieser PATCH mit paused false und einer Zielgruppe, die ein Testordner oder einige Bildschirme ist; POST /api/campaigns/{id}/promote kopiert diese Zielgruppe dann auf die echte. Jeder Bildschirm der alten und der neuen Zielgruppe wird innerhalb einer Minute neu aufgelöst. Fügt campaign.updated hinzu. If-Match schützt die Revision.

Jeder Schreibvorgang wird im Verlauf der Kampagne gespeichert (GET /api/campaigns/{id}/revisions). campaign.updated. If-Match schützt die Revision. reserved setzt oder löscht das Flag reserved (eine reservierte Kampagne ändert, pausiert oder hebt nur eine Person auf, die genehmigen kann: sonst reserved_item); ein Wechsel fügt campaign.reserved_changed hinzu.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) ändert eine Kampagne nur, wenn ihre gespeicherte und die neue Zielgruppe innerhalb seines Bereichs liegen (outside_screen_scope; sonst ist sie für ihn schreibgeschützt).

Eine Kampagne, die einen geschützten Bildschirm erreicht, ist eine protected_change-Überprüfung, die eine zweite genehmigende Person entscheidet (202 pending_review). reserved true bei einer Kampagne, die nicht reserviert ist, fällt unter die geschützten Ordner, die der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Das Pausieren oder Fortsetzen einer Kampagne sowie das Bearbeiten einer reservierten Kampagne und das Aufheben ihrer Reservierung sind in jedem Plan offen.

Löscht die Kampagne und ihren Revisionsverlauf. Jeder Bildschirm, der sie zeigt, kehrt innerhalb einer Minute zu dem zurück, was er ohne sie zeigen würde. Fügt campaign.deleted hinzu. If-Match schützt die Revision. Eine reservierte Kampagne löscht nur eine Person, die genehmigen kann (reserved_item).

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) löscht eine Kampagne nur, wenn ihre Zielgruppe innerhalb seines Bereichs liegt (outside_screen_scope). Eine Kampagne, die einen geschützten Bildschirm erreicht, ist eine protected_change-Überprüfung, die eine zweite genehmigende Person entscheidet (202 pending_review).

Die Revisionen der Kampagne, neueste zuerst: die Kampagne, wie sie nach jedem Schreibvorgang einer Person, eines Agenten oder eines Zeitplan-Imports gespeichert wurde (eine Erstellung, ein Update, ein Hochstufen, eine Wiederherstellung), mit der Art der Änderung und wer sie vorgenommen hat.

Der Verlauf beginnt mit der Revision, die eine Kampagne hielt, als der Revisionsverlauf erstmals aufgezeichnet wurde: bis zu ihrem nächsten Schreibvorgang enthält die Liste allein diese Revision, mit change baseline. Eine Kampagne, deren Verlauf keine Revision mit paused false enthält, ist ein Entwurf. Revisionen bleiben so lange erhalten wie die Kampagne und gehen mit ihr.

Höchstens 50 pro Seite; next_cursor, solange weitere folgen, null auf der letzten Seite.

Macht eine frühere Revision wieder aktuell, indem sie über denselben Schreibvorgang wie PATCH nach vorn kopiert wird: ihr Name, ihre Playlist, Zielgruppe, Regel, Platzierung, Priorität und paused werden zu einer neuen Revision (change restored, restored_from die kopierte Revision), geprüft wie ein Update (ihre Playlist muss noch existieren und genehmigt sein), und jeder Bildschirm der alten und der neuen Zielgruppe wird neu aufgelöst, außer die Kampagne war pausiert und bleibt pausiert.

Frühere Revisionen bleiben, wie sie waren. If-Match ist erforderlich und nennt die aktuelle Revision (invalid_request, wenn es fehlt, revision_conflict, wenn sie veraltet ist). Eine Revision, deren Inhalt dem aktuellen Inhalt entspricht, ändert nichts und antwortet mit der aktuellen Kampagne. Derselbe Zugriff wie PATCH.

Veröffentlicht einen Test. Ein Test-Publish ist ein PATCH eines Entwurfs mit paused false und einer Zielgruppe, die ein Testordner oder einige Bildschirme ist; das Hochstufen kopiert dann die Zielgruppe von revision (der eigenen, pausierten Revision des Entwurfs) in einem Schreibvorgang auf die Kampagne (change promoted, restored_from die kopierte Revision), und jeder Bildschirm der alten und der neuen Zielgruppe wird neu aufgelöst.

Abgelehnt (invalid_request, mit Nennung von revision), wenn diese Revision nicht pausiert war, da sie kein Entwurf ist, und wenn die Kampagne jetzt pausiert ist, da es keinen Test zum Hochstufen gibt. If-Match ist erforderlich und nennt die aktuelle Revision. Eine Revision, deren Zielgruppe die aktuelle ist, ändert nichts. Derselbe Zugriff wie PATCH.

Promote fällt unter die Änderungskontrolle für Zeitpläne, die der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Revisionsverlauf, Wiederherstellung und Vorschauen sind in jedem Plan offen.

Die Reichweite der Kampagne. counts deckt jeden aktiven Bildschirm in ihrer Zielgruppe ab (audience, dann eine Zählung je Status); items ist eine Seite dieser Bildschirme in Reihenfolge der Bildschirm-ID mit dem Stand der Kampagne auf jedem (siehe CampaignStatus).

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) sieht und zählt nur die Zielgruppen-Bildschirme innerhalb seines Bereichs; Zählungen und Seitenumbruch betreffen diese Menge.