oursprivacy-ingest 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd38e89b007d984d0ba3b91357e4c3e46d2123e30f152907df2ef3812922215
-  data.tar.gz: 1591b9e963faa4d9e02a3a836436e6542c75f19ba2dc39f5474f05bca93a77e9
+  metadata.gz: 5b37fe59b66fe28fc56f5e19dc9b6440478ddbb90f387e9b618f2aade2a2e281
+  data.tar.gz: f1015c560142fd14deb6c9892b5349ea3c062da30610dd7fb56387abb59a309a
 SHA512:
-  metadata.gz: bd302a69857e0968bc6bdfd7ddc232e0f00ccd1b22c61640cfe82e50a9eaa244e9121c6aef078f14bf25c87a6add8dfa9f55910a46a76b0568efb1c6b69a0fd2
-  data.tar.gz: 06211e12d6a8ba0684315131909720e5f539773b97ebaec362101c7f5ff731e30718e2ee6b681f53bd00ecda96bd1f088d70a590056e93348daad5f926c50820
+  metadata.gz: 52e45a24efacfc15f4826b5fb696aae27c484bb1f8e507f04c70af9040707ee961862f5217b1bc8eac3e9075f71a563687d7e77e9073a2d168ce64c4c2a0b578
+  data.tar.gz: 321cb84832e867f3fa31dda24bf650f8e2b15df38775853795c1a07277e30c512abd2fdffc6087a2c17f9cc07fd958b379c784471d65a194516b1930ad95d3f3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.10.0 (2026-05-27)
+
+Full Changelog: [v1.9.0...v1.10.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.9.0...v1.10.0)
+
+### Features
+
+* **api:** api update ([3968b6e](https://github.com/with-ours/ingest-sdk-ruby/commit/3968b6e51b8ef31269c905af417dcde9c8bab383))
+
 ## 1.9.0 (2026-05-21)
 
 Full Changelog: [v1.8.0...v1.9.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.8.0...v1.9.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "oursprivacy-ingest", "~> 1.9.0"
+gem "oursprivacy-ingest", "~> 1.10.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/models/batch_create_params.rb

@@ -416,6 +416,15 @@ module OursprivacyIngest
           #   @return [Boolean, nil]
           optional :new_s, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
+          # @!attribute oppref
+          #   The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+          #   parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+          #   cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+          #   oppref_abc
+          #
+          #   @return [String, nil]
+          optional :oppref, String, nil?: true
+
           # @!attribute os_name
           #   The name of the operating system. Ex: Windows
           #
@@ -613,7 +622,7 @@ module OursprivacyIngest
           #   @return [Boolean, nil]
           optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
+          # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, oppref: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
           #   Some parameter documentations has been truncated, see
           #   {OursprivacyIngest::Models::BatchCreateParams::Event::DefaultProperties} for
           #   more details.
@@ -710,6 +719,8 @@ module OursprivacyIngest
           #
           #   @param new_s [Boolean, nil] Deprecated
           #
+          #   @param oppref [String, nil] The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL para
+          #
           #   @param os_name [String, nil] The name of the operating system. Ex: Windows
           #
           #   @param os_version [String, nil] The version of the operating system. Ex: 10.0
@@ -999,6 +1010,11 @@ module OursprivacyIngest
           #   @return [String, nil]
           optional :ndclid, String, nil?: true
 
+          # @!attribute oppref
+          #
+          #   @return [String, nil]
+          optional :oppref, String, nil?: true
+
           # @!attribute phone_number
           #
           #   @return [String, nil]
@@ -1114,7 +1130,7 @@ module OursprivacyIngest
           #   @return [String, nil]
           optional :zip, String, nil?: true
 
-          # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
+          # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
           #   Properties to set on the visitor. (optional) You can also update these
           #   properties via the identify endpoint.
           #
@@ -1196,6 +1212,8 @@ module OursprivacyIngest
           #
           #   @param ndclid [String, nil]
           #
+          #   @param oppref [String, nil]
+          #
           #   @param phone_number [String, nil]
           #
           #   @param qclid [String, nil]

data/lib/oursprivacy_ingest/models/track_event_params.rb

@@ -404,6 +404,15 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :new_s, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
+        # @!attribute oppref
+        #   The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+        #   parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+        #   cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+        #   oppref_abc
+        #
+        #   @return [String, nil]
+        optional :oppref, String, nil?: true
+
         # @!attribute os_name
         #   The name of the operating system. Ex: Windows
         #
@@ -601,7 +610,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
+        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, oppref: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
         #   Some parameter documentations has been truncated, see
         #   {OursprivacyIngest::Models::TrackEventParams::DefaultProperties} for more
         #   details.
@@ -698,6 +707,8 @@ module OursprivacyIngest
         #
         #   @param new_s [Boolean, nil] Deprecated
         #
+        #   @param oppref [String, nil] The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL para
+        #
         #   @param os_name [String, nil] The name of the operating system. Ex: Windows
         #
         #   @param os_version [String, nil] The version of the operating system. Ex: 10.0
@@ -983,6 +994,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :ndclid, String, nil?: true
 
+        # @!attribute oppref
+        #
+        #   @return [String, nil]
+        optional :oppref, String, nil?: true
+
         # @!attribute phone_number
         #
         #   @return [String, nil]
@@ -1098,7 +1114,7 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :zip, String, nil?: true
 
-        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
+        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
         #   Properties to set on the visitor. (optional) You can also update these
         #   properties via the identify endpoint.
         #
@@ -1180,6 +1196,8 @@ module OursprivacyIngest
         #
         #   @param ndclid [String, nil]
         #
+        #   @param oppref [String, nil]
+        #
         #   @param phone_number [String, nil]
         #
         #   @param qclid [String, nil]

data/lib/oursprivacy_ingest/models/visitor_upsert_params.rb

@@ -288,6 +288,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :ndclid, String, nil?: true
 
+        # @!attribute oppref
+        #
+        #   @return [String, nil]
+        optional :oppref, String, nil?: true
+
         # @!attribute phone_number
         #
         #   @return [String, nil]
@@ -403,7 +408,7 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :zip, String, nil?: true
 
-        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
+        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
         #   User properties to associate with this user. The existing user properties will
         #   be updated. And all future events will have these properties associated with
         #   them.
@@ -486,6 +491,8 @@ module OursprivacyIngest
         #
         #   @param ndclid [String, nil]
         #
+        #   @param oppref [String, nil]
+        #
         #   @param phone_number [String, nil]
         #
         #   @param qclid [String, nil]
@@ -806,6 +813,15 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :new_s, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
+        # @!attribute oppref
+        #   The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+        #   parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+        #   cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+        #   oppref_abc
+        #
+        #   @return [String, nil]
+        optional :oppref, String, nil?: true
+
         # @!attribute os_name
         #   The name of the operating system. Ex: Windows
         #
@@ -1003,7 +1019,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
+        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_id: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, oppref: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil)
         #   Some parameter documentations has been truncated, see
         #   {OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties} for more
         #   details.
@@ -1100,6 +1116,8 @@ module OursprivacyIngest
         #
         #   @param new_s [Boolean, nil] Deprecated
         #
+        #   @param oppref [String, nil] The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL para
+        #
         #   @param os_name [String, nil] The name of the operating system. Ex: Windows
         #
         #   @param os_version [String, nil] The version of the operating system. Ex: 10.0

data/lib/oursprivacy_ingest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OursprivacyIngest
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end

data/rbi/oursprivacy_ingest/models/batch_create_params.rbi

@@ -451,6 +451,13 @@ module OursprivacyIngest
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :new_s
 
+          # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+          # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+          # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+          # oppref_abc
+          sig { returns(T.nilable(String)) }
+          attr_accessor :oppref
+
           # The name of the operating system. Ex: Windows
           sig { returns(T.nilable(String)) }
           attr_accessor :os_name
@@ -632,6 +639,7 @@ module OursprivacyIngest
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
               new_s: T.nilable(T::Boolean),
+              oppref: T.nilable(String),
               os_name: T.nilable(String),
               os_version: T.nilable(String),
               page_hash: T.nilable(Float),
@@ -763,6 +771,11 @@ module OursprivacyIngest
             ndclid: nil,
             # Deprecated
             new_s: nil,
+            # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+            # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+            # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+            # oppref_abc
+            oppref: nil,
             # The name of the operating system. Ex: Windows
             os_name: nil,
             # The version of the operating system. Ex: 10.0
@@ -882,6 +895,7 @@ module OursprivacyIngest
                 msclkid: T.nilable(String),
                 ndclid: T.nilable(String),
                 new_s: T.nilable(T::Boolean),
+                oppref: T.nilable(String),
                 os_name: T.nilable(String),
                 os_version: T.nilable(String),
                 page_hash: T.nilable(Float),
@@ -1084,6 +1098,9 @@ module OursprivacyIngest
           sig { returns(T.nilable(String)) }
           attr_accessor :ndclid
 
+          sig { returns(T.nilable(String)) }
+          attr_accessor :oppref
+
           sig { returns(T.nilable(String)) }
           attr_accessor :phone_number
 
@@ -1196,6 +1213,7 @@ module OursprivacyIngest
               li_fat_id: T.nilable(String),
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
+              oppref: T.nilable(String),
               phone_number: T.nilable(String),
               qclid: T.nilable(String),
               rdt_cid: T.nilable(String),
@@ -1262,6 +1280,7 @@ module OursprivacyIngest
             li_fat_id: nil,
             msclkid: nil,
             ndclid: nil,
+            oppref: nil,
             phone_number: nil,
             qclid: nil,
             rdt_cid: nil,
@@ -1331,6 +1350,7 @@ module OursprivacyIngest
                 li_fat_id: T.nilable(String),
                 msclkid: T.nilable(String),
                 ndclid: T.nilable(String),
+                oppref: T.nilable(String),
                 phone_number: T.nilable(String),
                 qclid: T.nilable(String),
                 rdt_cid: T.nilable(String),

data/rbi/oursprivacy_ingest/models/track_event_params.rbi

@@ -401,6 +401,13 @@ module OursprivacyIngest
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :new_s
 
+        # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+        # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+        # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+        # oppref_abc
+        sig { returns(T.nilable(String)) }
+        attr_accessor :oppref
+
         # The name of the operating system. Ex: Windows
         sig { returns(T.nilable(String)) }
         attr_accessor :os_name
@@ -582,6 +589,7 @@ module OursprivacyIngest
             msclkid: T.nilable(String),
             ndclid: T.nilable(String),
             new_s: T.nilable(T::Boolean),
+            oppref: T.nilable(String),
             os_name: T.nilable(String),
             os_version: T.nilable(String),
             page_hash: T.nilable(Float),
@@ -713,6 +721,11 @@ module OursprivacyIngest
           ndclid: nil,
           # Deprecated
           new_s: nil,
+          # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+          # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+          # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+          # oppref_abc
+          oppref: nil,
           # The name of the operating system. Ex: Windows
           os_name: nil,
           # The version of the operating system. Ex: 10.0
@@ -832,6 +845,7 @@ module OursprivacyIngest
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
               new_s: T.nilable(T::Boolean),
+              oppref: T.nilable(String),
               os_name: T.nilable(String),
               os_version: T.nilable(String),
               page_hash: T.nilable(Float),
@@ -1032,6 +1046,9 @@ module OursprivacyIngest
         sig { returns(T.nilable(String)) }
         attr_accessor :ndclid
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :oppref
+
         sig { returns(T.nilable(String)) }
         attr_accessor :phone_number
 
@@ -1144,6 +1161,7 @@ module OursprivacyIngest
             li_fat_id: T.nilable(String),
             msclkid: T.nilable(String),
             ndclid: T.nilable(String),
+            oppref: T.nilable(String),
             phone_number: T.nilable(String),
             qclid: T.nilable(String),
             rdt_cid: T.nilable(String),
@@ -1210,6 +1228,7 @@ module OursprivacyIngest
           li_fat_id: nil,
           msclkid: nil,
           ndclid: nil,
+          oppref: nil,
           phone_number: nil,
           qclid: nil,
           rdt_cid: nil,
@@ -1278,6 +1297,7 @@ module OursprivacyIngest
               li_fat_id: T.nilable(String),
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
+              oppref: T.nilable(String),
               phone_number: T.nilable(String),
               qclid: T.nilable(String),
               rdt_cid: T.nilable(String),

data/rbi/oursprivacy_ingest/models/visitor_upsert_params.rbi

@@ -295,6 +295,9 @@ module OursprivacyIngest
         sig { returns(T.nilable(String)) }
         attr_accessor :ndclid
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :oppref
+
         sig { returns(T.nilable(String)) }
         attr_accessor :phone_number
 
@@ -408,6 +411,7 @@ module OursprivacyIngest
             li_fat_id: T.nilable(String),
             msclkid: T.nilable(String),
             ndclid: T.nilable(String),
+            oppref: T.nilable(String),
             phone_number: T.nilable(String),
             qclid: T.nilable(String),
             rdt_cid: T.nilable(String),
@@ -474,6 +478,7 @@ module OursprivacyIngest
           li_fat_id: nil,
           msclkid: nil,
           ndclid: nil,
+          oppref: nil,
           phone_number: nil,
           qclid: nil,
           rdt_cid: nil,
@@ -542,6 +547,7 @@ module OursprivacyIngest
               li_fat_id: T.nilable(String),
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
+              oppref: T.nilable(String),
               phone_number: T.nilable(String),
               qclid: T.nilable(String),
               rdt_cid: T.nilable(String),
@@ -765,6 +771,13 @@ module OursprivacyIngest
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :new_s
 
+        # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+        # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+        # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+        # oppref_abc
+        sig { returns(T.nilable(String)) }
+        attr_accessor :oppref
+
         # The name of the operating system. Ex: Windows
         sig { returns(T.nilable(String)) }
         attr_accessor :os_name
@@ -946,6 +959,7 @@ module OursprivacyIngest
             msclkid: T.nilable(String),
             ndclid: T.nilable(String),
             new_s: T.nilable(T::Boolean),
+            oppref: T.nilable(String),
             os_name: T.nilable(String),
             os_version: T.nilable(String),
             page_hash: T.nilable(Float),
@@ -1077,6 +1091,11 @@ module OursprivacyIngest
           ndclid: nil,
           # Deprecated
           new_s: nil,
+          # The OpenAI Ads privacy-preserving reference, captured from the `oppref` URL
+          # parameter on landing pages (the OpenAI Pixel also stores it in a `__oppref`
+          # cookie). Sent to OpenAI Ads on Conversions API events for attribution. Ex:
+          # oppref_abc
+          oppref: nil,
           # The name of the operating system. Ex: Windows
           os_name: nil,
           # The version of the operating system. Ex: 10.0
@@ -1196,6 +1215,7 @@ module OursprivacyIngest
               msclkid: T.nilable(String),
               ndclid: T.nilable(String),
               new_s: T.nilable(T::Boolean),
+              oppref: T.nilable(String),
               os_name: T.nilable(String),
               os_version: T.nilable(String),
               page_hash: T.nilable(Float),

data/sig/oursprivacy_ingest/models/batch_create_params.rbs

@@ -134,6 +134,7 @@ module OursprivacyIngest
             msclkid: String?,
             ndclid: String?,
             new_s: bool?,
+            oppref: String?,
             os_name: String?,
             os_version: String?,
             page_hash: Float?,
@@ -257,6 +258,8 @@ module OursprivacyIngest
 
           attr_accessor new_s: bool?
 
+          attr_accessor oppref: String?
+
           attr_accessor os_name: String?
 
           attr_accessor os_version: String?
@@ -366,6 +369,7 @@ module OursprivacyIngest
             ?msclkid: String?,
             ?ndclid: String?,
             ?new_s: bool?,
+            ?oppref: String?,
             ?os_name: String?,
             ?os_version: String?,
             ?page_hash: Float?,
@@ -445,6 +449,7 @@ module OursprivacyIngest
             msclkid: String?,
             ndclid: String?,
             new_s: bool?,
+            oppref: String?,
             os_name: String?,
             os_version: String?,
             page_hash: Float?,
@@ -533,6 +538,7 @@ module OursprivacyIngest
             li_fat_id: String?,
             msclkid: String?,
             ndclid: String?,
+            oppref: String?,
             phone_number: String?,
             qclid: String?,
             rdt_cid: String?,
@@ -637,6 +643,8 @@ module OursprivacyIngest
 
           attr_accessor ndclid: String?
 
+          attr_accessor oppref: String?
+
           attr_accessor phone_number: String?
 
           attr_accessor qclid: String?
@@ -723,6 +731,7 @@ module OursprivacyIngest
             ?li_fat_id: String?,
             ?msclkid: String?,
             ?ndclid: String?,
+            ?oppref: String?,
             ?phone_number: String?,
             ?qclid: String?,
             ?rdt_cid: String?,
@@ -788,6 +797,7 @@ module OursprivacyIngest
             li_fat_id: String?,
             msclkid: String?,
             ndclid: String?,
+            oppref: String?,
             phone_number: String?,
             qclid: String?,
             rdt_cid: String?,

data/sig/oursprivacy_ingest/models/track_event_params.rbs

@@ -118,6 +118,7 @@ module OursprivacyIngest
           msclkid: String?,
           ndclid: String?,
           new_s: bool?,
+          oppref: String?,
           os_name: String?,
           os_version: String?,
           page_hash: Float?,
@@ -241,6 +242,8 @@ module OursprivacyIngest
 
         attr_accessor new_s: bool?
 
+        attr_accessor oppref: String?
+
         attr_accessor os_name: String?
 
         attr_accessor os_version: String?
@@ -350,6 +353,7 @@ module OursprivacyIngest
           ?msclkid: String?,
           ?ndclid: String?,
           ?new_s: bool?,
+          ?oppref: String?,
           ?os_name: String?,
           ?os_version: String?,
           ?page_hash: Float?,
@@ -429,6 +433,7 @@ module OursprivacyIngest
           msclkid: String?,
           ndclid: String?,
           new_s: bool?,
+          oppref: String?,
           os_name: String?,
           os_version: String?,
           page_hash: Float?,
@@ -517,6 +522,7 @@ module OursprivacyIngest
           li_fat_id: String?,
           msclkid: String?,
           ndclid: String?,
+          oppref: String?,
           phone_number: String?,
           qclid: String?,
           rdt_cid: String?,
@@ -621,6 +627,8 @@ module OursprivacyIngest
 
         attr_accessor ndclid: String?
 
+        attr_accessor oppref: String?
+
         attr_accessor phone_number: String?
 
         attr_accessor qclid: String?
@@ -707,6 +715,7 @@ module OursprivacyIngest
           ?li_fat_id: String?,
           ?msclkid: String?,
           ?ndclid: String?,
+          ?oppref: String?,
           ?phone_number: String?,
           ?qclid: String?,
           ?rdt_cid: String?,
@@ -772,6 +781,7 @@ module OursprivacyIngest
           li_fat_id: String?,
           msclkid: String?,
           ndclid: String?,
+          oppref: String?,
           phone_number: String?,
           qclid: String?,
           rdt_cid: String?,

data/sig/oursprivacy_ingest/models/visitor_upsert_params.rbs

@@ -93,6 +93,7 @@ module OursprivacyIngest
           li_fat_id: String?,
           msclkid: String?,
           ndclid: String?,
+          oppref: String?,
           phone_number: String?,
           qclid: String?,
           rdt_cid: String?,
@@ -197,6 +198,8 @@ module OursprivacyIngest
 
         attr_accessor ndclid: String?
 
+        attr_accessor oppref: String?
+
         attr_accessor phone_number: String?
 
         attr_accessor qclid: String?
@@ -283,6 +286,7 @@ module OursprivacyIngest
           ?li_fat_id: String?,
           ?msclkid: String?,
           ?ndclid: String?,
+          ?oppref: String?,
           ?phone_number: String?,
           ?qclid: String?,
           ?rdt_cid: String?,
@@ -348,6 +352,7 @@ module OursprivacyIngest
           li_fat_id: String?,
           msclkid: String?,
           ndclid: String?,
+          oppref: String?,
           phone_number: String?,
           qclid: String?,
           rdt_cid: String?,
@@ -420,6 +425,7 @@ module OursprivacyIngest
           msclkid: String?,
           ndclid: String?,
           new_s: bool?,
+          oppref: String?,
           os_name: String?,
           os_version: String?,
           page_hash: Float?,
@@ -543,6 +549,8 @@ module OursprivacyIngest
 
         attr_accessor new_s: bool?
 
+        attr_accessor oppref: String?
+
         attr_accessor os_name: String?
 
         attr_accessor os_version: String?
@@ -652,6 +660,7 @@ module OursprivacyIngest
           ?msclkid: String?,
           ?ndclid: String?,
           ?new_s: bool?,
+          ?oppref: String?,
           ?os_name: String?,
           ?os_version: String?,
           ?page_hash: Float?,
@@ -731,6 +740,7 @@ module OursprivacyIngest
           msclkid: String?,
           ndclid: String?,
           new_s: bool?,
+          oppref: String?,
           os_name: String?,
           os_version: String?,
           page_hash: Float?,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oursprivacy-ingest
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Ours Privacy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-21 00:00:00.000000000 Z
+date: 2026-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi