Aller au contenu principal

GAM REST Reporting

26 REST endpoints and MCP tools to create, run and manage GAM reports. Historical covers common AdOps use cases; the full catalogue serves as a validation dictionary.

REST endpoints

MethodPathDescriptionCredits
POST/reports/customRun a custom report (free dimensions + metrics)0.5
POST/reports/inventoryRun an inventory report0.5
GET/reports/available-dimensionsList the REST catalogue dimensions0
GET/reports/available-metricsList the REST catalogue metrics0
GET/reports/available-date-rangesList the relative date ranges0
GET/reports/templatesList templates (builtin + custom)0
POST/reports/templatesCreate a custom template0
POST/reports/templates/{id}/runRun a template0.5
PUT/reports/templates/{id}Update a template0
DELETE/reports/templates/{id}Delete a template0
POST/reports/templates/{id}/cloneDuplicate a template0
POST/reports/gam-reports/{id}/linkLink a GAM report to a template0
POST/reports/gam-reports/{id}/clone-to-templateImport a GAM report as a template0
POST/reports/templates/{id}/publish-to-gamPublish a template to GAM0.5
PATCH/reports/links/{id}/syncSync a bridge link0
GET/reports/links/{id}/diffView the diff of a bridge link0
GET/reports/executionsExecution history0

MCP tools

ToolDescriptionCredits
run_custom_reportRun a report with free dimensions/metrics/filters0.5
fetch_delivery_reportDelivery report for a deployed job0.5
fetch_inventory_reportInventory report by ad unit0.5
run_report_from_templateRun a saved template0.5
export_report_csvExport results as CSV0.5
get_report_resultFetch a cached result (by UUID)0
get_report_dimensionsDictionary of the dimensions declared per report type0
get_report_metricsDictionary of the metrics declared per report type0
get_report_date_rangesAvailable date ranges0
run_pql_queryRun a PQL query (SOAP)0.5
generate_billing_reportGenerate a GAM billing report0.5
get_standalone_forecastAvailable inventory forecast0

Examples

Custom report via MCP

{
  "tool": "run_custom_report",
  "arguments": {
    "dimensions": ["ADVERTISER_NAME", "DATE"],
    "metrics": ["AD_SERVER_IMPRESSIONS", "AD_SERVER_CTR"],
    "date_range": "LAST_30_DAYS",
    "filters": [
      {"dimension": "COUNTRY_NAME", "operator": "EQ", "values": ["France"]}
    ]
  }
}

Report via CLI

orbiads reporting run \
  --dimensions ADVERTISER_NAME,DATE \
  --metrics AD_SERVER_IMPRESSIONS,AD_SERVER_CTR \
  --date-range LAST_30_DAYS

Notes

  • • Reports are run live against the Google Ad Manager API; OrbiAds keeps no persistent copy of your delivery results.
  • • LRO polling makes up to 20 attempts at 5-second intervals.
  • • Builtin templates are read-only; custom templates can be edited and deleted.
  • • Bridge links automatically detect configuration drift between OrbiAds and GAM.

Continue to the MCP reporting use cases

The feature page explains the product surface. The reporting pages detail the prompts, JSON payloads, dimensions and skills an agent should use.

Open the hub