Aller au contenu principal

Configuration

orbiads-cli speichert seine Konfiguration in ~/.orbiads/config.json. Alle Einstellungen können über den Befehl orbiads config oder durch direktes Bearbeiten der Datei festgelegt werden.

Konfigurationsdatei

Gespeichert in Ihrem Home-Verzeichnis (erstellt von orbiads auth login)
~/.orbiads/config.json

Unter Linux und macOS wird das Verzeichnis mit Modus 700 und die Datei mit Modus 600 angelegt, da sie Ihre Zugriffstoken enthält. Niemals in ein Repository einchecken oder weitergeben.

config.json
{
  "apiUrl": "https://<your-orbiads-backend>",
  "networkCode": "66235823",
  "defaultOutput": "table",
  "token": "<access token, written by orbiads auth login>",
  "refreshToken": "<refresh token, written by orbiads auth login>"
}

Konfigurationsfelder

FeldTypBeschreibungStandard
apiUrlstringBasis-URL des OrbiAds-Backends, mit dem die CLI kommuniziert.integrierte Backend-URL
networkCodestringStandard-Netzwerkcode von Google Ad Manager. Wird von orbiads auth login und orbiads network switch gesetzt.nicht gesetzt
defaultOutputstringGespeicherte Präferenz für das Ausgabeformat: table, json oder csv. Das Format eines einzelnen Befehls wählen Sie mit --output oder --json."table"
tokenstringZugriffstoken, geschrieben von orbiads auth login. Wird von orbiads config show maskiert.vom Login gesetzt
refreshTokenstringRefresh-Token zur automatischen Erneuerung des Zugriffstokens. Wird von orbiads config show maskiert.vom Login gesetzt

Einstellungen lesen und ändern

Verwenden Sie den Befehl config, statt die Datei von Hand zu bearbeiten. Er setzt ein vorheriges orbiads auth login voraus.

$ orbiads config show
$ orbiads config set --network-code 66235823
$ orbiads config set --default-output json

Umgebungsvariablen

Die CLI liest diese Umgebungsvariablen. Für Token und Netzwerkcode gibt es keine Umgebungsvariable: Verwenden Sie orbiads auth login und orbiads network switch.

VariableWirkung
ORBIADS_API_URLÜberschreibt die integrierte Standard-Backend-URL (wird verwendet, wenn der Login die Konfigurationsdatei anlegt).
ORBIADS_FIREBASE_KEYÜberschreibt den integrierten Firebase-Web-API-Schlüssel für die Token-Erneuerung. Gedacht für Staging- oder selbst gehostete Builds.

Shell-Autovervollständigung

Installieren Sie die Tab-Vervollständigung für Ihre Shell mit dem integrierten Befehl und starten Sie danach das Terminal neu.

$ orbiads --install-completion

Unterstützte Shells: Bash, Zsh, Fish und PowerShell. Mit orbiads --show-completion wird das Skript ausgegeben, statt es zu installieren.

Ausgabeformate

Daten gehen an stdout, Meldungen an stderr, daher lässt sich die Ausgabe gefahrlos weiterleiten. Wählen Sie das Format pro Befehl mit der globalen Option --output oder verwenden Sie --json.

--output table

Lesbare Tabelle (Standard in einem interaktiven Terminal).

NAME              STATUS       IMPRESSIONS
My Campaign       DELIVERING   1,234,567
Summer Promo      DRAFT        0
--output json

Maschinenlesbares JSON, ideal für Skripte und KI-Agenten. Wird auch automatisch verwendet, wenn stdout weitergeleitet wird.

[
  {
    "name": "My Campaign",
    "status": "DELIVERING",
    "impressions": 1234567
  }
]
--output csv

Kommagetrennte Werte für Tabellenkalkulationen und Datenpipelines.

name,status,impressions
My Campaign,DELIVERING,1234567
Summer Promo,DRAFT,0