Dokumentation

Werbung: CLI-Befehle

Werbung in einem Netzwerk kaufen, das Sie eingeladen hat, oder Werbepausen auf eigenen Bildschirmen verkaufen: Inventar, Slots, Kampagnen, Berichte.

Jeder Befehl läuft wie in der CLI-Referenz beschrieben: globale Flags, JSON-Ausgabe, Beendigungscodes, Revisionen und Wiederholungen.

Werbung

Kaufen Sie Werbung in einem Netzwerk, das Sie eingeladen hat, oder verkaufen Sie Werbepausen auf Bildschirmen, die Sie besitzen. Lesen Sie zuerst screenrig project capabilities: Kaufen erfordert die Funktion advertiser, Verkaufen erfordert eigene Bildschirme. Geld wird als dezimale mcr-Strings angegeben, wobei 10.000.000 mcr US$1 sind. Führen Sie für jede Markierung screenrig ads COMMAND --help --json aus. Der Kauf- und Verkaufsablauf ist in Schnellstart; Preise und Gebühren finden Sie unter Preise.

ads networks#

Käufer: Listen Sie die Netzwerke auf, zu denen dieses Projekt eingeladen wurde, und prüfen Sie den zulässigen Bestand und die Slots eines Netzwerks.

ads networks list
ads networks show <seller-project-id>
screenrig ads networks list

ads network#

Verkäufer: Überprüfen oder erstellen Sie das eigene Netzwerk dieses Projekts und legen Sie dessen Standardrate fest.

ads network show
ads network create --name NAME
ads network rate --rate-mcr-per-15s MCR --expect-rev REVISION
screenrig ads network rate --rate-mcr-per-15s 1000 --expect-rev 3

--name hat höchstens 120 Zeichen. --rate-mcr-per-15s ist eine positive ganze Zahl mcr pro 15 Sekunden abgeschlossener Wiedergabe, und --expect-rev ist die revision des Netzwerks aus ads network show. Ein geänderter effektiver Tarif pausiert betroffene Kampagnen, bis jeder Käufer ein frisches Angebot annimmt.

ads inventory#

Verkäufer: Nehmen Sie einen eigenen Bildschirm in die Werbung auf oder schließen Sie ihn aus und beschreiben Sie ihn eingeladenen Käufern.

ads inventory list
ads inventory update <screen-id> [--enabled | --disabled] [--site-name NAME]
    [--city CITY] [--region REGION] [--venue-type TYPE] [--audience-tags TOKENS]
    [--placement TEXT] [--public-description TEXT]
    [--rate-mcr-per-15s MCR | --clear-rate]
    [--impressions-per-hour N | --clear-impressions-per-hour] [--expect-rev REVISION]
screenrig ads inventory update scr_LOBBY --enabled --venue-type cafe

Ausgelassene Flags behalten ihre aktuellen Werte. Eine neue Inventarzeile benötigt --enabled oder --disabled. --impressions-per-hour hält Ihre Schätzung der Impressionen fest, die der Bildschirm in einer Stunde liefert: Jede abgeschlossene Wiedergabe zählt dann diese Schätzung mal die gespielten Sekunden geteilt durch 3600 als estimated_impressions in ads reports spend, ads reports delivery und ads direct report.

update benötigt mindestens ein Flag. --audience-tags nimmt bis zu 20 kommagetrennte Tags, jeweils höchstens 32 Buchstaben, Ziffern oder Unterstriche. --clear-rate setzt den Bildschirm auf den Standardtarif des Projekts zurück und --clear-impressions-per-hour entfernt die Schätzung. --expect-rev ersetzt die gespeicherte Revision der Zeile als Vorbedingung und wird für einen Bildschirm ohne vorhandene Zeile abgelehnt.

ads slots#

Verkäufer: Definieren Sie wiederverwendbare Werbeplätze. Ein Slot ändert nichts am Bildschirm, bis seine Adslot-Seite in eine Playlist eingefügt wird.

