Summary
This connects Claude to Google Ad Manager's API so you can programmatically handle campaign operations without switching to the GAM interface. You get tools for creating and updating orders, managing creatives, configuring targeting rules, and pulling reports. Reach for this when you're building workflows that need to orchestrate ad campaigns alongside other business logic, like spinning up seasonal promotions based on inventory data or generating performance summaries that combine GAM metrics with your own analytics. The streamable HTTP transport means you can run it as a remote service rather than installing locally.
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →
Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →
Tools
Public tool metadata for what this MCP can expose to an agent.
80 tools
get_network_infoGet the GAM network configuration for the tenant. Returns the cached network info (network code, display name, ad units). If not initialized, returns None (agent should call switch_network/network_init).1 params
Get the GAM network configuration for the tenant. Returns the cached network info (network code, display name, ad units). If not initialized, returns None (agent should call switch_network/network_init).
Parameters* required
tenant_idstringswitch_networkInitialize or switch the GAM network context for the tenant. Verifies GAM connectivity and caches the network configuration (ad units, etc.). Use this if get_network_info returns None or to refresh the config.1 params
Initialize or switch the GAM network context for the tenant. Verifies GAM connectivity and caches the network configuration (ad units, etc.). Use this if get_network_info returns None or to refresh the config.
Parameters* required
tenant_idstringlist_accessible_networksList all GAM networks accessible with the tenant's credentials. Calls GET /v1/networks using the tenant's OAuth refresh token. Returns network code, display name, currency, and timezone for each.1 params
List all GAM networks accessible with the tenant's credentials. Calls GET /v1/networks using the tenant's OAuth refresh token. Returns network code, display name, currency, and timezone for each.
Parameters* required
tenant_idstringFirebase tenant UID
list_advertisersList all advertisers in the tenant's GAM network.1 params
List all advertisers in the tenant's GAM network.
Parameters* required
tenant_idstringget_advertiserGet a single advertiser by its ID.2 params
Get a single advertiser by its ID.
Parameters* required
tenant_idstringadvertiser_idstringget_agenciesList all Agencies (type=AGENCY) in the GAM network.1 params
List all Agencies (type=AGENCY) in the GAM network.
Parameters* required
tenant_idstringcreate_agencyCreate a new Agency company in GAM.4 params
Create a new Agency company in GAM.
Parameters* required
namestringdry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringconfirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
create_advertiserCreate a new Advertiser company in GAM. Checks for an existing advertiser with the same name first. If found, returns the existing one with alreadyExisted=true instead of creating a duplicate.4 params
Create a new Advertiser company in GAM. Checks for an existing advertiser with the same name first. If found, returns the existing one with alreadyExisted=true instead of creating a duplicate.
Parameters* required
namestringName of the new advertiser to create in GAM
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringconfirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
find_advertiserFind an existing advertiser by exact name match in GAM. Searches all advertisers in the network and returns the first one whose name exactly matches the provided string. Returns NOT_FOUND if no match exists. Cost: 0.5 credits (deducted on call — no dry_run required for a search).2 params
Find an existing advertiser by exact name match in GAM. Searches all advertisers in the network and returns the first one whose name exactly matches the provided string. Returns NOT_FOUND if no match exists. Cost: 0.5 credits (deducted on call — no dry_run required for a search).
Parameters* required
namestringAdvertiser name to search for (exact match)
tenant_idstringfind_or_create_advertiserFind an existing advertiser by name, or create it if it doesn't exist. Combines search + creation in a single call. Ideal for end-to-end campaign setup workflows where the advertiser may or may not exist.4 params
Find an existing advertiser by name, or create it if it doesn't exist. Combines search + creation in a single call. Ideal for end-to-end campaign setup workflows where the advertiser may or may not exist.
Parameters* required
namestringAdvertiser name — returns existing if found, creates if missing
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringconfirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
find_or_create_orderFind an existing order by name for a given advertiser, or create it if missing. Searches orders for the advertiser, returns the first match by name. If no match, creates a new order. Ideal for idempotent campaign setup.5 params
Find an existing order by name for a given advertiser, or create it if missing. Searches orders for the advertiser, returns the first match by name. If no match, creates a new order. Ideal for idempotent campaign setup.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringorder_namestringOrder name — returns existing if found, creates if missing
advertiser_idstringGAM Advertiser ID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
list_delivering_ordersList all delivering or delivering_slowly orders for a tenant. Queries GAM OrderService for orders with status DELIVERING or DELIVERING_SLOWLY. Returns basic details: id, name, status, start/end dates, advertiserId.1 params
List all delivering or delivering_slowly orders for a tenant. Queries GAM OrderService for orders with status DELIVERING or DELIVERING_SLOWLY. Returns basic details: id, name, status, start/end dates, advertiserId.
Parameters* required
tenant_idstringFirebase tenant UID
get_orderFetch a single GAM Order by ID. Returns: id, name, status, advertiserId, agencyId, traffickerId, poNumber, notes.2 params
Fetch a single GAM Order by ID. Returns: id, name, status, advertiserId, agencyId, traffickerId, poNumber, notes.
Parameters* required
order_idstringGAM Order ID
tenant_idstringFirebase tenant UID
list_ordersList GAM Orders with optional name search and pagination. Returns: items (list of order dicts), total, offset, limit. Each order has: id, name, status, advertiserId, traffickerId, poNumber, notes.4 params
List GAM Orders with optional name search and pagination. Returns: items (list of order dicts), total, offset, limit. Each order has: id, name, status, advertiserId, traffickerId, poNumber, notes.
Parameters* required
qvalueOptional name search (LIKE match)
limitintegerPage size (max 200)default: 50
offsetintegerPagination offsetdefault: 0
tenant_idstringFirebase tenant UID
create_orderCreate a new GAM Order. An Order is the container for Line Items. It belongs to an Advertiser. The traffickerId is automatically set to the current authenticated user. When check_existing=True (default), searches for an order with the same name and advertiser before creating....9 params
Create a new GAM Order. An Order is the container for Line Items. It belongs to an Advertiser. The traffickerId is automatically set to the current authenticated user. When check_existing=True (default), searches for an order with the same name and advertiser before creating....
Parameters* required
namestringOrder display name in GAM
notesstringOptional order notesdefault:
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
agency_idvalueOptional GAM Agency company ID
po_numberstringOptional purchase order numberdefault:
tenant_idstringFirebase tenant UID
advertiser_idintegerGAM Advertiser company ID
check_existingbooleanIf True (default), checks for existing order with same name + advertiser before creatingdefault: true
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
archive_orderArchive a GAM Order via performOrderAction(ArchiveOrders). Archiving hides the order and all its line items from active views. The order remains queryable but stops serving. Cannot be undone easily.4 params
Archive a GAM Order via performOrderAction(ArchiveOrders). Archiving hides the order and all its line items from active views. The order remains queryable but stops serving. Cannot be undone easily.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
order_idstringGAM Order ID to archive
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
approve_orderApprove a GAM Order (transitions it to APPROVED status). Approving an Order also approves all eligible Line Items within it, allowing them to start delivering when their start date is reached.4 params
Approve a GAM Order (transitions it to APPROVED status). Approving an Order also approves all eligible Line Items within it, allowing them to start delivering when their start date is reached.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
order_idstringGAM Order ID to approve
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
verify_order_setupPre-launch verification of an entire Order and all its Line Items. Runs verify_line_item_setup on each LI attached to the order. Returns aggregate pass/fail with per-LI details.2 params
Pre-launch verification of an entire Order and all its Line Items. Runs verify_line_item_setup on each LI attached to the order. Returns aggregate pass/fail with per-LI details.
Parameters* required
order_idstringGAM Order ID to verify
tenant_idstringFirebase tenant UID
update_orderUpdate an existing GAM Order. Uses read-modify-write: fetches the order, applies updates, and saves. Supported fields: name, poNumber, notes, traffickerId, startDateTime, endDateTime, totalBudget.5 params
Update an existing GAM Order. Uses read-modify-write: fetches the order, applies updates, and saves. Supported fields: name, poNumber, notes, traffickerId, startDateTime, endDateTime, totalBudget.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
updatesobjectFields to update. Supported: name, poNumber, notes, traffickerId, startDateTime, endDateTime, totalBudget ({currencyCode, microAmount})
order_idstringGAM Order ID to update
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from dry_run=True call
get_contactsList GAM contacts, optionally filtered by company. Returns: list of contacts with id, name, companyId, email.2 params
List GAM contacts, optionally filtered by company. Returns: list of contacts with id, name, companyId, email.
Parameters* required
tenant_idstringFirebase tenant UID
company_idvalueOptional GAM Company/Advertiser ID to filter by
create_contactCreate a GAM Contact associated with a Company/Advertiser. Contacts can be attached to Orders for billing and communication purposes.8 params
Create a GAM Contact associated with a Company/Advertiser. Contacts can be attached to Orders for billing and communication purposes.
Parameters* required
namestringContact full name
emailstringContact email address
phonevalueOptional phone number
titlevalueOptional job title
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
company_idintegerGAM Company/Advertiser ID this contact belongs to
confirmation_tokenvalueToken from dry_run=True call
create_line_itemsCreate Line Items for a deployed job. Requires the job to have targeting configured in Firestore. Creates Line Items (one per Ad Unit).5 params
Create Line Items for a deployed job. Requires the job to have targeting configured in Firestore. Creates Line Items (one per Ad Unit).
Parameters* required
job_idstringdry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringname_templatevalueOptional name template for Line Items. Supports tokens: {short_id}, {i}, {prefix}, {advertiser}, {campaign}, {variant}.
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
activate_line_itemsActivate all Line Items for a job (PAUSED -> DELIVERING).4 params
Activate all Line Items for a job (PAUSED -> DELIVERING).
Parameters* required
job_idstringFirestore job document ID
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
pause_line_itemsPause all Line Items for a job (DELIVERING -> PAUSED).4 params
Pause all Line Items for a job (DELIVERING -> PAUSED).
Parameters* required
job_idstringFirestore job document ID
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
get_line_itemGet a single line item by ID.2 params
Get a single line item by ID.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID
update_line_itemUpdate a specific Line Item (e.g., changes to targeting, dates, or status).5 params
Update a specific Line Item (e.g., changes to targeting, dates, or status).
Parameters* required
updateobjectFields to update (all optional). Accepted keys: name (str), start_date_time (ISO str), end_date_time (ISO str | null), priority (int 1-16), cost_per_unit_micro (int), currency_code (str), goal_units (int), delivery_rate_type (EVENLY|FRONTLOADED|AS_FAST_AS_POSSIBLE), line_item_type (STANDARD|SPONSORSHIP|NETWORK|HOUSE|BULK|PRICE_PRIORITY), creative_rotation_type (EVEN|OPTIMIZED|SEQUENTIAL), frequency_cap_impressions (int), frequency_cap_period (PER_DAY|PER_WEEK|PER_MONTH), roadblocking_type (ONE_OR_MORE|ALL_ROADBLOCK|CREATIVE_SET), allow_overbook (bool), primary_goal_units (int), primary_goal_type (str).
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
list_line_items_by_orderList Line Items belonging to a specific Order. Returns details: id, name, status, stats, goals, etc. Supports pagination via offset and limit parameters.4 params
List Line Items belonging to a specific Order. Returns details: id, name, status, stats, goals, etc. Supports pagination via offset and limit parameters.
Parameters* required
limitintegerMaximum number of items to return (1–500, default 100)default: 100
offsetintegerNumber of items to skip for pagination (default 0)default: 0
order_idintegerGAM Order ID
tenant_idstringFirebase tenant UID
duplicate_line_itemDuplicate a Line Item in Google Ad Manager. Fetches the full line item configuration, creates a copy with ' - Copy' appended to the name, and applies any provided overrides. The duplicate always starts in DRAFT status.5 params
Duplicate a Line Item in Google Ad Manager. Fetches the full line item configuration, creates a copy with ' - Copy' appended to the name, and applies any provided overrides. The duplicate always starts in DRAFT status.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
overridesvalueOptional overrides to apply to the copy (e.g., {name: 'New Name', targeting: {...}})
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID to duplicate
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
archive_line_itemArchive a Line Item in Google Ad Manager. GAM does not delete Line Items — archiving removes them from active views. Archived items can still be queried but won't serve ads.4 params
Archive a Line Item in Google Ad Manager. GAM does not delete Line Items — archiving removes them from active views. Archived items can still be queried but won't serve ads.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID to archive
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
verify_line_item_setupPre-launch verification of a Line Item's readiness. Checks: creative associations exist, targeting is set, dates are valid, goal > 0. Returns a pass/fail report with actionable messages.2 params
Pre-launch verification of a Line Item's readiness. Checks: creative associations exist, targeting is set, dates are valid, goal > 0. Returns a pass/fail report with actionable messages.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID to verify
approve_line_itemApprove a Line Item in GAM (transitions from DRAFT/NEEDS_CREATIVES to READY). Note: Line Items typically auto-approve when their parent Order is approved. Use this for individual LI approval when needed.4 params
Approve a Line Item in GAM (transitions from DRAFT/NEEDS_CREATIVES to READY). Note: Line Items typically auto-approve when their parent Order is approved. Use this for individual LI approval when needed.
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID to approve
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
create_adexchange_line_itemCreate an AdExchange (programmatic) Line Item with floor CPM targeting. currency_code, delivery_rate_type, and creative_rotation_type fall back to tenant delivery defaults (configurable via update_delivery_defaults) when not provided.17 params
Create an AdExchange (programmatic) Line Item with floor CPM targeting. currency_code, delivery_rate_type, and creative_rotation_type fall back to tenant delivery defaults (configurable via update_delivery_defaults) when not provided.
Parameters* required
namestringLine Item name in GAM
sizesvalueCreative sizes [{width, height}]. Defaults to 1×1 (BROWSER) or 640×360 (VIDEO_PLAYER).
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
order_idintegerGAM Order ID
priorityvalueLine item priority (1-16). Defaults to type default.
tenant_idstringFirebase tenant UID
ad_unit_idsarrayList of Ad Unit IDs to target
currency_codevalueISO currency code. None = use tenant delivery defaults.
environment_typestringBROWSER or VIDEO_PLAYERdefault: BROWSER
floor_cpm_microsintegerFloor CPM in micros (e.g. 1000000 = 1.00 EUR)default: 0
roadblocking_typestringONE_OR_MORE, ALL_ROADBLOCK, or CREATIVE_SETdefault: ONE_OR_MORE
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
delivery_rate_typevalueEVENLY, FRONTLOADED, or AS_FAST_AS_POSSIBLE. None = use tenant delivery defaults.
frequency_cap_periodstringPER_DAY, PER_WEEK, PER_MONTH, PER_HOURdefault: PER_DAY
video_max_duration_msintegerMax video duration in ms (VIDEO_PLAYER only)default: 30000
creative_rotation_typevalueEVEN, OPTIMIZED, or SEQUENTIAL. None = use tenant delivery defaults.
frequency_cap_impressionsintegerMax impressions per frequency_cap_period. 0 = no cap.default: 0
create_open_bidding_line_itemCreate an Open Bidding (Exchange Bidding) Line Item with floor CPM. Open Bidding line items use lineItemType=AD_EXCHANGE with a floor CPM. Demand partners bid in real-time above the floor; delivery is not guaranteed.15 params
Create an Open Bidding (Exchange Bidding) Line Item with floor CPM. Open Bidding line items use lineItemType=AD_EXCHANGE with a floor CPM. Demand partners bid in real-time above the floor; delivery is not guaranteed.
Parameters* required
namestringLine Item name in GAM
sizesvalueCreative sizes [{width, height}]. Defaults to 1x1.
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
order_idintegerGAM Order ID
tenant_idstringFirebase tenant UID
ad_unit_idsarrayList of Ad Unit IDs to target
currency_codestringISO currency codedefault: EUR
end_date_timevalueISO end datetime. None = unlimited.
allow_overbookbooleanAllow overbooking (default True for RTB)default: true
start_date_timevalueISO start datetime. None = immediately.
environment_typestringBROWSER or VIDEO_PLAYERdefault: BROWSER
floor_cpm_microsintegerFloor CPM in micros (e.g. 1000000 = 1.00 EUR)default: 0
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
frequency_cap_periodstringPER_DAY, PER_WEEK, PER_MONTH, PER_HOURdefault: PER_DAY
frequency_cap_impressionsintegerMax impressions per frequency_cap_period. 0 = no cap.default: 0
list_private_dealsList Private Deals (PMP) available in the GAM network. Returns deal IDs, names, types and statuses. Use the returned Id as deal_id when calling create_preferred_deal_line_item. Note: requires a live network — may return UNEXECUTABLE on test networks.2 params
List Private Deals (PMP) available in the GAM network. Returns deal IDs, names, types and statuses. Use the returned Id as deal_id when calling create_preferred_deal_line_item. Note: requires a live network — may return UNEXECUTABLE on test networks.
Parameters* required
tenant_idstringFirebase tenant UID
status_filtervalueFilter by status: ACTIVE, INACTIVE, ARCHIVED. None = all.
update_line_item_targetingUpdate targeting on an existing Line Item (custom, geo, day-part targeting). Modifiable post-creation: customTargeting, geoTargeting, dayPartTargeting. Ad unit targeting is locked after line item creation.5 params
Update targeting on an existing Line Item (custom, geo, day-part targeting). Modifiable post-creation: customTargeting, geoTargeting, dayPartTargeting. Ad unit targeting is locked after line item creation.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID
targeting_fieldsobjectTargeting fields to update. Accepted keys: customTargeting (list of {keyId, valueIds}), customTargetingOperator ('AND'|'OR'), geoTargeting (GAM geo targeting dict), dayPartTargeting (GAM day-part targeting dict). Note: ad unit targeting is NOT modifiable post-creation.
confirmation_tokenvalueToken from dry_run=True call
create_preferred_deal_line_itemCreate a Preferred Deal (PMP non-guaranteed) Line Item linked to a private deal ID. Requires Deal Manager to be disabled on the network (direct flow). Use list_private_deals to retrieve valid deal IDs before calling this tool. The line item is created with: - lineItemType = PR...16 params
Create a Preferred Deal (PMP non-guaranteed) Line Item linked to a private deal ID. Requires Deal Manager to be disabled on the network (direct flow). Use list_private_deals to retrieve valid deal IDs before calling this tool. The line item is created with: - lineItemType = PR...
Parameters* required
namestringLine Item name in GAM
sizesvalueCreative sizes [{width, height}]. Defaults to 1×1.
deal_idintegerExternal Deal ID shared by the buyer (from list_private_deals)
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
order_idintegerGAM Order ID
tenant_idstringFirebase tenant UID
ad_unit_idsarrayList of Ad Unit IDs to target
currency_codevalueISO currency code. None = use tenant delivery defaults.
end_date_timevalueISO end datetime. None = unlimited.
start_date_timevalueISO start datetime. None = immediately.
environment_typestringBROWSER or VIDEO_PLAYERdefault: BROWSER
floor_cpm_microsintegerFloor CPM in micros (e.g. 2000000 = 2.00 EUR)default: 0
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
creative_size_typestringDISPLAY, NATIVE, or VIDEOdefault: DISPLAY
frequency_cap_periodstringPER_DAY, PER_WEEK, PER_MONTH, PER_HOURdefault: PER_DAY
frequency_cap_impressionsintegerMax impressions per period. 0 = no cap.default: 0
list_creatives_by_advertiserList all creatives associated with a specific advertiser.2 params
List all creatives associated with a specific advertiser.
Parameters* required
tenant_idstringFirebase tenant UID
advertiser_idstringGAM Advertiser ID (numeric string)
upload_creative[DEPRECATED] Upload a standalone image asset to Google Ad Manager. CreativeAssetService is unavailable in the supported GAM SOAP version. Use create_image_creative instead — it uploads and creates the creative in one step.5 params
[DEPRECATED] Upload a standalone image asset to Google Ad Manager. CreativeAssetService is unavailable in the supported GAM SOAP version. Use create_image_creative instead — it uploads and creates the creative in one step.
Parameters* required
namestringHuman-readable name for the creative asset in GAMdefault:
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
file_pathstringAbsolute path to the image file on the server filesystem
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
associate_creativeAssociate a creative with a Line Item in Google Ad Manager (create LICA). Links the specified creative to the Line Item so ads can serve. Returns the created LICA ID(s).5 params
Associate a creative with a Line Item in Google Ad Manager (create LICA). Links the specified creative to the Line Item so ads can serve. Returns the created LICA ID(s).
Parameters* required
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
creative_idintegerGAM Creative / NativeStyle ID
line_item_idintegerGAM Line Item ID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
update_creativeUpdate a creative in Google Ad Manager (read-modify-write). Modify any property: name, destinationUrl, snippet, tracking URLs, size, status. For tracking: add/replace thirdPartyImpressionTrackingUrls (pixel URLs for IAS, MOAT, DoubleVerify, DCM), thirdPartyClickTrackingUrl (Ht...5 params
Update a creative in Google Ad Manager (read-modify-write). Modify any property: name, destinationUrl, snippet, tracking URLs, size, status. For tracking: add/replace thirdPartyImpressionTrackingUrls (pixel URLs for IAS, MOAT, DoubleVerify, DCM), thirdPartyClickTrackingUrl (Ht...
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
creative_idintegerGAM Creative ID
update_fieldsobjectDictionary of fields to update. Supported keys: name, destinationUrl, snippet, expandedSnippet, vastRedirectUrl, size ({width, height}), status (ACTIVE/INACTIVE), thirdPartyImpressionTrackingUrls (list of pixel URLs — ImageCreative/Html5Creative/ThirdPartyCreative), thirdPartyClickTrackingUrl (string — Html5Creative only), trackingUrls (dict of VAST event → URL list — VideoRedirectCreative only, keys: CREATIVE_VIEW, START, FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE, CLICK_TRACKING), isSafeFrameCompatible (bool). Tracking URLs support GAM macros: %%CACHEBUSTER%%, %%CLICK_URL_ESC%%, %%SITE%%.
confirmation_tokenvalueToken from a previous dry_run=True call
list_creatives_by_line_itemList all creatives associated with a specific line item. Uses LICA service to find associations, then Creative service to fetch details.2 params
List all creatives associated with a specific line item. Uses LICA service to find associations, then Creative service to fetch details.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID (numeric string)
get_creativeFetch details for a single creative by ID.2 params
Fetch details for a single creative by ID.
Parameters* required
tenant_idstringFirebase tenant UID
creative_idstringGAM Creative ID (numeric string)
get_creative_preview_urlGenerate a GAM creative preview URL for testing on a real site. Opens the specified site with the ad injected for visual verification, without affecting delivery statistics. Perfect for client sign-off.4 params
Generate a GAM creative preview URL for testing on a real site. Opens the specified site with the ad injected for visual verification, without affecting delivery statistics. Perfect for client sign-off.
Parameters* required
site_urlstringURL of the site to preview the ad on (e.g., https://www.example.com/article)
tenant_idstringFirebase tenant UID
creative_idstringGAM Creative ID
line_item_idstringGAM Line Item ID
get_campaign_preview_linksGenerate preview URLs for multiple Line Item / Creative pairs in one call. Each pair can have its own site_url; falls back to default_site_url. Soft-fail per pair: a failed URL returns {error: ...} instead of failing the whole call. Returns: previewLinks list with label, lineI...3 params
Generate preview URLs for multiple Line Item / Creative pairs in one call. Each pair can have its own site_url; falls back to default_site_url. Soft-fail per pair: a failed URL returns {error: ...} instead of failing the whole call. Returns: previewLinks list with label, lineI...
Parameters* required
tenant_idstringFirebase tenant UID
default_site_urlstringFallback site URL for pairs without their own site_url
li_creative_pairsarrayList of {line_item_id, creative_id, label?, site_url?} pairs
upload_and_associate_creativeUpload a creative image and associate it with a Line Item in one step. Performs three operations in sequence: 1. create_image_creative — uploads image bytes inline + creates the ImageCreative in GAM. 2. create_lica — links the creativeId to the line_item_id so ads can serve. T...10 params
Upload a creative image and associate it with a Line Item in one step. Performs three operations in sequence: 1. create_image_creative — uploads image bytes inline + creates the ImageCreative in GAM. 2. create_lica — links the creativeId to the line_item_id so ads can serve. T...
Parameters* required
namestringCreative name in GAM. If empty, auto-resolved from the tenant naming convention (creative_template). Macros available: {advertiser}, {format}, {size}, {YYYY}, {MM}, {DD}. Example: 'OrbitAds-IMAGE-300x250-20260304'.default:
widthintegerCreative width in pixels (e.g. 300)
heightintegerCreative height in pixels (e.g. 250)
dry_runbooleanIf True (default), returns preview without executingdefault: true
file_pathstringAbsolute path to the image file (PNG/JPG/GIF — max 1 MB)
tenant_idstringFirebase tenant UID
line_item_idintegerGAM Line Item ID to associate with
advertiser_idintegerGAM Advertiser ID — required to create the ImageCreative object
destination_urlstringClick-through URL (e.g. https://www.example.com)default:
confirmation_tokenvalueToken from a previous dry_run=True call
bulk_upload_creativesUpload multiple creative images with per-file sizes, names and click URLs. REQUIRED per file: file_path, width, height, destination_url. Each file can have its own name/destination_url override. The creative name follows the tenant naming convention (creative_template) if conf...8 params
Upload multiple creative images with per-file sizes, names and click URLs. REQUIRED per file: file_path, width, height, destination_url. Each file can have its own name/destination_url override. The creative name follows the tenant naming convention (creative_template) if conf...
Parameters* required
filesarrayList of creative files to upload. Each entry MUST include: {"file_path": "/abs/path/banner.png", "width": 300, "height": 250, "destination_url": "https://example.com/landing"}. Optional per file: "name" (default: filename stem). REQUIRED: width, height (exact pixel dimensions for GAM inventory forecasting), destination_url (click-through URL — REQUIRED for image creatives). Size limit: PNG/JPG/GIF max 1 MB each.
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
advertiser_idintegerGAM Advertiser ID for all creatives
line_item_idsvalueOptional GAM Line Item IDs — each uploaded creative is automatically associated to ALL provided Line Items via LICA. Use for multi-placement campaigns.
destination_urlstringDefault click-through URL for all files (per-file destination_url overrides this). REQUIRED if not provided per-file. Image creatives must have a click-through URL.default:
skip_duplicatesbooleanIf True (default), skip upload if a creative with the same name+size already exists for the advertiserdefault: true
confirmation_tokenvalueToken from a previous dry_run=True call
create_third_party_creativeCreate a ThirdPartyCreative in GAM for external ad tags. Use this for custom HTML/JS tags from third-party ad servers (DV360, TTD, etc.). Distinct from create_html5_creative which is for self-contained HTML5 ads. Supports native third-party impression tracking (IAS, MOAT, DV,...10 params
Create a ThirdPartyCreative in GAM for external ad tags. Use this for custom HTML/JS tags from third-party ad servers (DV360, TTD, etc.). Distinct from create_html5_creative which is for self-contained HTML5 ads. Supports native third-party impression tracking (IAS, MOAT, DV,...
Parameters* required
namestringCreative name in GAM
widthintegerCreative width in pixelsdefault: 300
heightintegerCreative height in pixelsdefault: 250
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
html_snippetstringThird-party HTML/JS ad tag snippet
advertiser_idintegerGAM advertiser ID
confirmation_tokenvalueToken from a previous dry_run=True call
is_safe_frame_compatiblebooleanWhether the creative is SafeFrame compatibledefault: true
third_party_impression_tracking_urlsvalueThird-party impression pixel URLs (IAS, MOAT, DoubleVerify, DCM Floodlight). Native GAM field — stored on the creative object, not injected in HTML.
create_video_creativeCreate a VAST VideoRedirectCreative in GAM. Supports native video event tracking (VAST pixels) for IAS, MOAT, DoubleVerify, DCM, etc. Use tracking_urls to attach pixels to specific VAST events (impression, quartiles, complete).9 params
Create a VAST VideoRedirectCreative in GAM. Supports native video event tracking (VAST pixels) for IAS, MOAT, DoubleVerify, DCM, etc. Use tracking_urls to attach pixels to specific VAST events (impression, quartiles, complete).
Parameters* required
namestringCreative name in GAM
widthintegerCreative width in pixelsdefault: 640
heightintegerCreative height in pixelsdefault: 360
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
advertiser_idintegerGAM advertiser ID
tracking_urlsvalueNative GAM video event tracking — map of ConversionEvent to URL lists. Keys: CREATIVE_VIEW, START, FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE, MUTE, UNMUTE, PAUSE, REWIND, FULLSCREEN, CLICK_TRACKING. Example: {"CREATIVE_VIEW": ["https://pixel.ias.com/..."], "COMPLETE": ["https://track.example.com/..."]}
vast_redirect_urlstringVAST redirect URL for the video creative
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
create_html5_creativeCreate an Html5Creative in GAM from an HTML snippet. The HTML content is automatically packaged into a ZIP bundle and uploaded as an Html5Creative (not a ThirdPartyCreative). For 3rd-party tags, use create_third_party_creative instead. IMPORTANT: For HTML5 creatives, the click...8 params
Create an Html5Creative in GAM from an HTML snippet. The HTML content is automatically packaged into a ZIP bundle and uploaded as an Html5Creative (not a ThirdPartyCreative). For 3rd-party tags, use create_third_party_creative instead. IMPORTANT: For HTML5 creatives, the click...
Parameters* required
namestringCreative name in GAM. Macros available if creative_template is configured: {advertiser}, {format}, {size}, {YYYY}, {MM}, {DD}.
widthintegerCreative width in pixelsdefault: 300
heightintegerCreative height in pixelsdefault: 250
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
html_snippetstringSelf-contained HTML5 ad content. The click URL must be hardcoded inside the HTML (destination_url is not applicable for Html5Creative).
advertiser_idintegerGAM advertiser ID
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
upload_html5_zip_creativeUpload a pre-built HTML5 ZIP bundle as an Html5Creative in GAM. Use this when the studio delivers a ready-made ZIP file. For an inline HTML snippet, use create_html5_creative instead. IMPORTANT: The click-through URL must be embedded in the HTML/JS inside the ZIP. There is no...11 params
Upload a pre-built HTML5 ZIP bundle as an Html5Creative in GAM. Use this when the studio delivers a ready-made ZIP file. For an inline HTML snippet, use create_html5_creative instead. IMPORTANT: The click-through URL must be embedded in the HTML/JS inside the ZIP. There is no...
Parameters* required
namestringCreative name in GAM. If empty, auto-resolved from the tenant naming convention. Macros: {advertiser}, {format}, {size}, {YYYY}, {MM}, {DD}.default:
widthintegerCreative width in pixels (e.g. 728). Use 1 with force_fluid=True for responsive creatives.
heightintegerCreative height in pixels (e.g. 90). Use 1 with force_fluid=True for responsive creatives.
dry_runbooleanIf True (default), returns preview without executingdefault: true
file_pathstringAbsolute path to the HTML5 ZIP bundle (max 2 MB)
tenant_idstringFirebase tenant UID
force_fluidbooleanIf True, always create as 1×1 fluid regardless of detected size.default: false
advertiser_idintegerGAM advertiser ID
auto_detect_fluidbooleanIf True, analyse index.html in the ZIP for responsive CSS/JS patterns. When detected (vw/vh/%, @media, window.innerWidth), the creative is created as 1×1 fluid (isAspectRatio=True) and can serve at any container size.default: false
confirmation_tokenvalueToken from a previous dry_run=True call
allow_safeframe_breakoutbooleanIf False (default), high-risk SafeFrame breakout patterns (window.top.location, parent.document, document.domain) block the upload. Set True only if the creative intentionally requires parent-frame access (e.g. expandable ads).default: false
compress_image_creativeCompress an oversized image creative to meet GAM's 1 MB limit. Uses PIL/Pillow to progressively reduce JPEG quality via binary search until the output fits within target_kb. GIF files are converted to PNG first. Output: written next to the original as {stem}_compressed.jpg (or...5 params
Compress an oversized image creative to meet GAM's 1 MB limit. Uses PIL/Pillow to progressively reduce JPEG quality via binary search until the output fits within target_kb. GIF files are converted to PNG first. Output: written next to the original as {stem}_compressed.jpg (or...
Parameters* required
dry_runbooleanIf True (default), returns estimate without writing the filedefault: true
file_pathstringAbsolute path to PNG or JPG image (GIF will be converted to PNG)
target_kbintegerTarget output size in KB (default 100, max 1000)default: 100
tenant_idstringFirebase tenant UID
confirmation_tokenvalueToken from a previous dry_run=True call
get_licas_by_line_itemList all LICA associations (Line Item Creative Associations) for a Line Item. Returns raw LICA objects with id, lineItemId, creativeId, status, and sizes. Use list_creatives_by_line_item to get enriched Creative details instead.2 params
List all LICA associations (Line Item Creative Associations) for a Line Item. Returns raw LICA objects with id, lineItemId, creativeId, status, and sizes. Use list_creatives_by_line_item to get enriched Creative details instead.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID (numeric string)
get_licas_batchFetch LICA associations for multiple Line Items in a single batch call. Returns a dict mapping lineItemId (str) to a list of LICA objects. More efficient than calling get_licas_by_line_item repeatedly.2 params
Fetch LICA associations for multiple Line Items in a single batch call. Returns a dict mapping lineItemId (str) to a list of LICA objects. More efficient than calling get_licas_by_line_item repeatedly.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idsarrayList of GAM Line Item IDs (numeric strings)
deactivate_licaDeactivate a LICA (Line Item Creative Association) in GAM. Removes the association between a creative and a line item so the creative stops serving on that line item. The LICA can be re-activated later.5 params
Deactivate a LICA (Line Item Creative Association) in GAM. Removes the association between a creative and a line item so the creative stops serving on that line item. The LICA can be re-activated later.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
creative_idintegerGAM Creative / NativeStyle ID
line_item_idintegerGAM Line Item ID
confirmation_tokenvalueToken from a previous dry_run=True call
delete_licasDelete LICAs (Line Item Creative Associations) from GAM. Permanently removes creative associations from a line item. Use get_licas_by_line_item to find LICA IDs first. WARNING: This action cannot be undone.5 params
Delete LICAs (Line Item Creative Associations) from GAM. Permanently removes creative associations from a line item. Use get_licas_by_line_item to find LICA IDs first. WARNING: This action cannot be undone.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
lica_idsarrayList of LICA IDs to delete
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID
confirmation_tokenvalueToken from a previous dry_run=True call
create_audio_creativeCreate a VAST AudioCreative in GAM.7 params
Create a VAST AudioCreative in GAM.
Parameters* required
namestringCreative name in GAM
dry_runbooleanIf True (default), returns preview without executing any SOAP calldefault: true
tenant_idstringFirebase tenant UID
advertiser_idintegerGAM advertiser ID
duration_millisintegerAudio duration in millisecondsdefault: 30000
vast_redirect_urlstringVAST redirect URL for audio
confirmation_tokenvalueToken from a previous dry_run=True call. Required when dry_run=False.
list_creatives_by_networkSearch all creatives in the GAM network by name. Returns: items (list of creative dicts), total, offset, limit. Each creative has id, name, advertiserId, size, creativeType, status.4 params
Search all creatives in the GAM network by name. Returns: items (list of creative dicts), total, offset, limit. Each creative has id, name, advertiserId, size, creativeType, status.
Parameters* required
qvalueOptional name search
limitintegerPage size (max 500)default: 100
offsetintegerPagination offsetdefault: 0
tenant_idstringFirebase tenant UID
archive_creativeArchive (deactivate) a creative in GAM. Archived creatives no longer serve traffic but are not deleted. This action can be reversed by reactivating the creative in GAM UI.4 params
Archive (deactivate) a creative in GAM. Archived creatives no longer serve traffic but are not deleted. This action can be reversed by reactivating the creative in GAM UI.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
creative_idintegerGAM Creative ID to archive
confirmation_tokenvalueToken from dry_run=True call
list_native_stylesList NativeStyles in the GAM network with optional name filter.4 params
List NativeStyles in the GAM network with optional name filter.
Parameters* required
limitintegerMax number of results (default 500)default: 500
offsetintegerPagination offsetdefault: 0
tenant_idstringFirebase tenant UID
name_filtervalueOptional name substring filter
get_native_styleFetch a single NativeStyle by ID, including HTML/CSS snippets and fluid settings.2 params
Fetch a single NativeStyle by ID, including HTML/CSS snippets and fluid settings.
Parameters* required
tenant_idstringFirebase tenant UID
native_style_idintegerOrbiAdsStyle ID
update_native_styleUpdate a NativeStyle's HTML, CSS, name, or size settings.10 params
Update a NativeStyle's HTML, CSS, name, or size settings.
Parameters* required
namevalueNew name (optional)
widthvalueNew width in pixels (optional)
heightvalueNew height in pixels (optional)
dry_runbooleanIf True (default), returns preview without executingdefault: true
is_fluidvalueSet fluid flag (optional — omit to keep existing)
tenant_idstringFirebase tenant UID
css_snippetvalueNew CSS snippet (optional)
html_snippetvalueNew HTML snippet (optional)
native_style_idintegerOrbiAdsStyle ID to update
confirmation_tokenvalueToken from a previous dry_run=True call
archive_native_styleArchive a NativeStyle so it stops serving.4 params
Archive a NativeStyle so it stops serving.
Parameters* required
dry_runbooleanIf True (default), returns preview without executingdefault: true
tenant_idstringFirebase tenant UID
native_style_idintegerOrbiAdsStyle ID to archive
confirmation_tokenvalueToken from a previous dry_run=True call
create_image_creativeCreate an ImageCreative in GAM from a local image file. Reads the image file and uploads it inline via CreativeService (no separate upload step). Supports standard IAB display sizes (banner, MPU, billboard, etc.). Supported formats: PNG, JPG, GIF, SVG. Supports native third-pa...10 params
Create an ImageCreative in GAM from a local image file. Reads the image file and uploads it inline via CreativeService (no separate upload step). Supports standard IAB display sizes (banner, MPU, billboard, etc.). Supported formats: PNG, JPG, GIF, SVG. Supports native third-pa...
Parameters* required
namestringCreative display name in GAM
widthintegerCreative width in pixels (e.g. 300)
heightintegerCreative height in pixels (e.g. 250)
dry_runbooleanIf True (default), returns preview without executingdefault: true
file_pathstringAbsolute path to the image file (PNG/JPG/GIF)
tenant_idstringFirebase tenant UID
advertiser_idintegerGAM Advertiser ID
destination_urlvalueClick-through destination URL
confirmation_tokenvalueToken from dry_run=True call
third_party_impression_tracking_urlsvalueThird-party impression pixel URLs (IAS, MOAT, DoubleVerify, DCM Floodlight). Native GAM field — stored on the creative, not injected in HTML. Supports GAM macros: %%CACHEBUSTER%%, %%SITE%%, %%CLICK_URL_ESC%%, etc.
create_html5_creative_from_filesCreate an Html5Creative in GAM from individual files or a pre-built ZIP bundle. Accepts either: - A pre-built ZIP bundle via zip_path, OR - Individual files: html_path (required) + optional css_path + optional image_path When individual files are provided, they are automatical...12 params
Create an Html5Creative in GAM from individual files or a pre-built ZIP bundle. Accepts either: - A pre-built ZIP bundle via zip_path, OR - Individual files: html_path (required) + optional css_path + optional image_path When individual files are provided, they are automatical...
Parameters* required
namestringCreative display name in GAM
widthintegerCreative width in pixels (e.g. 300)
heightintegerCreative height in pixels (e.g. 250)
dry_runbooleanIf True (default), returns preview without executingdefault: true
css_pathvalueAbsolute path to the CSS file (optional)
zip_pathvalueAbsolute path to a pre-built HTML5 ZIP bundle
html_pathvalueAbsolute path to the main HTML file
tenant_idstringFirebase tenant UID
image_pathvalueAbsolute path to the image asset (optional)
advertiser_idintegerGAM Advertiser ID
destination_urlvalueClick-through destination URL
confirmation_tokenvalueToken from dry_run=True call
ensure_classic_native_templateEnsure the Classic Native Template exists for this tenant, creating it if needed. The Classic Native Template is a USER_DEFINED native GAM template with 7 variable slots: - headline (STRING, required) - click_url (URL, required) - main_image (ASSET/IMAGE, required) - body (STR...2 params
Ensure the Classic Native Template exists for this tenant, creating it if needed. The Classic Native Template is a USER_DEFINED native GAM template with 7 variable slots: - headline (STRING, required) - click_url (URL, required) - main_image (ASSET/IMAGE, required) - body (STR...
Parameters* required
tenant_idstringFirebase tenant UID
force_recreatebooleanIf True, create a fresh template even if one is already cacheddefault: false
create_classic_native_creativeCreate a Classic Native creative in GAM (TemplateCreative over the Classic Native Template). This creative type combines a headline, body text, CTA, a main image, and an optional logo into a native ad that renders using the per-tenant Classic Native Template. The Classic Nativ...15 params
Create a Classic Native creative in GAM (TemplateCreative over the Classic Native Template). This creative type combines a headline, body text, CTA, a main image, and an optional logo into a native ad that renders using the per-tenant Classic Native Template. The Classic Nativ...
Parameters* required
bodyvalueAd body / description text (optional)
namestringCreative display name in GAM
widthintegerCreative width in pixels (e.g. 300)default: 300
heightintegerCreative height in pixels (e.g. 250)default: 250
dry_runbooleanIf True (default), returns preview without executingdefault: true
headlinestringAd headline text (required)
click_urlstringDestination URL when the ad is clicked (required)
logo_pathvalueAbsolute path to the logo image (optional)
tenant_idstringFirebase tenant UID
sponsored_byvalueSponsor label, e.g. 'Acme Corp' (optional)
advertiser_idintegerGAM Advertiser ID
call_to_actionvalueCTA label, e.g. 'En savoir plus' (optional)
destination_urlvalueClick-through URL at the creative level (defaults to click_url)
main_image_pathstringAbsolute path to the main ad image (PNG/JPG/GIF, required)
confirmation_tokenvalueToken from dry_run=True call
list_creative_templatesList CreativeTemplates in the GAM network with their variable definitions. Returns all USER_DEFINED templates, with full variable metadata per template (label, uniqueName, isRequired, type, defaultValue/mimeTypes).4 params
List CreativeTemplates in the GAM network with their variable definitions. Returns all USER_DEFINED templates, with full variable metadata per template (label, uniqueName, isRequired, type, defaultValue/mimeTypes).
Parameters* required
limitintegerMax number of templates to return (max 500)default: 500
offsetintegerPagination offsetdefault: 0
tenant_idstringFirebase tenant UID
name_filtervalueOptional substring filter on template name
get_creative_templateFetch a single CreativeTemplate by ID with all variable definitions and snippet. Returns full template details including all variable slots with their types, default values, required flags, and the raw HTML snippet if present.2 params
Fetch a single CreativeTemplate by ID with all variable definitions and snippet. Returns full template details including all variable slots with their types, default values, required flags, and the raw HTML snippet if present.
Parameters* required
tenant_idstringFirebase tenant UID
template_idintegerGAM CreativeTemplate ID
check_delivery_statusCheck the real-time delivery status of a job's line items. Returns the aggregated lifecycle status (DELIVERING, READY, etc.) and per-line-item statuses.2 params
Check the real-time delivery status of a job's line items. Returns the aggregated lifecycle status (DELIVERING, READY, etc.) and per-line-item statuses.
Parameters* required
job_idstringFirestore job document ID
tenant_idstringFirebase tenant UID
fetch_delivery_reportFetch a delivery report for the job (Impressions, Clicks, CTR). Returns a list of rows (one per Line Item). Uses Firestore cache when available.2 params
Fetch a delivery report for the job (Impressions, Clicks, CTR). Returns a list of rows (one per Line Item). Uses Firestore cache when available.
Parameters* required
job_idstringtenant_idstringrun_custom_reportRun a dynamic GAM report with any dimensions and metrics. Costs 0.5 credits. Submits the report job to GAM REST v1 (or SOAP if api='soap'), polls until ready (up to ~100 seconds), then caches and returns results. Response structure: - rows: first 200 rows inline - totalRows: t...8 params
Run a dynamic GAM report with any dimensions and metrics. Costs 0.5 credits. Submits the report job to GAM REST v1 (or SOAP if api='soap'), polls until ready (up to ~100 seconds), then caches and returns results. Response structure: - rows: first 200 rows inline - totalRows: t...
Parameters* required
apistringReporting API to use: 'rest' (Interactive Reports, default) or 'soap' (Legacy Reports). REST supports fewer dimensions/metrics but is the modern API. SOAP supports all legacy dimensions (TOTAL_*, MONTH_AND_YEAR, etc.) but will be deprecated.default: rest
filtersvalueOptional dimension filters. Same format as create_gam_report. Each entry: {"dimension": "DIM_NAME", "values": ["val1", ...]}. Example: [{"dimension": "LINE_ITEM_ID", "values": ["123"]}, {"dimension": "COUNTRY_NAME", "values": ["France", "Germany"]}]
metricsarrayGAM report metrics — any valid string accepted by the API. Common values: AD_SERVER_IMPRESSIONS, AD_SERVER_CLICKS, AD_SERVER_CTR, AD_SERVER_CPM_AND_CPC_REVENUE, TOTAL_FILL_RATE, AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE, TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE. Call get_report_metrics for the full catalogue with categories.
end_datestringYYYY-MM-DD — required only when date_range_type=FIXEDdefault:
tenant_idstringFirebase tenant UID
dimensionsarrayGAM report dimensions — any valid string accepted by the API. Common values: DATE, LINE_ITEM_NAME, AD_UNIT_NAME, ADVERTISER_NAME, ORDER_NAME, COUNTRY_NAME, DEVICE_CATEGORY_NAME, PLACEMENT_NAME, CREATIVE_SIZE, BROWSER_NAME. Call get_report_dimensions for the full catalogue with categories.
start_datestringYYYY-MM-DD — required only when date_range_type=FIXEDdefault:
date_range_typestringDate range: LAST_MONTH (default), LAST_WEEK, LAST_7_DAYS, LAST_30_DAYS, YESTERDAY, TODAY, CURRENT_MONTH, CURRENT_QUARTER, LAST_3_MONTHS, LAST_YEAR, or FIXED (requires start_date + end_date).default: LAST_MONTH
fetch_inventory_reportFetch an inventory report: ad requests, impressions, fill rate per ad unit. Costs 0.5 credits. Defaults to LAST_MONTH if no dates are provided.5 params
Fetch an inventory report: ad requests, impressions, fill rate per ad unit. Costs 0.5 credits. Defaults to LAST_MONTH if no dates are provided.
Parameters* required
apistringReporting API to use: 'rest' (Interactive Reports, default) or 'soap' (Legacy Reports). REST supports fewer dimensions/metrics but is the modern API. SOAP supports all legacy dimensions (TOTAL_*, MONTH_AND_YEAR, etc.) but will be deprecated.default: rest
end_datestringYYYY-MM-DD (omit to use LAST_MONTH)default:
tenant_idstringFirebase tenant UID
ad_unit_idvalueOptional GAM Ad Unit ID to filter by
start_datestringYYYY-MM-DD (omit to use LAST_MONTH)default:
get_report_resultRetrieve a previously cached report result without re-running the report. Free tool — no credit cost. Results expire after 30 days. Returns the full result including ALL rows, summary totals, metadata, and the GAM API resource reference (gamResultRef).2 params
Retrieve a previously cached report result without re-running the report. Free tool — no credit cost. Results expire after 30 days. Returns the full result including ALL rows, summary totals, metadata, and the GAM API resource reference (gamResultRef).
Parameters* required
result_idstringResult UUID returned by run_custom_report or run_report_from_template. Cached for 30 days.
tenant_idstringFirebase tenant UID
export_report_csvExport a report as CSV, TSV, XLSX, or XML. Costs 0.5 credits. Uses FIXED date range. For api='rest': returns {csv, rowCount, resultId}. Always CSV format. For api='soap' with text formats (CSV_DUMP, TSV, TSV_EXCEL): returns {csv, rowCount}. CSV string with appropriate delimite...8 params
Export a report as CSV, TSV, XLSX, or XML. Costs 0.5 credits. Uses FIXED date range. For api='rest': returns {csv, rowCount, resultId}. Always CSV format. For api='soap' with text formats (CSV_DUMP, TSV, TSV_EXCEL): returns {csv, rowCount}. CSV string with appropriate delimite...
Parameters* required
apistringReporting API to use: 'rest' (default) or 'soap'. REST returns CSV from JSON rows. SOAP supports native export formats (see export_format).default: rest
filtersvalueOptional dimension filters. Same format as run_custom_report. Each entry: {"dimension": "DIM_NAME", "values": ["val1", ...]}.
metricsarrayGAM metric names
end_datestringYYYY-MM-DD
tenant_idstringFirebase tenant UID
dimensionsarrayGAM dimension names
start_datestringYYYY-MM-DD
export_formatstringExport format (SOAP only, ignored for REST). Options: CSV_DUMP (default) — machine-readable CSV | TSV — tab-separated values | TSV_EXCEL — TSV formatted for Excel | XLSX — Excel 2007+ binary (returned as base64) | XML — structured XML (returned as base64)default: CSV_DUMP
get_report_dimensionsList all documented GAM report dimensions with category and description. Returns list of {name, category, description, api}. Any valid GAM dimension string can be used in run_custom_report even if not listed here. Categories: time, line_item, order, advertiser, creative, inven...1 params
List all documented GAM report dimensions with category and description. Returns list of {name, category, description, api}. Any valid GAM dimension string can be used in run_custom_report even if not listed here. Categories: time, line_item, order, advertiser, creative, inven...
Parameters* required
apistringFilter by API: 'rest', 'soap', or 'all' (default)default: all
get_report_metricsList all documented GAM report metrics with category and description. Returns list of {name, category, description, api}. Any valid GAM metric string can be used in run_custom_report even if not listed here. Categories: ad_server, viewability, inventory, total, adsense, adx, p...1 params
List all documented GAM report metrics with category and description. Returns list of {name, category, description, api}. Any valid GAM metric string can be used in run_custom_report even if not listed here. Categories: ad_server, viewability, inventory, total, adsense, adx, p...
Parameters* required
apistringFilter by API: 'rest', 'soap', or 'all' (default)default: all
get_report_date_rangesList supported relative date range values for date_range_type parameter.
List supported relative date range values for date_range_type parameter.
No parameter schema in public metadata yet.
get_standalone_forecastGet an availability forecast for arbitrary targeting without an existing job. Returns: availableUnits, matchedUnits, deliveredUnits, utilizationPercent, contendingLineItems, recommendation (with riskLevel).8 params
Get an availability forecast for arbitrary targeting without an existing job. Returns: availableUnits, matchedUnits, deliveredUnits, utilizationPercent, contendingLineItems, recommendation (with riskLevel).
Parameters* required
end_datestringForecast end datetime (ISO)
tenant_idstringFirebase tenant UID
key_valuesvalueCustom targeting key-values [{keyId: int, valueIds: [int]}]
start_datestringForecast start datetime (ISO)
ad_unit_idsarrayTarget Ad Unit IDs (array)
geo_targetingvalueGAM geo location IDs e.g. ['2840'] for USA
creative_sizesvalueDisplay banner sizes [{width, height}]. None = 1x1 NATIVE (default). Required for accurate display forecast.
primary_goal_unitsvalueOptional impression goal for recommendation
get_delivery_forecast_by_line_itemGet an availability forecast for an existing Line Item. Returns: availableUnits, forecastUnits, possibleUnits, unitType, lineItemId.2 params
Get an availability forecast for an existing Line Item. Returns: availableUnits, forecastUnits, possibleUnits, unitType, lineItemId.
Parameters* required
tenant_idstringFirebase tenant UID
line_item_idstringGAM Line Item ID
list_report_templatesList all saved report templates (built-in + custom). Built-in templates are seeded on first call: - GAM: monthly performance, by advertiser, inventory, viewability - GA4: monthly traffic, performance by country (if GA4 configured) Use run_report_from_template with any template...1 params
List all saved report templates (built-in + custom). Built-in templates are seeded on first call: - GAM: monthly performance, by advertiser, inventory, viewability - GA4: monthly traffic, performance by country (if GA4 configured) Use run_report_from_template with any template...
Parameters* required
tenant_idstringFirebase tenant UID
OrbiAds — Google Ad Manager MCP
A skill for Claude, ChatGPT, Gemini, and OpenAI Codex that gives your AI assistant direct access to Google Ad Manager.
→ Get started free at orbiads.com · ★ Star this repo
Two Ways to Connect
OrbiAds offers two integration methods — choose the one that fits your workflow.
Option A: MCP Server (AI agents)
Connect your AI assistant (Claude, ChatGPT, Gemini) to GAM via the hosted MCP endpoint. Conversational, guided, zero-install.
MCP endpoint: https://orbiads.com/mcp
Option B: CLI (terminal & scripts)
A lightweight Python CLI for developers, CI/CD pipelines, and headless automation. Same API, same credits, same guardrails.
pip install orbiads-cli
orbiads auth login
orbiads network info
Comparison
| Criteria | MCP Server | CLI |
|---|---|---|
| Interface | AI agent (Claude, ChatGPT, Gemini) | Terminal / command line |
| Installation | URL to paste into agent settings | pip install orbiads-cli |
| Authentication | OAuth via browser (automatic) | OAuth Device Flow (code displayed) |
| Best for | Exploration, conversations, guided workflows | Scripts, CI/CD, headless automation |
| Output format | Natural language via the agent | JSON or structured table |
| Credits | Same consumption grid | Same consumption grid |
| Offline | No — requires internet | No — requires internet |
| Python required | No | Yes (3.10+) |
Both methods share the same backend, credits, and safety guardrails.
CLI Quick Reference
| Command | Description |
|---|---|
orbiads auth login | Authenticate via Google OAuth Device Flow |
orbiads auth status | Check authentication status |
orbiads network info | Show current GAM network details |
orbiads network list | List accessible GAM networks |
orbiads orders list | List orders in the network |
orbiads line-items list --order ID | List line items for an order |
orbiads creatives list | List creatives |
orbiads inventory ad-units | List ad units |
orbiads forecast check --ad-unit ID | Check inventory availability |
orbiads report run --template ID | Run a delivery report |
Full command reference: orbiads.com/docs/cli/commands
Installation Guide
OrbiAds offers three integration pathways depending on your environment.
1. Zero-Install MCP Server (ChatGPT, Gemini, Claude Desktop)
Connect your AI assistant to our hosted server using the Model Context Protocol:
- Claude Desktop: Add this to your
claude_desktop_config.json:{ "mcpServers": { "orbiads": { "type": "http", "url": "https://orbiads.com/mcp" } } } - Gemini / AI Studio: Go to Tools → MCP configuration → Add
https://orbiads.com/mcp - ChatGPT: Go to Settings → Connectors → Add connector → MCP URL:
https://orbiads.com/mcp - GLAMA / MCP Registry: Access, test, and connect the server directly in your browser via glama.ai/mcp/servers/OrbiAds/Orbiads-GAM-MCP
- Other environments (Cursor, Codex, Warp): Add the
https://orbiads.com/mcpendpoint to your configuration and copyAGENTS.mdto your project root.
2. Claude Code Plugin (Slash Commands)
Add the /adops command set directly into your Claude Code CLI terminal:
claude plugin install orbiads
3. Agent Skills (Structured Workflows)
Install our markdown-based guidelines permanently into Claude Code's memory:
- Clone this repository locally.
- Run the skill installer:
./install.sh skills --copy
This copies our 6 consolidated skill files to your ~/.claude/skills/ directory. Claude Code will automatically leverage them to prevent hallucinations and strictly apply the preview-to-execute workflow.
→ Installation guides: Claude · ChatGPT · Gemini · OpenAI Codex
What is OrbiAds?
OrbiAds is a hosted MCP server that connects your AI assistant directly to Google Ad Manager (GAM). Instead of clicking through the GAM interface or writing API scripts, you describe what you want in plain language — OrbiAds handles the API calls, guardrails, and audit trail.
You: "Check inventory availability on the homepage banner for a 300x250 in France next week"
OrbiAds: [runs forecast] → Available: 1.2M impressions. Pressure: low. Safe to traffic.
You: "Create the line item for Renault, €15 CPM, Monday to Friday"
OrbiAds: [applies guardrails] → Preview ready. Confirm to push?
No scripts. No API tokens to manage. No switching tabs.
Who is this for?
- AdOps managers who traffic campaigns daily and want to move faster without making mistakes
- Publishers who manage their own GAM network and want AI-assisted workflows
- Media agencies running multiple GAM accounts who want a consistent, auditable process
- Developers building AdOps automation on top of Claude, ChatGPT, or Gemini
Supported AI Platforms
| Platform | Setup guide | Mode |
|---|---|---|
| Claude (Desktop / claude.ai / Claude Code) | docs/install/claude.md | Plugin + MCP remote |
| ChatGPT (Pro connector) | docs/install/chatgpt.md | MCP remote (HTTP) |
| Gemini | docs/install/gemini.md | MCP remote |
| GLAMA (MCP registry) | glama.ai/mcp/servers/OrbiAds/Orbiads-GAM-MCP | MCP registry |
| Cursor / Codex / Warp / other | AGENTS.md | AGENTS.md + MCP wiring |
All platforms connect to the same hosted MCP endpoint at https://orbiads.com/mcp.
5 Slash Commands
After installing the plugin, these /adops commands are available directly in Claude Code.
| Command | What it does |
|---|---|
/adops campaign | Deploy, preview, pause, rollback — with mandatory forecast gate before any write |
/adops audit | Multi-dimensional account audit: delivery, inventory, security, creatives, billing |
/adops report | Custom reports, delivery queries, CSV export, billing summaries, forecasts |
/adops deal | PMP deals, private auctions, Marketplace PG/PD proposals |
/adops creative | Upload creatives, QA compliance, SSL validation, preview URLs, line item association |
What's Inside (MCP Tools & Skills)
The OrbiAds surface maps the Google Ad Manager API into 28 parent tools and 270+ actions, consolidated into 6 core Agent Skills to keep context usage clean.
Click on any domain below to see which tools and capabilities are included:
1. Campaigns & Creative QA (orbiads-campaigns)
campaign— Create, update, pause, and rollback campaigns.orders— Create and list orders, contacts, and roles.line_items— Define line item delivery rules, CPMs, and targeting logic.creatives— Upload creatives (images, HTML5, video/audio) and configure native styles.creative_assets— Manage associated image and file assets.creative_qa— Audit click-trackers, perform compliance scans, and validate SSL certificates.creative_wrapper_skill— Manage third-party wrappers and delivery presets.formats— Discover and configure ad creative formats.jobs&gam_jobs— Monitor async campaign compilation and deployment workflows.
2. Inventory & Targeting (orbiads-inventory)
inventory— Retrieve ad unit trees, sizes, and generate ads.json manifests.placements— Create, update, and list ad placement groups.targeting— Manage custom targeting keys/values, countries, and categories.audiences— Retrieve and modify first-party audience segments.blueprint— Generate and push structured network inventory blueprints.
3. Reporting & Forecasting (orbiads-reporting)
reporting— Run custom reports from templates, check line item delivery, and integrate GA4.preview— Verify inventory coverage and export preview URLs.pql— Run raw PQL database queries.
4. Programmatic Deals (orbiads-deals)
deals— Manage PMP deals, private auctions, and marketplace buyers.companies— Manage agency and advertiser company profiles.
5. Network Admin (orbiads-admin)
gam_admin— Access advanced fields, network labels, teams, and site records.gam_features— Query active Google Ad Manager beta and system features.network— List accessible networks and switch active network context.settings— Configure default CPMs, pacing, and brand naming templates.tenant_catalog— Access tenant-specific catalogs.
6. Audits & Billing (orbiads-audit)
audit_skill— Run automated security, hygiene, and wrapper coverage audits.billing— Fetch credit balances and transaction histories.audit— Search network audit logs.
See
docs/tool-matrix/README.mdfor the complete parity matrix detailing exact costs, writes, and parameters for all 270+ actions.
Safety by Design
Every write action requires explicit confirmation. No campaign goes live by accident.
- Dry-run mode on all deployment actions — preview before you push
- Forecast gate before inventory commits — availability verified upfront
- Audit trail on every action — who did what, when, with what result
- Credit guard — read operations are always free, writes deduct credits transparently
Quick Start (3 steps)
1. Create your free account
Go to orbiads.com and sign up. You get 5 free credits — no credit card required.
2. Connect Google Ad Manager
From the OrbiAds dashboard, click Connect GAM and authorize with your Google account. OrbiAds uses OAuth — your GAM credentials never leave Google's infrastructure.
3. Configure your AI assistant
Pick your platform and follow the guide:
Then start with:
"Connect to my GAM account and show me my active networks"
MCP Server Details
| Property | Value |
|---|---|
| Endpoint | https://orbiads.com/mcp |
| Transport | streamable-http (default) · sse |
| Auth | OAuth 2.0 — Google account via OrbiAds |
| GAM API version | v202605 |
| MCP Protocol | 2025-03-26 |
Repository Structure
skills/ ← 27 parent-tool sub-skills + orchestrator (generated from backend)
commands/ ← 5 /adops slash commands for Claude Code
agents/ ← Parallel audit subagents (audit-delivery, audit-inventory, …)
hooks/ ← Claude Code hooks (hooks.json)
cli/ ← OrbiAds CLI package (pip install orbiads-cli)
docs/ ← Installation guides, tool matrix, query library
_docs/ ← Internal: legacy tool mapping, anti-collision rules
.claude-plugin/ ← Claude plugin manifest (plugin.json, marketplace.json)
AGENTS.md ← Cross-LLM contract for Cursor, Codex, Gemini, Warp, etc.
CLAUDE.md ← Claude Code project guidance
Skills and the tool matrix are generated from the backend catalogue — do not hand-edit them. See
CLAUDE.mdfor the generated vs. hand-authored breakdown.
Pricing
| Plan | Price | Credits |
|---|---|---|
| Trial | Free | 5 credits (no card) |
| Starter | €39/month | 50 credits/month |
| Early Access | €29/month ← locked for life | 50 credits/month |
| Pack S | €29 one-time | +50 credits |
| Pack L | €45 one-time | +100 credits |
Reads are always free. Credits are only consumed on write and deploy operations.
License
The contents of this repository — distribution scaffold, skills, agents, workflows, JSON schemas, CLI client, platform integration manifests, documentation, and examples — are released under the MIT License.
The OrbiAds MCP server backend and Cloud Run services that the hosted endpoint at https://orbiads.com/mcp connects to are NOT in this repository and are governed by separate proprietary terms — see terms at orbiads.com.
Featured
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →Registryactive
TransportHTTP
UpdatedJun 8, 2026
