> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/channels/open-ai-ads.md).

# Open AI Ads

Open AI Ads integration connects your Open AI Ads pixel to your website. EdgeTag sends server-side events when the required credentials are configured. You can also enable browser tracking.

### Details

Channel name: openAiAds

NPM package: [@blotoutio/providers-open-ai-ads-sdk](https://www.npmjs.com/package/@blotoutio/providers-open-ai-ads-sdk)

Server API version: v1

### Event Flow

Open AI Ads supports server-side and browser event delivery.

Server-side events are sent to the Open AI Ads Conversions API when both the **Pixel ID** and **Conversions API key** are configured.

You can also enable the browser pixel. When enabled, EdgeTag loads the Open AI Ads SDK and sends events from the browser.

When both flows are active, EdgeTag sends the same event ID in each request. Open AI Ads then deduplicates matching events.

Custom events generated dynamically by EdgeTag are server-side only.

Open AI click attribution uses the `oppref` value. EdgeTag resolves it from the `__oppref` cookie first. It then falls back to the `?oppref=` URL parameter.

{% hint style="info" %}
The browser pixel is optional and disabled by default. If you leave it off, events are delivered server-side only.
{% endhint %}

### Supported Events

| Standard event             | Open AI Ads event type   |
| -------------------------- | ------------------------ |
| Purchase                   | `order_created`          |
| AddToCart                  | `items_added`            |
| ViewContent                | `contents_viewed`        |
| InitiateCheckout           | `checkout_started`       |
| Lead                       | `lead_created`           |
| PageView                   | `page_viewed`            |
| CompleteRegistration       | `registration_completed` |
| Schedule / BookAppointment | `appointment_scheduled`  |
| Subscribe                  | `subscription_created`   |
| StartTrial                 | `trial_started`          |
| Custom                     | `custom`                 |

{% hint style="warning" %}
Create the conversion events in Open AI Ads before you use them in ad campaigns.
{% endhint %}

### Useful Links

{% embed url="<https://ads.openai.com/>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.edgetag.io/channels/open-ai-ads.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
