Skip to main content
Feedback

OpenAI Ads walkthrough

Updated 
info

This connector is currently in Early Access. Contact support for details.

Prerequisite

An established OpenAI Ads connection.

Step 1: Set up the data source

  1. Navigate to the Data Integration console.
  2. Select Create, then select Data Flow.
  3. Select OpenAI Ads as the data source.
  4. Under Source Connection, select an existing OpenAI Ads connection from the dropdown, or select Add New to create one. See OpenAI Ads connection for setup steps.
  5. Select Test Connection to confirm Data Integration can authenticate and reach your OpenAI Ads account.
  6. Select Next.
note

The Ad Groups, Ads, and Conversions Insights reports require you to select one or more campaigns when you configure those reports, later in this walkthrough. All other reports are account-wide and don't require a selection.

Step 2: Select a data target

  1. Select the destination you want to load OpenAI Ads data into, then select Next.

    note

    Data Integration labels some destinations Alpha or Beta. Review that destination's documentation before you use it in a production data flow.

  2. Under Target Connection, select an existing connection from the dropdown, or select Add New to create one.

  3. Select Test Connection to confirm Data Integration can authenticate and reach your destination.

  4. Under Data Loading Settings, select the required fields for your destination, such as Schema. Select the refresh icon next to a field to reload its list of values. Expand Advanced Settings for additional options specific to your destination.

  5. Select Next.

Step 3: Configure the schema

  1. On the Tables Definitions screen, Data Integration lists every OpenAI Ads report available to sync. See OpenAI Ads predefined reports for what each report returns.

  2. Select the checkbox next to each report you want to sync. Use Search Reports to find a specific report, or use the Selected and All toggles to switch between views.

  3. For each selected report, review its Target Table, Extract Method, and Loading Mode.

  4. For the Ad Groups, Ads, and Conversions Insights reports, select the Campaigns parameter and choose the campaigns to sync. These reports fan out over the selected campaigns and return no rows if no campaigns are selected.

    note

    The campaigns list is populated from your ad account. If the list is empty, confirm your API key has access to the ad account and that at least one campaign exists.

  5. For the four Insights reports, optionally set a Time Range to scope the pull to a specific date window. Leave it empty to pull the widest window the API allows. You can also adjust Time Granularity, select a Breakdown Segment, and choose which Metrics & Fields columns to return.

  6. Optional: select Extraction Mode, then look for additional options such as a Table Prefix for target table names.

  7. If you change report parameters after this step, select Reload Reports Metadata to refresh the list of available reports.

  8. Select Next.

Step 4: Set the schedule and settings

  1. Turn on Schedule Data Flow and set how often you want the data flow to run. Data Integration displays and runs schedules in UTC.
  2. Optional: turn on Set Custom Timeout to set a fixed run timeout. By default, Data Integration handles the run automatically per run, based on table size, capped between 12 hours and up to 7 days.
  3. Optional: under Notifications, turn on Failure, Warning, or Run Threshold, and enter one or more email addresses, separated by commas, to receive alerts.
  4. Under Data Flow Info, enter a Data Flow Name. Data Integration suggests a default name based on your source and target connections and the current date and time. Optionally select a Group and enter a Description.
  5. Select Activate to save the data flow and start running it on its schedule.
On this Page