ads slots list
ads slots create --name NAME --accepted-media image,video
    [--max-image-duration-ms MS] [--max-video-duration-ms MS]
    [--rate-mcr-per-15s MCR | --clear-rate] [--enabled | --disabled] [--vast-tag-url URL]
ads slots update <slot-id> --expect-rev REVISION [--name NAME]
    [--accepted-media image,video] [--max-image-duration-ms MS] [--max-video-duration-ms MS]
    [--rate-mcr-per-15s MCR | --clear-rate] [--enabled | --disabled]
    [--vast-tag-url URL | --clear-vast-tag-url]
screenrig ads slots create --name "Lobby break" --accepted-media image,video
screenrig ads slots create --name "Lobby video" --accepted-media video --vast-tag-url https://ads.example.com/vast.xml
screenrig ads slots update ads_LOBBY --clear-vast-tag-url --expect-rev 2

Ein neuer Slot ist aktiviert, sofern nicht --disabled angegeben wird. --accepted-media ist image, video oder beides, kommagetrennt. Ausgelassene Dauerlimits betragen 30000 ms; ein Bildlimit liegt zwischen 5000 und 30000 ms, ein Videolimit zwischen 5000 und 120000 ms. --rate-mcr-per-15s ist eine positive ganze Zahl, die den Tarif des Bildschirms oder Projekts für diesen Slot überschreibt, und --clear-rate entfernt die Überschreibung. update behält jedes ausgelassene Feld, und ein geänderter effektiver Tarif pausiert betroffene Kampagnen, bis jeder Käufer ein frisches Angebot annimmt. --vast-tag-url ist eine HTTPS-URL mit höchstens 2048 Zeichen.

--vast-tag-url setzt den eigenen VAST 2-4-Werbetag des Verkäufers, der versucht wird, wenn keine eingeladene Kampagne den Slot auf Ihren eigenen Bildschirmen füllt; der Slot muss Video akzeptieren. Die URL ist HTTPS auf Port 443 oder 8443 zu einem öffentlichen Host. Das Backend ruft sie ab, folgt bis zu fünf Wrappers, importiert das gewählte progressive MP4 oder WebM in die Medien des Projekts und feuert Impression, creativeView und start bei akzeptiertem Start, complete bei akzeptiertem Abschluss und Error bei Fehler; Quartile-Tracker gibt es nicht. Die Makros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] und [SCREENRIG_PAGE_ID] werden erweitert, und Käufer sehen den Tag nie. Bei update ersetzt --vast-tag-url den Tag und --clear-vast-tag-url entfernt ihn; die beiden kombinieren sich nicht, und das Weglassen beider behält den gespeicherten Tag. ads slots list zeigt vast_tag_url dem Besitzverkäufer. Ein Slot, den auf einem Bildschirm nichts füllen kann (kein VAST-Tag und, auf einem für Werbung aktivierten Bildschirm, keine direkte Kampagne, die nicht beendet ist, und keine aktive, ausstehende oder pausierte eingeladene Kampagne, die ihn nennt), wird aus dem Manifest dieses Bildschirms ausgelassen, und screen show listet ihn in ad_quiet_slots auf, sodass der Player nicht mehr nachfragt. Eine Kampagne, ein Tag oder eine Aktivierung, die ihn füllen könnte, bringt ihn zurück.

Advertising invitations#

Verwenden Sie die oben genannten gemeinsamen invitations Befehle:

screenrig invitations create --kind ad-buyer --email owner@bakery.example --screen-id scr_LOBBY --policy review_required
screenrig invitations list --kind ad-buyer
screenrig invitations revoke ID

Eine Einladung für Werbekäufer erfolgt per E-Mail, nie per Link, und braucht mindestens eine --screen-id oder --slot-id (kommagetrennt). --policy ist trusted (Standard) oder review_required.

Die eingeladene Person akzeptiert im Dashboard. Eine angemeldete Person wählt ihr Kaufprojekt aus und bestätigt mit einem frischen Passkey-Nachweis. Eine Person ohne Login erstellt während der Annahme ein Login und ein nur für Werbetreibende bestimmtes Projekt.

ads memberships#

