AI Knowledge Hub
Menu

Tools Mcp / Adtech

OpenAI Ads Adapter Template

Deprecated reference contract retained for migration; use the executable OpenAI Ads API Client.

Intended access

Read only · OpenAI Ads API or local mock fixtures

Template onlyIntegration templateRequirements & limits

Intended inputs

Inputs are not documented for this release. Inspect its guide before use.

Intended outputs

Expected outputs are not documented for this release. Inspect its guide before use.

Before you begin

  • Account-scoped OpenAI Ads API credential for live bindings

Try this first

Inspect the released reference and identify the implementation and bindings to adapt before attempting execution.

This release is deprecated. Check its replacement and migration guidance in the requirements below.

Limits for this step
  • Deprecated reference contract only; no executable integration is packaged.
  • New installations and plugin references must use adtech/openai-ads-api-client.
  • Read-only by design; future writes must use the existing policy-gated ad-platform executor.
Read reference guideHide reference guideTOOL.md · v0.2.0

OpenAI Ads Adapter Template (deprecated)

Replaced by adtech/openai-ads-api-client. This document describes the old contract only so existing consumers can migrate without guessing.

Purpose

Provide a mock-first, read-only provider boundary for OpenAI Ads account, campaign, ad, insight, and product-feed data.

Proposed operations

  • get_account
  • list_campaigns
  • get_campaign
  • list_ads
  • get_campaign_insights
  • validate_product_feed

Binding rules

  1. Keep API keys in the adapter environment, never in agent context.
  2. Scope every request to the configured advertiser account.
  3. Validate responses against local contracts before returning them.
  4. Start with the fixtures in examples/.
  5. Route any future write operation through adtech/ad-platform-executor-template; do not add direct model-to-platform writes here.

Guardrails

  • Keep the adapter read-only.
  • Never expose credentials to the agent.
  • Do not infer that mock schemas match current production schemas.

Migration

  1. Replace dependency ID adtech/openai-ads-adapter-template with adtech/openai-ads-api-client.
  2. Replace direct fixture reads with the client mock commands documented in its TOOL.md.
  3. For live reads, bind OPENAI_ADS_API_KEY through the runtime-owned environment and run the packaged authentication readiness flow.
  4. Keep all campaign writes outside the client and behind the governed ad-platform executor.

The historical template must not be reactivated or treated as operational evidence for the replacement package.

Summary sources · Catalogue metadata, tool.yaml, TOOL.md · v0.2.0 · Release package

View capabilities and accessHide capabilities and accessv0.2.0

Intended capabilities

  • Read advertiser account metadata.
  • List campaigns and ads.
  • Retrieve campaign insights.
  • Validate product-feed records.

Access limits

Read-only by design; future writes must use the existing policy-gated ad-platform executor.

Trust boundary · third-party-hosted

Credentials and setup

  • Account-scoped OpenAI Ads API credential for live bindings

Reference template

Reference template

Implementation is required before the described workflow can run. Inspect and adapt the source.

How You Can Use This

Template only

Resource form: Integration template

Implementation is required before the described workflow can run. Inspect and adapt the source.

First run: Replace this package with adtech/openai-ads-api-client and follow its migration guidance.

Current limits

  • Deprecated reference contract only; no executable integration is packaged.
  • New installations and plugin references must use adtech/openai-ads-api-client.
What installation and verification mean
File installation
Places package files and generated configuration in the selected directories.
Native discovery
Your agent app finds and accepts the instructions, tools or plugin registrations.
Mock execution
Exercises sample fixtures. Connected data and provider effects need a separate check.
Connected operation
Requires current configuration, provider authentication, scoped permissions and a successful operation in your intended environment.

Declared compatibility

Compatibility unknown: versions and capabilities have not been declared.

Classification: declared

Technical details and release files

Review and lifecycle

Review maturity: Deprecated

Security review declaration: Not declared

Lifecycle: Deprecated

These release declarations are separate from evidence that a workflow operates in your environment.

Runtime & Dependencies

ID: adtech/openai-ads-adapter-template

Tags: openai-ads, adapter, read-only, campaign-insights, product-feeds

Runtimes: codex, claude, generic

Replaced by: adtech/openai-ads-api-client

Dependencies & Setup

MCP servers: Not documented

APIs: OpenAI Ads API

Local tools: secret_manager