Aller au contenu principal

Configuration

orbiads-cli stocke sa configuration dans ~/.orbiads/config.toml. Tous les paramètres peuvent être définis via la commande orbiads config ou en éditant le fichier directement.

docsCli.configuration.fileTitle

docsCli.configuration.fileLocation
~/.orbiads/config.json
config.json
{
  "api_url": "https://orbiads.com",
  "network_code": "66235823",
  "output": "table",
  "color": true,
  "timeout": 30,
  "debug": false
}

docsCli.configuration.fieldsTitle

ChampTypeDescriptionDefault
api_urlstringdocsCli.configuration.fieldApiUrlhttps://orbiads.com
network_codestringdocsCli.configuration.fieldNetworkCodenull
outputstringdocsCli.configuration.fieldOutput"table"
colorbooleandocsCli.configuration.fieldColortrue
timeoutnumberdocsCli.configuration.fieldTimeout30
debugbooleandocsCli.configuration.fieldDebugfalse

docsCli.configuration.envTitle

docsCli.configuration.envDesc

VariableConfig keyDescription
ORBIADS_API_URLapi_urlURL de l'API OrbiAds
ORBIADS_TOKENToken d'authentification (bypass Device Flow)
ORBIADS_NETWORK_CODEnetwork_codeCode réseau GAM par défaut
ORBIADS_OUTPUToutputFormat de sortie par défaut
NO_COLORcolorDésactive les couleurs (standard NO_COLOR)
Priorité : Variable d'environnement > fichier config > valeur par défaut

docsCli.configuration.completionTitle

docsCli.configuration.completionDesc

$ orbiads --install-completion

docsCli.configuration.completionSupported

docsCli.configuration.outputTitle

docsCli.configuration.outputDesc

--output table

docsCli.configuration.outputTable

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

docsCli.configuration.outputJson

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

docsCli.configuration.outputCsv

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