Verkäufer: Ändern oder widerrufen Sie die Überprüfungspolitik und den Inventarbereich eines zugelassenen Käufers.

ads memberships list
ads memberships update <membership-id> --expect-rev REVISION
    [--policy trusted|review_required] [--screen-id IDS] [--slot-id IDS]
ads memberships revoke <membership-id>
screenrig ads memberships list

update behält für ausgelassene Flags die gespeicherte Richtlinie und den gespeicherten Umfang bei. trusted spielt die Creatives des Käufers ohne Prüfung ab; review_required hält jede Creative-Version für Ihre Entscheidung zurück. --screen-id und --slot-id nehmen kommagetrennte IDs und ersetzen die gesamte Liste; ein leerer Wert erlaubt nichts.

Widerruf stoppt neue Anzeigenschaltungen und bewahrt die finanzielle Historie.

ads creatives#

Käufer: Bereiten Sie genehmigte Medien einem unveränderlichen Werbemittel mit genehmigtem Text zu.

ads creatives list
ads creatives create --media-id ID --copy TEXT
ads creatives show <creative-id>
screenrig ads creatives create --media-id med_123 --copy "Fresh bread daily"

Das Verknüpfen eines Creatives kostet nichts und lädt das Medium nicht erneut hoch. Ein genehmigtes Creative ändert sich nie an Ort und Stelle: Bearbeiten Sie das Quellmedium und verknüpfen Sie ein neues Creative. --copy hat höchstens 500 Zeichen. show listet die Prüfung des Creatives durch jedes Verkäufernetzwerk (pending, approved, rejected oder changes_requested) mit der Begründung des Verkäufers.

ads campaigns#

Käufer: Entwerfen Sie eine Kampagne, kalkulieren Sie den Preis und aktivieren Sie sie durch Annahme des Angebots.

ads campaigns list
ads campaigns show <campaign-id>
ads campaigns create <file>
ads campaigns update <campaign-id> <file> --expect-rev REVISION
ads campaigns preview <campaign-id> [--expect-rev REVISION]
ads campaigns activate <campaign-id> --quote-id ID --expect-rev REVISION
ads campaigns pause <campaign-id> --expect-rev REVISION
ads campaigns resume <campaign-id> --expect-rev REVISION
ads campaigns accept-rates <campaign-id> --quote-id ID --expect-rev REVISION
screenrig ads campaigns preview cmp_123

Ein Entwurf reserviert nichts. preview gibt ein zeitlich begrenztes Angebot zurück und gibt nichts aus; activate erfordert genau dieses Angebot. Nach einer Verkäufer-Tarifänderung wird die Kampagne nur mit accept-rates und einem frischen Angebot fortgesetzt.

<file> ist eine JSON-Datei oder - für die Standardeingabe, und update ersetzt einen Entwurf durch das gesamte Dokument. Der Entwurf nennt name, daily_cap_mcr, lifetime_cap_mcr (mindestens das Tageslimit), flight_start und flight_end (RFC 3339) sowie networks, je einen Eintrag pro Verkäufernetzwerk, dem das Projekt beigetreten ist, jeweils mit seller_project_id, screen_ids, slot_ids, creative_ids und optional venue_types, cities, tags, dayparts und network_cap_mcr. Geldfelder sind dezimale mcr-Strings, nie Zahlen. image_duration_ms (5000 bis 30000, zehn Sekunden, wenn ausgelassen) legt fest, wie lange ein Bild angezeigt wird, und max_play_price_mcr begrenzt den Preis einer Wiedergabe; lassen Sie es weg, wenn es keine Obergrenze geben soll.

Ein Kampagnenentwurf nimmt eine optionale category aus der Liste der Werbetreibenden-Kategorien an. Zwei Anzeigen derselben Kategorie laufen nie im selben Werbeblock auf einem Bildschirm.

preview liest die aktuelle Revision der Kampagne, sofern --expect-rev keine nennt. pause stoppt neue Reservierungen; bereits gestartete Wiedergaben werden beendet und zum reservierten Preis abgerechnet. resume setzt eine manuell pausierte Kampagne fort und kann eine Pause wegen Preisänderung nicht aufheben.

