Configurazione

orbiads-cli memorizza la sua configurazione in ~/.orbiads/config.json. Tutti i parametri possono essere definiti tramite il comando orbiads config o modificando il file direttamente.

File di configurazione

Salvato nella cartella home (creato da orbiads auth login)

~/.orbiads/config.json

Su Linux e macOS la cartella viene creata con modalità 700 e il file con modalità 600, perché contiene i token di accesso. Non includerlo mai in un repository e non condividerlo.

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>"
}

Campi di configurazione

Campo	Tipo	Descrizione	Predefinito
apiUrl	string	URL di base del backend OrbiAds con cui comunica la CLI.	URL backend integrato
networkCode	string	Codice rete Google Ad Manager predefinito. Impostato da orbiads auth login e orbiads network switch.	non impostato
defaultOutput	string	Preferenza salvata del formato di output: table, json o csv. Scegli il formato di un singolo comando con --output o --json.	"table"
token	string	Token di accesso scritto da orbiads auth login. Mascherato da orbiads config show.	impostato dal login
refreshToken	string	Token di aggiornamento usato per rinnovare automaticamente il token di accesso. Mascherato da orbiads config show.	impostato dal login

Leggere e modificare le impostazioni

Usa il comando config invece di modificare il file a mano. Richiede un orbiads auth login preventivo.

$ orbiads config show

$ orbiads config set --network-code 66235823

$ orbiads config set --default-output json

Variabili d'ambiente

La CLI legge queste variabili d'ambiente. Non esiste alcuna variabile per il token o per il codice rete: usa orbiads auth login e orbiads network switch.

Variabile	Effetto
ORBIADS_API_URL	Sostituisce l'URL backend predefinito integrato (usato quando il login crea il file di configurazione).
ORBIADS_FIREBASE_KEY	Sostituisce la chiave API web Firebase integrata usata per rinnovare i token. Pensata per build di staging o self-hosted.

Completamento della shell

Installa il completamento con tabulazione per la tua shell con il comando integrato, poi riavvia il terminale.

$ orbiads --install-completion

Shell supportate: Bash, Zsh, Fish e PowerShell. Esegui orbiads --show-completion per stampare lo script invece di installarlo.

Formati di output

I dati vanno su stdout e i messaggi su stderr, quindi l'output può essere reindirizzato senza problemi. Scegli un formato per comando con l'opzione globale --output, oppure usa --json.

--output table

Tabella leggibile (predefinita in un terminale interattivo).

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

--output json

JSON leggibile dalle macchine, ideale per script e agenti IA. Usato automaticamente anche quando stdout è reindirizzato.

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

--output csv

Valori separati da virgole per fogli di calcolo e pipeline di dati.

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