Adds the OpenAI Ads Measurement Pixel to your site and sends the same conversions\nfrom your server through the Conversions API (CAPI), so a conversion measured in\nboth places is counted once rather than twice.<\/p>\n\n
OpenAI Ads are the ads that run in ChatGPT. If you buy them, this is how your\nsite tells OpenAI which visits turned into leads, orders or registrations - in\nthe browser, on the server, or both.<\/p>\n\n
This is an independent community integration.<\/strong> It is not created, certified,\nendorsed or supported by OpenAI. \"OpenAI\" and \"ChatGPT\" are trademarks of OpenAI.<\/p>\n\n Contact Form 7, Elementor Forms, Gravity Forms, WPForms, Fluent Forms and Ninja\nForms are detected automatically. A lead is recorded when the submission is\naccepted, never when the button is clicked. Contact Form 7 and Elementor also fire\nthe matching browser event, sharing one event id.<\/p>\n\n For ecommerce, WooCommerce<\/strong> measures product views, add to cart, checkout\nstart and paid orders. A purchase is reported only once payment is confirmed -\nnever for a pending, failed or cancelled order - and never twice, however many\ntimes the gateway or a webhook triggers it. Amounts use the currency's own minor\nunit.<\/p>\n\n Easy Digital Downloads<\/strong> reports a purchase once payment completes.\nWooCommerce Subscriptions<\/strong> reports trial_started or subscription_created.\nWordPress registration<\/strong> reports registration_completed, off by default because\nuser_register also fires for an administrator adding a colleague.<\/p>\n\n Each can be switched off under OpenAI Ads -> Integrations.<\/p>\n\n Optional, off by default. Lets Google Tag Manager hand a conversion to your site,\nwhich forwards it to OpenAI - server-side measurement without a paid GTM server\ncontainer. Protected by a generated secret.<\/p>\n\n Record a conversion at a confirmed boundary:<\/p>\n\n Also Full documentation: https:\/\/github.com\/webaroundlabs\/openai-ads-toolkit<\/p>\n\n This plugin connects to OpenAI in order to measure advertising conversions. That\nis its entire purpose, and nothing happens until you enter a Pixel ID or an API\nkey.<\/p>\n\n Three addresses, all of them OpenAI's:<\/p>\n\n There is no fourth. The plugin sends nothing to its author or to any analytics,\ntelemetry or licensing service.<\/p>\n\n When the Pixel is on, the plugin loads https:\/\/bzrcdn.openai.com\/sdk\/oaiq.min.js\ninto your pages and initializes it with your public Pixel ID. That script is\nwritten and hosted by OpenAI. It sets first-party cookies named __oppref and\n__obref to remember which advertisement a visitor arrived from.<\/p>\n\n WHAT IS SENT: the event name, a deduplication id, the page address, the amount and\ncurrency where the event carries one, and - only when your site supplies it -\nidentity as irreversible SHA-256 hashes. It runs in the visitor's browser, so their\nIP address and user agent reach OpenAI as part of the request. A commerce event\nalso carries the basket: each item's SKU or product id, name, quantity, line price\nand variation attributes. Product names are not hashed: hashing identifies a person.<\/p>\n\n WHEN: on any page view, once you have enabled the Pixel.<\/p>\n\n When server-side events are on, your server sends conversions to\nhttps:\/\/bzr.openai.com\/v1\/events using the API key you provide.<\/p>\n\n WHAT IS SENT: the same event data as above, including the basket detail, plus the\nvisitor's IP address and user agent, the two attribution values read from the\n__oppref and __obref cookies, and the page address the conversion happened on.\nEmail addresses, phone numbers, names and customer ids are hashed with SHA-256 on\nyour server before they leave it - the raw values are never transmitted.<\/p>\n\n WHEN: after a conversion your site confirms - a paid order, an accepted form\nsubmission - and never on a page view.<\/p>\n\n Only if you call openai_ads_image_tag() yourself. It requests a 1x1 image from\nhttps:\/\/bzr.openai.com\/v1\/sdk\/events, carrying the event name, the deduplication\nid and the amount - and no personal data of any kind, by design.<\/p>\n\n OpenAI's terms: https:\/\/openai.com\/policies\/\nOpenAI's privacy policy: https:\/\/openai.com\/policies\/privacy-policy\/\nAdvertising documentation: https:\/\/developers.openai.com\/ads\/<\/p>\n\n Sending a visitor's data to OpenAI is a disclosure to a third party. You are\nresponsible for saying so in your own privacy policy and for obtaining consent\nwhere the law requires it. The plugin adds suggested wording under Tools ->\nPrivacy for you to adapt.<\/p>\n\n The plugin helps rather than decides. It detects a consent plugin - the WP Consent\nAPI and Complianz are read directly - and when consent for the \"marketing\"\ncategory is refused, no Pixel is loaded and no event is constructed. If it finds\nno consent mechanism at all it measures everybody, and says so on its settings\nscreen. That default is deliberate: a plugin that silently measured nothing would\nleave you hunting for the fault.<\/p>\n\n Nothing requires editing a file. To keep credentials out of the database, define\nthem as constants in wp-config.php instead.<\/p>\n\n\n A purchase measured in the browser and again on the server is one purchase, but\ntwo reports. Both halves send one event id, so OpenAI counts one conversion.<\/p><\/dd>\n The Pixel alone works, and needs only a Pixel ID. It is also the half an ad\nblocker or a failed script can remove. The API key adds the server-side half,\nwhich nothing in the browser can block - and because the two are deduplicated,\nadding it inflates nothing.<\/p><\/dd>\nWhat it does<\/h4>\n\n
\n
Integrations<\/h4>\n\n
Tag manager endpoint<\/h4>\n\n
For developers<\/h4>\n\n
openai_ads_track( 'lead_created', [], [ 'event_id' => $lead_id, 'user' => [ 'email' => $email ] ] );\n<\/code><\/pre>\n\nopenai_ads_event_id()<\/code>, openai_ads_pixel_event()<\/code>, openai_ads_hash_user()<\/code>,\n openai_ads_image_tag() and openai_ads_is_configured()<\/code>, plus filters and actions\nfor consent, event data, identity and integrations. Every event OpenAI documents\nfor the web is supported, plus custom.<\/p>\n\nExternal services<\/h3>\n\n
Which services, and only which<\/h4>\n\n
\n
1. The OpenAI Ads Measurement Pixel<\/h4>\n\n
2. The OpenAI Ads Conversions API<\/h4>\n\n
3. The image tag<\/h4>\n\n
Terms and privacy<\/h4>\n\n
Your responsibilities<\/h4>\n\n
What is NOT sent<\/h4>\n\n
\n
\n
\n
What does deduplication actually do?<\/h3><\/dt>\n
Do I need the Conversions API key, or is the Pixel enough?<\/h3><\/dt>\n