ads direct#

Verkäufer: Buchen Sie Ihre eigenen Geschäfte für Werbetreibende außerhalb von screenRIG auf Ihren eigenen Bildschirmen.

ads direct list
ads direct show <campaign-id>
ads direct create <file>
ads direct update <campaign-id> <file> --expect-rev REVISION
ads direct pause <campaign-id> --expect-rev REVISION
ads direct resume <campaign-id> --expect-rev REVISION
ads direct end <campaign-id> --expect-rev REVISION
ads direct availability <file>
ads direct report <campaign-id> [--from TIME] [--to TIME]
    [--format json|csv|xlsx|pdf] [--output FILE|-]
screenrig ads direct create campaign.json

Ein Entwurf nennt name, advertiser, eine optionale category, flight_start und flight_end, media_ids (1 bis 20 Ihrer eigenen fertigen Bilder oder Videos), ein optionales goal_plays, einen optionalen price (model cpm pro tausend Wiedergaben oder flat, mit einem amount und einer currency nach ISO 4217), ein optionales image_duration_ms (5000 bis 30000, zehn Sekunden, wenn ausgelassen) und die Ausrichtung: screen_ids, slot_ids, venue_types, cities, tags und dayparts (etwa {"days": ["mon"], "start": "11:00", "end": "14:00"}), wobei eine leere Liste jeden freigeschalteten Bildschirm oder Werbeplatz bedeutet. Eine Direktkampagne füllt einen Werbeblock vor eingeladenen Käufern. Ein Ziel wird gleichmäßig über die Laufzeit verteilt und läuft zuerst, solange es im Rückstand ist; eine Kampagne ohne Ziel belegt während ihrer Laufzeit jeden passenden Werbeplatz. Über screenRIG wird kein Geld bewegt: Sie stellen dem Werbetreibenden selbst in Rechnung, und der Preis bewertet den Bericht.

<file> ist eine JSON-Datei oder - für die Standardeingabe. category ist hier und in einem Kampagnenentwurf einer der Werte alcohol, apparel, automotive, beauty, cannabis, consumer_electronics, education, entertainment, financial_services, food_and_beverage, gambling, government, grocery, health_and_pharma, home_and_garden, insurance, jobs, legal, media, political, quick_service_restaurants, real_estate, restaurants, retail, sports_and_fitness, technology, telecom, tobacco_and_vaping, travel oder utilities. update ersetzt jedes beschreibbare Feld, senden Sie also das gesamte Dokument. pause hindert eine Kampagne daran, Werbeplätze zu belegen, und resume stellt dies wieder her; eine Kampagne mit Ziel, die während der Pause in Rückstand geraten ist, läuft zuerst, bis sie aufgeholt hat. end ist endgültig: Eine beendete Kampagne spielt nicht mehr, kann nicht fortgesetzt werden und behält ihren Bericht.

availability liest eine Abfrage mit derselben Ausrichtung und Laufzeit und schätzt die Wiedergaben, die Sie noch buchen können: die jüngsten Werbeplatz-Vorkommen der ausgewählten Bildschirme abzüglich der Wiedergaben, die Ihre anderen Direktziele noch benötigen. Es antwortet mit estimated_plays, booked_plays und available_plays, und exclude_campaign_id lässt die Kampagne, die Sie bearbeiten, aus booked_plays heraus. Ein Ziel über der Schätzung gibt goal_overbooked zurück, sofern der Entwurf nicht "overbook": true setzt.

report listet Wiedergaben im Verhältnis zum Ziel, Tempo, Wert, nicht abgespielte Wiedergaben sowie Zeilen nach UTC-Tag, Bildschirm, Werbeplatz und Medium. --from und --to nehmen einen RFC-3339-Zeitpunkt, now oder ein Alter wie 7d, 12h oder 30m und gelten standardmäßig für die Laufzeit. --format csv, xlsx oder pdf schreibt die Zeilen nach --output (Standard ./direct-report-CAMPAIGN_ID.FORMAT) und antwortet mit Pfad, Bytes und SHA-256; mit --format csv schreibt --output - das CSV stattdessen auf die Standardausgabe. Die CSV-Spalten sind day, screen_id, slot_id, media_id, plays, played_ms und estimated_impressions. Ein JSON- oder CSV-Bericht listet höchstens 5000 Zeilen und trägt die Warnung direct_report_truncated, wenn es mehr gibt: Grenzen Sie --from und --to ein, um den Rest zu erhalten.

Das Erstellen, Ersetzen und Fortsetzen einer Direktkampagne, availability und report erfordern einen Tarif mit Direktkampagnen; andere Tarife werden mit feature_not_in_plan abgelehnt. screenrig project capabilities listet die Funktionen des Tarifs auf.

ads reviews#

Verkäufer: Genehmigen, ablehnen oder Änderungen an exakt eingereichten kreativen Versionen von Käufern auf review_required anfordern.

ads reviews list
ads reviews show <review-id>
ads reviews approve <review-id>
ads reviews reject <review-id> --reason TEXT
ads reviews request-changes <review-id> --note TEXT
screenrig ads reviews request-changes arv_123 --note "Use the new logo"

request-changes sendet dem Käufer Ihre Anmerkung. Um die Überarbeitung einzureichen, verknüpfen Sie die überarbeiteten Medien mit einem neuen Werbemittel, fügen Sie es einer neuen Kampagne hinzu und führen Sie preview und activate mit dem neuen Angebot aus. Die Ersatzkampagne hat ein eigenes Budget und einen eigenen Prüfverlauf. Pausieren Sie die ursprüngliche Kampagne, bevor Sie deren Ersatz aktivieren, um parallele Auslieferungen zu vermeiden. Personen entscheiden über Werbemittel auf der Seite „Prüfungen“ im Dashboard, neben Playlist- und Bildschirmänderungen.

list zeigt die Creative-Versionen, die auf Ihre Entscheidung warten, und show eine Einreichung mit ihrem genauen Creative. --reason und --note sind Pflicht und haben höchstens 500 Zeichen; der Käufer liest sie am Creative (ads creatives show). Entscheiden erfordert Zugriff Verwalten.

ads reports#

Lese Ausgaben als Käufer oder Lieferungen als Verkäufer.

ads reports spend --campaign-id ID [--format json|csv|xlsx|pdf] [--output FILE]
ads reports delivery --from TIMESTAMP --to TIMESTAMP
    [--format json|csv|xlsx|pdf] [--output FILE]
ads reports fill [--from TIME] [--to TIME] [--format json|csv|xlsx|pdf] [--output FILE]
screenrig ads reports delivery --from 2026-09-01T00:00:00Z --to 2026-10-01T00:00:00Z

Zustellungsberichte über Brutto, Servicegebühr und Netto für den Zeitraum. Ein Käuferbericht zeigt niemals andere Einnahmen eines Verkäufers. fill zeigt für bis zu 35 Tage, wie viele Werbeplatz-Vorkommen Ihre Bildschirme angefragt haben, wie viele davon Direktkampagnen, eingeladene Käufer und Ihr VAST-Tag gefüllt haben und warum der Rest leer blieb: no_demand, ineligible, separated oder capped.

--format csv, xlsx oder pdf schreibt den Bericht als Datei nach --output (Standard ./ad-spend.FORMAT, ./ad-delivery.FORMAT oder ./ad-fill.FORMAT) und antwortet mit Pfad, Bytes und SHA-256; json ist der Standard und gibt den Umschlag aus. delivery braucht --from und --to als RFC-3339-Zeitpunkte und listet eine Zeile pro abgeschlossenem Vorkommen, höchstens 5000, mit gesetztem truncated, wenn es mehr gibt; die Summen umfassen jede Abrechnung. fill nimmt einen RFC-3339-Zeitpunkt, now oder ein Alter wie 7d, 12h oder 30m: --from ist standardmäßig 7 Tage vor --to, --to ist jetzt, höchstens 35 Tage auseinander, erweitert auf ganze UTC-Stunden.

Weitere Befehlsgruppen