oursprivacy-ingest 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd38e89b007d984d0ba3b91357e4c3e46d2123e30f152907df2ef3812922215
-  data.tar.gz: 1591b9e963faa4d9e02a3a836436e6542c75f19ba2dc39f5474f05bca93a77e9
+  metadata.gz: abb94e2f78437ee3c959514e37490b858072ffc3f5fe8815e67c5d82d4a8981b
+  data.tar.gz: c5b94c84af1db233a51d17684e5e4c210e63beda3477c2e38ea157c3baa0a038
 SHA512:
-  metadata.gz: bd302a69857e0968bc6bdfd7ddc232e0f00ccd1b22c61640cfe82e50a9eaa244e9121c6aef078f14bf25c87a6add8dfa9f55910a46a76b0568efb1c6b69a0fd2
-  data.tar.gz: 06211e12d6a8ba0684315131909720e5f539773b97ebaec362101c7f5ff731e30718e2ee6b681f53bd00ecda96bd1f088d70a590056e93348daad5f926c50820
+  metadata.gz: 4c74d7e70b9b7d618e1acd348aae432adc4b95ad8efffd1eaf7f2bce3f5a7bbac4cbb2929cb35f7d26d7ba118bb392cc853d9f5e42e8ed699ad94a3f6b629d27
+  data.tar.gz: 2f0153bad01e49db6f65d1e10443a35b8e642b975436285937339841d5b1726a4d4100b53908cc982604d9b1b0ae1b157baaa0d715b962b89d63fd5df6b32da0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.11.0 (2026-05-28)
+
+Full Changelog: [v1.10.0...v1.11.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.10.0...v1.11.0)
+
+### Features
+
+* **api:** api update ([1836d36](https://github.com/with-ours/ingest-sdk-ruby/commit/1836d362919dea15c8bd5912d54a958a0ee34610))
+
+## 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.11.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/client.rb

@@ -24,6 +24,9 @@ module OursprivacyIngest
     # @return [OursprivacyIngest::Resources::Visitor]
     attr_reader :visitor
 
+    # @return [OursprivacyIngest::Resources::Experiments]
+    attr_reader :experiments
+
     # @api private
     #
     # @return [Boolean]
@@ -77,6 +80,7 @@ module OursprivacyIngest
       @batch = OursprivacyIngest::Resources::Batch.new(client: self)
       @track = OursprivacyIngest::Resources::Track.new(client: self)
       @visitor = OursprivacyIngest::Resources::Visitor.new(client: self)
+      @experiments = OursprivacyIngest::Resources::Experiments.new(client: self)
     end
   end
 end

data/lib/oursprivacy_ingest/internal/type/union.rb

@@ -4,6 +4,17 @@ module OursprivacyIngest
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `experiment_assignment_response` is a `OursprivacyIngest::Models::ExperimentAssignmentResponse`
+      #   case experiment_assignment_response
+      #   when OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0
+      #     puts(experiment_assignment_response.experiment_id)
+      #   when OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1
+      #     puts(experiment_assignment_response.in_experiment)
+      #   else
+      #     puts(experiment_assignment_response)
+      #   end
       module Union
         include OursprivacyIngest::Internal::Type::Converter
         include OursprivacyIngest::Internal::Util::SorbetRuntimeSupport

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/experiment_assignment_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#assignment
+    class ExperimentAssignmentParams < OursprivacyIngest::Internal::Type::BaseModel
+      extend OursprivacyIngest::Internal::Type::RequestParameters::Converter
+      include OursprivacyIngest::Internal::Type::RequestParameters
+
+      # @!attribute experiment_key
+      #   The experiment's stable key. Surfaced in the dashboard under each experiment's
+      #   setup tab.
+      #
+      #   @return [String]
+      required :experiment_key, String
+
+      # @!attribute token
+      #   The experiment token (`exp_*`) for the experiment settings holding this
+      #   experiment. Available from the dashboard.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute visitor_id
+      #   Stable identifier for the visitor — typically the Ours visitor id from your
+      #   browser cookie, or your own server-side user id if you keep the same id
+      #   consistent across browser and server.
+      #
+      #   @return [String]
+      required :visitor_id, String
+
+      # @!attribute context
+      #   Optional page context for URL + query-param eligibility. Variant bucketing is
+      #   deterministic on `visitor_id` regardless of context.
+      #
+      #   @return [OursprivacyIngest::Models::ExperimentAssignmentParams::Context, nil]
+      optional :context, -> { OursprivacyIngest::ExperimentAssignmentParams::Context }, nil?: true
+
+      # @!attribute track_impression
+      #   When true (default), an `$experiment_impression` event is enqueued and the
+      #   visitor's `experiment_assignments` map is updated. Set to false to read the
+      #   assignment without recording an impression — useful for in-test diagnostics.
+      #
+      #   @return [Boolean, nil]
+      optional :track_impression, OursprivacyIngest::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(experiment_key:, token:, visitor_id:, context: nil, track_impression: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OursprivacyIngest::Models::ExperimentAssignmentParams} for more details.
+      #
+      #   @param experiment_key [String] The experiment's stable key. Surfaced in the dashboard under each experiment's s
+      #
+      #   @param token [String] The experiment token (`exp_*`) for the experiment settings holding this experime
+      #
+      #   @param visitor_id [String] Stable identifier for the visitor — typically the Ours visitor id from your brow
+      #
+      #   @param context [OursprivacyIngest::Models::ExperimentAssignmentParams::Context, nil] Optional page context for URL + query-param eligibility. Variant bucketing is de
+      #
+      #   @param track_impression [Boolean, nil] When true (default), an `$experiment_impression` event is enqueued and the visit
+      #
+      #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
+
+      class Context < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute search
+        #   The current query string (e.g. `?utm_source=meta`). When provided, the
+        #   experiment's query-param conditions are evaluated for eligibility. If omitted,
+        #   the query string is parsed from `url`.
+        #
+        #   @return [String, nil]
+        optional :search, String, nil?: true
+
+        # @!attribute url
+        #   The current page URL. When provided, the experiment's URL patterns are evaluated
+        #   for eligibility — visitors on non-matching URLs are returned
+        #   `in_experiment: false`. Omit when the caller is pre-gating the request.
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(search: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OursprivacyIngest::Models::ExperimentAssignmentParams::Context} for more
+        #   details.
+        #
+        #   Optional page context for URL + query-param eligibility. Variant bucketing is
+        #   deterministic on `visitor_id` regardless of context.
+        #
+        #   @param search [String, nil] The current query string (e.g. `?utm_source=meta`). When provided, the experimen
+        #
+        #   @param url [String, nil] The current page URL. When provided, the experiment's URL patterns are evaluated
+      end
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_assignment_response.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#assignment
+    module ExperimentAssignmentResponse
+      extend OursprivacyIngest::Internal::Type::Union
+
+      variant -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0 }
+
+      variant -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1 }
+
+      class UnionMember0 < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute experiment_id
+        #
+        #   @return [String]
+        required :experiment_id, String
+
+        # @!attribute in_experiment
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment]
+        required :in_experiment,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success]
+        required :success,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success }
+
+        # @!attribute variant_id
+        #
+        #   @return [String]
+        required :variant_id, String
+
+        # @!attribute experiment_key
+        #
+        #   @return [String, nil]
+        optional :experiment_key, String, nil?: true
+
+        # @!attribute experiment_name
+        #
+        #   @return [String, nil]
+        optional :experiment_name, String, nil?: true
+
+        # @!attribute is_control
+        #
+        #   @return [Boolean, nil]
+        optional :is_control, OursprivacyIngest::Internal::Type::Boolean, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String, nil?: true
+
+        # @!attribute variant_name
+        #
+        #   @return [String, nil]
+        optional :variant_name, String, nil?: true
+
+        # @!method initialize(experiment_id:, in_experiment:, success:, variant_id:, experiment_key: nil, experiment_name: nil, is_control: nil, type: nil, variant_name: nil)
+        #   @param experiment_id [String]
+        #   @param in_experiment [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment]
+        #   @param success [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success]
+        #   @param variant_id [String]
+        #   @param experiment_key [String, nil]
+        #   @param experiment_name [String, nil]
+        #   @param is_control [Boolean, nil]
+        #   @param type [String, nil]
+        #   @param variant_name [String, nil]
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0#in_experiment
+        module InExperiment
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0#success
+        module Success
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+      end
+
+      class UnionMember1 < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute in_experiment
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment]
+        required :in_experiment,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success]
+        required :success,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success }
+
+        # @!method initialize(in_experiment:, success:)
+        #   @param in_experiment [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment]
+        #   @param success [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success]
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1#in_experiment
+        module InExperiment
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          FALSE = false
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1#success
+        module Success
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1)]
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_personalization_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#personalization
+    class ExperimentPersonalizationParams < OursprivacyIngest::Internal::Type::BaseModel
+      extend OursprivacyIngest::Internal::Type::RequestParameters::Converter
+      include OursprivacyIngest::Internal::Type::RequestParameters
+
+      # @!attribute token
+      #   The experiment token (`exp_*`).
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute visitor_id
+      #
+      #   @return [String]
+      required :visitor_id, String
+
+      # @!method initialize(token:, visitor_id:, request_options: {})
+      #   @param token [String] The experiment token (`exp_*`).
+      #
+      #   @param visitor_id [String]
+      #
+      #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_personalization_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#personalization
+    class ExperimentPersonalizationResponse < OursprivacyIngest::Internal::Type::BaseModel
+      # @!attribute personalizations
+      #
+      #   @return [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
+      required :personalizations,
+               -> { OursprivacyIngest::Internal::Type::ArrayOf[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization] }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success]
+      required :success, enum: -> { OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success }
+
+      # @!method initialize(personalizations:, success:)
+      #   @param personalizations [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
+      #   @param success [Boolean, OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success]
+
+      class Personalization < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute assigned_at
+        #
+        #   @return [Float]
+        required :assigned_at, Float
+
+        # @!attribute experiment_id
+        #
+        #   @return [String]
+        required :experiment_id, String
+
+        # @!attribute variant_id
+        #
+        #   @return [String]
+        required :variant_id, String
+
+        # @!attribute experiment_key
+        #
+        #   @return [String, nil]
+        optional :experiment_key, String, nil?: true
+
+        # @!attribute experiment_name
+        #
+        #   @return [String, nil]
+        optional :experiment_name, String, nil?: true
+
+        # @!attribute variant_name
+        #
+        #   @return [String, nil]
+        optional :variant_name, String, nil?: true
+
+        # @!method initialize(assigned_at:, experiment_id:, variant_id:, experiment_key: nil, experiment_name: nil, variant_name: nil)
+        #   @param assigned_at [Float]
+        #   @param experiment_id [String]
+        #   @param variant_id [String]
+        #   @param experiment_key [String, nil]
+        #   @param experiment_name [String, nil]
+        #   @param variant_name [String, nil]
+      end
+
+      # @see OursprivacyIngest::Models::ExperimentPersonalizationResponse#success
+      module Success
+        extend OursprivacyIngest::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

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/models.rb

@@ -44,6 +44,10 @@ module OursprivacyIngest
 
   BatchCreateParams = OursprivacyIngest::Models::BatchCreateParams
 
+  ExperimentAssignmentParams = OursprivacyIngest::Models::ExperimentAssignmentParams
+
+  ExperimentPersonalizationParams = OursprivacyIngest::Models::ExperimentPersonalizationParams
+
   TrackEventParams = OursprivacyIngest::Models::TrackEventParams
 
   VisitorUpsertParams = OursprivacyIngest::Models::VisitorUpsertParams