oursprivacy-ingest 1.23.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/oursprivacy_ingest/internal/transport/base_client.rb +2 -4
- data/lib/oursprivacy_ingest/internal/transport/pooled_net_requester.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/array_of.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/base_model.rb +3 -6
- data/lib/oursprivacy_ingest/internal/type/enum.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/hash_of.rb +1 -2
- data/lib/oursprivacy_ingest/internal/util.rb +3 -2
- data/lib/oursprivacy_ingest/models/batch_create_params.rb +69 -32
- data/lib/oursprivacy_ingest/models/track_event_params.rb +69 -32
- data/lib/oursprivacy_ingest/models/visitor_upsert_params.rb +69 -32
- data/lib/oursprivacy_ingest/models.rb +9 -5
- data/lib/oursprivacy_ingest/version.rb +1 -1
- data/rbi/oursprivacy_ingest/internal/util.rbi +2 -2
- data/rbi/oursprivacy_ingest/models/batch_create_params.rbi +79 -37
- data/rbi/oursprivacy_ingest/models/track_event_params.rbi +79 -37
- data/rbi/oursprivacy_ingest/models/visitor_upsert_params.rbi +79 -37
- data/sig/oursprivacy_ingest/models/batch_create_params.rbs +23 -3
- data/sig/oursprivacy_ingest/models/track_event_params.rbs +23 -3
- data/sig/oursprivacy_ingest/models/visitor_upsert_params.rbs +23 -3
- metadata +3 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9df52456892f95a73c114c2d52dd9a5a346b8c8d16ae8b7f2ab5c8504ca20a53
|
|
4
|
+
data.tar.gz: a9d298ddb6cd0ecc6790d1de87773bfeb8b9a857b8a7cb8c39d6d9489357537f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8750589f790d2e96c50c6e5ac3a557fe490bb6050c081879328330bba92c35123c0653af01e121f3820dd6b50eb46bf58fefb4862d03f3cff34acf9c821ab8b6
|
|
7
|
+
data.tar.gz: 93c1228e4d84177ea3e8ee09a24201310d34db4ee5b6964ba940f9aec0ad06930f0ee9b7c8969670b604747a0da039c081c8da87040b594c5bf3c53f80055615
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.25.0 (2026-10-29)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.24.0...v1.25.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.24.0...v1.25.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** API update.
|
|
10
|
+
## 1.24.0 (2026-10-22)
|
|
11
|
+
|
|
12
|
+
Full Changelog: [v1.23.0...v1.24.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.23.0...v1.24.0)
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* **api:** API update.
|
|
3
17
|
## 1.23.0 (2026-10-16)
|
|
4
18
|
|
|
5
19
|
Full Changelog: [v1.22.0...v1.23.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.22.0...v1.23.0)
|
data/README.md
CHANGED
|
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
15
15
|
<!-- x-release-please-start-version -->
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
gem "oursprivacy-ingest", "~> 1.
|
|
18
|
+
gem "oursprivacy-ingest", "~> 1.25.0"
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
<!-- x-release-please-end -->
|
|
@@ -12,7 +12,7 @@ module OursprivacyIngest
|
|
|
12
12
|
# from whatwg fetch spec
|
|
13
13
|
MAX_REDIRECTS = 20
|
|
14
14
|
|
|
15
|
-
# rubocop:disable Style/MutableConstant
|
|
15
|
+
# rubocop:disable-next Style/MutableConstant
|
|
16
16
|
PLATFORM_HEADERS =
|
|
17
17
|
{
|
|
18
18
|
"x-stainless-arch" => OursprivacyIngest::Internal::Util.arch,
|
|
@@ -22,7 +22,6 @@ module OursprivacyIngest
|
|
|
22
22
|
"x-stainless-runtime" => ::RUBY_ENGINE,
|
|
23
23
|
"x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
|
|
24
24
|
}
|
|
25
|
-
# rubocop:enable Style/MutableConstant
|
|
26
25
|
|
|
27
26
|
class << self
|
|
28
27
|
# @api private
|
|
@@ -521,9 +520,8 @@ module OursprivacyIngest
|
|
|
521
520
|
#
|
|
522
521
|
# @return [String]
|
|
523
522
|
def inspect
|
|
524
|
-
# rubocop:disable Layout/LineLength
|
|
523
|
+
# rubocop:disable-next Layout/LineLength
|
|
525
524
|
"#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
|
|
526
|
-
# rubocop:enable Layout/LineLength
|
|
527
525
|
end
|
|
528
526
|
|
|
529
527
|
define_sorbet_constant!(:RequestComponents) do
|
|
@@ -133,7 +133,7 @@ module OursprivacyIngest
|
|
|
133
133
|
req = nil
|
|
134
134
|
finished = false
|
|
135
135
|
|
|
136
|
-
# rubocop:disable Metrics/BlockLength
|
|
136
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
137
137
|
enum = Enumerator.new do |y|
|
|
138
138
|
next if finished
|
|
139
139
|
|
|
@@ -181,7 +181,6 @@ module OursprivacyIngest
|
|
|
181
181
|
rescue StandardError
|
|
182
182
|
raise OursprivacyIngest::Errors::APIConnectionError.new(url: url, request: req)
|
|
183
183
|
end
|
|
184
|
-
# rubocop:enable Metrics/BlockLength
|
|
185
184
|
|
|
186
185
|
_, response = enum.next
|
|
187
186
|
body = OursprivacyIngest::Internal::Util.fused_enum(enum, external: true) do
|
|
@@ -46,9 +46,8 @@ module OursprivacyIngest
|
|
|
46
46
|
#
|
|
47
47
|
# @return [Boolean]
|
|
48
48
|
def ==(other)
|
|
49
|
-
# rubocop:disable Layout/LineLength
|
|
49
|
+
# rubocop:disable-next Layout/LineLength
|
|
50
50
|
other.is_a?(OursprivacyIngest::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type
|
|
51
|
-
# rubocop:enable Layout/LineLength
|
|
52
51
|
end
|
|
53
52
|
|
|
54
53
|
# @api public
|
|
@@ -95,7 +95,7 @@ module OursprivacyIngest
|
|
|
95
95
|
end
|
|
96
96
|
|
|
97
97
|
# rubocop:disable Style/CaseEquality
|
|
98
|
-
# rubocop:disable Metrics/BlockLength
|
|
98
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
99
99
|
define_method(name_sym) do
|
|
100
100
|
target = type_fn.call
|
|
101
101
|
|
|
@@ -132,7 +132,6 @@ module OursprivacyIngest
|
|
|
132
132
|
end
|
|
133
133
|
end
|
|
134
134
|
end
|
|
135
|
-
# rubocop:enable Metrics/BlockLength
|
|
136
135
|
# rubocop:enable Style/CaseEquality
|
|
137
136
|
end
|
|
138
137
|
|
|
@@ -205,9 +204,8 @@ module OursprivacyIngest
|
|
|
205
204
|
#
|
|
206
205
|
# @return [Boolean]
|
|
207
206
|
def ==(other)
|
|
208
|
-
# rubocop:disable Layout/LineLength
|
|
207
|
+
# rubocop:disable-next Layout/LineLength
|
|
209
208
|
other.is_a?(Class) && other <= OursprivacyIngest::Internal::Type::BaseModel && other.fields == fields
|
|
210
|
-
# rubocop:enable Layout/LineLength
|
|
211
209
|
end
|
|
212
210
|
|
|
213
211
|
# @api public
|
|
@@ -266,7 +264,7 @@ module OursprivacyIngest
|
|
|
266
264
|
data = instance.to_h
|
|
267
265
|
status = instance.instance_variable_get(:@coerced)
|
|
268
266
|
|
|
269
|
-
# rubocop:disable Metrics/BlockLength
|
|
267
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
270
268
|
fields.each do |name, field|
|
|
271
269
|
mode, required, target = field.fetch_values(:mode, :required, :type)
|
|
272
270
|
api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const)
|
|
@@ -302,7 +300,6 @@ module OursprivacyIngest
|
|
|
302
300
|
status.store(name, state.fetch(:error) || true)
|
|
303
301
|
data.store(name, converted)
|
|
304
302
|
end
|
|
305
|
-
# rubocop:enable Metrics/BlockLength
|
|
306
303
|
|
|
307
304
|
keys.each { data.store(_1, val.fetch(_1)) }
|
|
308
305
|
instance
|
|
@@ -37,9 +37,8 @@ module OursprivacyIngest
|
|
|
37
37
|
#
|
|
38
38
|
# @return [Boolean]
|
|
39
39
|
def ==(other)
|
|
40
|
-
# rubocop:disable Style/CaseEquality
|
|
40
|
+
# rubocop:disable-next Style/CaseEquality
|
|
41
41
|
OursprivacyIngest::Internal::Type::Enum === other && other.values.to_set == values.to_set
|
|
42
|
-
# rubocop:enable Style/CaseEquality
|
|
43
42
|
end
|
|
44
43
|
|
|
45
44
|
# @api public
|
|
@@ -61,9 +61,8 @@ module OursprivacyIngest
|
|
|
61
61
|
#
|
|
62
62
|
# @return [Boolean]
|
|
63
63
|
def ==(other)
|
|
64
|
-
# rubocop:disable Layout/LineLength
|
|
64
|
+
# rubocop:disable-next Layout/LineLength
|
|
65
65
|
other.is_a?(OursprivacyIngest::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type
|
|
66
|
-
# rubocop:enable Layout/LineLength
|
|
67
66
|
end
|
|
68
67
|
|
|
69
68
|
# @api public
|
|
@@ -529,6 +529,8 @@ module OursprivacyIngest
|
|
|
529
529
|
write_query_param_element!(collection, "#{key}[#{name}]", value)
|
|
530
530
|
end
|
|
531
531
|
in Array
|
|
532
|
+
# Array#join flattens nested arrays; stringify each element to preserve query values.
|
|
533
|
+
# rubocop:disable-next Style/MapJoin
|
|
532
534
|
collection[key] = element.map(&:to_s).join(",")
|
|
533
535
|
else
|
|
534
536
|
collection[key] = element.to_s
|
|
@@ -770,9 +772,8 @@ module OursprivacyIngest
|
|
|
770
772
|
def close_fused!(enum)
|
|
771
773
|
return unless enum.is_a?(Enumerator)
|
|
772
774
|
|
|
773
|
-
# rubocop:disable Lint/UnreachableLoop
|
|
775
|
+
# rubocop:disable-next Lint/UnreachableLoop
|
|
774
776
|
enum.rewind.each { break }
|
|
775
|
-
# rubocop:enable Lint/UnreachableLoop
|
|
776
777
|
end
|
|
777
778
|
|
|
778
779
|
# @api private
|
|
@@ -170,13 +170,13 @@ module OursprivacyIngest
|
|
|
170
170
|
optional :_ef_transaction_id, String, nil?: true
|
|
171
171
|
|
|
172
172
|
# @!attribute active_duration
|
|
173
|
-
# The
|
|
173
|
+
# The total time in milliseconds this tab has been visible since the page loaded
|
|
174
174
|
#
|
|
175
175
|
# @return [Float, nil]
|
|
176
176
|
optional :active_duration, Float, api_name: :activeDuration, nil?: true
|
|
177
177
|
|
|
178
178
|
# @!attribute ad_id
|
|
179
|
-
# The ad id
|
|
179
|
+
# The ad id detected in the session. This is set by the web sdk automatically.
|
|
180
180
|
# Leading and trailing whitespace is removed before validation.
|
|
181
181
|
#
|
|
182
182
|
# @return [String, nil]
|
|
@@ -190,8 +190,8 @@ module OursprivacyIngest
|
|
|
190
190
|
optional :admitad_uid, String, nil?: true
|
|
191
191
|
|
|
192
192
|
# @!attribute adset_id
|
|
193
|
-
# The adset id
|
|
194
|
-
#
|
|
193
|
+
# The adset id detected in the session. This is set by the web sdk automatically.
|
|
194
|
+
# Leading and trailing whitespace is removed before validation.
|
|
195
195
|
#
|
|
196
196
|
# @return [String, nil]
|
|
197
197
|
optional :adset_id, String, nil?: true
|
|
@@ -233,8 +233,8 @@ module OursprivacyIngest
|
|
|
233
233
|
optional :beeswax_auction_id, String, nil?: true
|
|
234
234
|
|
|
235
235
|
# @!attribute browser_language
|
|
236
|
-
# The language of the browser. Ex: en-
|
|
237
|
-
# removed before validation.
|
|
236
|
+
# The language of the browser, lowercased. Ex: en-us Leading and trailing
|
|
237
|
+
# whitespace is removed before validation.
|
|
238
238
|
#
|
|
239
239
|
# @return [String, nil]
|
|
240
240
|
optional :browser_language, String, nil?: true
|
|
@@ -254,7 +254,7 @@ module OursprivacyIngest
|
|
|
254
254
|
optional :browser_version, String, nil?: true
|
|
255
255
|
|
|
256
256
|
# @!attribute campaign_id
|
|
257
|
-
# The campaign id
|
|
257
|
+
# The campaign id detected in the session. This is set by the web sdk
|
|
258
258
|
# automatically. Leading and trailing whitespace is removed before validation.
|
|
259
259
|
#
|
|
260
260
|
# @return [String, nil]
|
|
@@ -275,8 +275,8 @@ module OursprivacyIngest
|
|
|
275
275
|
optional :clid, String, nil?: true
|
|
276
276
|
|
|
277
277
|
# @!attribute cpu_architecture
|
|
278
|
-
# The architecture of the CPU. Ex:
|
|
279
|
-
# before validation.
|
|
278
|
+
# The architecture of the CPU. Ex: amd64 Leading and trailing whitespace is
|
|
279
|
+
# removed before validation.
|
|
280
280
|
#
|
|
281
281
|
# @return [String, nil]
|
|
282
282
|
optional :cpu_architecture, String, nil?: true
|
|
@@ -296,8 +296,8 @@ module OursprivacyIngest
|
|
|
296
296
|
optional :dclid, String, nil?: true
|
|
297
297
|
|
|
298
298
|
# @!attribute device_model
|
|
299
|
-
# The model of the device. Ex: iPhone
|
|
300
|
-
#
|
|
299
|
+
# The model of the device. Ex: iPhone Leading and trailing whitespace is removed
|
|
300
|
+
# before validation.
|
|
301
301
|
#
|
|
302
302
|
# @return [String, nil]
|
|
303
303
|
optional :device_model, String, nil?: true
|
|
@@ -317,13 +317,15 @@ module OursprivacyIngest
|
|
|
317
317
|
optional :device_vendor, String, nil?: true
|
|
318
318
|
|
|
319
319
|
# @!attribute duration
|
|
320
|
-
# The time in milliseconds since the
|
|
320
|
+
# The time in milliseconds since the previous event on this page, or since the web
|
|
321
|
+
# SDK loaded for the first event. Restarts when a hidden tab becomes visible
|
|
322
|
+
# again.
|
|
321
323
|
#
|
|
322
324
|
# @return [Float, nil]
|
|
323
325
|
optional :duration, Float, nil?: true
|
|
324
326
|
|
|
325
327
|
# @!attribute encoding
|
|
326
|
-
# The
|
|
328
|
+
# The browser's encoding. Ex: UTF-8 Leading and trailing whitespace is removed
|
|
327
329
|
# before validation.
|
|
328
330
|
#
|
|
329
331
|
# @return [String, nil]
|
|
@@ -546,7 +548,7 @@ module OursprivacyIngest
|
|
|
546
548
|
optional :rdt_cid, String, nil?: true
|
|
547
549
|
|
|
548
550
|
# @!attribute received_at
|
|
549
|
-
# The time
|
|
551
|
+
# The time an Ours server received the event, in ISO 8601 UTC
|
|
550
552
|
#
|
|
551
553
|
# @return [String, nil]
|
|
552
554
|
optional :received_at, String, nil?: true
|
|
@@ -573,7 +575,7 @@ module OursprivacyIngest
|
|
|
573
575
|
optional :sacid, String, nil?: true
|
|
574
576
|
|
|
575
577
|
# @!attribute sccid
|
|
576
|
-
# The
|
|
578
|
+
# The Snapchat Click ID. Ex: sccid123 Leading and trailing whitespace is removed
|
|
577
579
|
# before validation.
|
|
578
580
|
#
|
|
579
581
|
# @return [String, nil]
|
|
@@ -605,7 +607,8 @@ module OursprivacyIngest
|
|
|
605
607
|
optional :sid, String, nil?: true
|
|
606
608
|
|
|
607
609
|
# @!attribute sr
|
|
608
|
-
#
|
|
610
|
+
# The screen resolution as width x height in pixels. Ex: 1920x1080 Leading and
|
|
611
|
+
# trailing whitespace is removed before validation.
|
|
609
612
|
#
|
|
610
613
|
# @return [String, nil]
|
|
611
614
|
optional :sr, String, nil?: true
|
|
@@ -624,6 +627,14 @@ module OursprivacyIngest
|
|
|
624
627
|
# @return [String, nil]
|
|
625
628
|
optional :ttclid, String, nil?: true
|
|
626
629
|
|
|
630
|
+
# @!attribute ttd_impression_id
|
|
631
|
+
# The Trade Desk impression ID, captured from a configured ttd_impression_id URL
|
|
632
|
+
# parameter using the %%TTD_IMPRESSIONID%% creative macro. Sent as imp on
|
|
633
|
+
# conversions. Leading and trailing whitespace is removed before validation.
|
|
634
|
+
#
|
|
635
|
+
# @return [String, nil]
|
|
636
|
+
optional :ttd_impression_id, String, nil?: true
|
|
637
|
+
|
|
627
638
|
# @!attribute twclid
|
|
628
639
|
# The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed
|
|
629
640
|
# before validation.
|
|
@@ -632,7 +643,8 @@ module OursprivacyIngest
|
|
|
632
643
|
optional :twclid, String, nil?: true
|
|
633
644
|
|
|
634
645
|
# @!attribute uafvl
|
|
635
|
-
#
|
|
646
|
+
# The browser brands and full versions from User-Agent Client Hints, as
|
|
647
|
+
# brand;version pairs separated by |. Leading and trailing whitespace is removed
|
|
636
648
|
# before validation.
|
|
637
649
|
#
|
|
638
650
|
# @return [String, nil]
|
|
@@ -724,7 +736,13 @@ module OursprivacyIngest
|
|
|
724
736
|
# @return [Boolean, nil]
|
|
725
737
|
optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
|
|
726
738
|
|
|
727
|
-
# @!
|
|
739
|
+
# @!attribute ylpcid
|
|
740
|
+
# The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
741
|
+
#
|
|
742
|
+
# @return [String, nil]
|
|
743
|
+
optional :ylpcid, String, nil?: true
|
|
744
|
+
|
|
745
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: 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, ttd_impression_id: 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, ylpcid: nil)
|
|
728
746
|
# Some parameter documentations has been truncated, see
|
|
729
747
|
# {OursprivacyIngest::Models::BatchCreateParams::Event::DefaultProperties} for
|
|
730
748
|
# more details.
|
|
@@ -735,13 +753,13 @@ module OursprivacyIngest
|
|
|
735
753
|
# @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
|
|
736
754
|
# `\_ef_transactio
|
|
737
755
|
#
|
|
738
|
-
# @param active_duration [Float, nil] The
|
|
756
|
+
# @param active_duration [Float, nil] The total time in milliseconds this tab has been visible since the page loaded
|
|
739
757
|
#
|
|
740
|
-
# @param ad_id [String, nil] The ad id
|
|
758
|
+
# @param ad_id [String, nil] The ad id detected in the session. This is set by the web sdk automatically. Lea
|
|
741
759
|
#
|
|
742
760
|
# @param admitad_uid [String, nil] The Admitad (Mitgo) affiliate Click ID. Ex: admitad_uid_abc123 Leading and trail
|
|
743
761
|
#
|
|
744
|
-
# @param adset_id [String, nil] The adset id
|
|
762
|
+
# @param adset_id [String, nil] The adset id detected in the session. This is set by the web sdk automatically.
|
|
745
763
|
#
|
|
746
764
|
# @param alart [String, nil] The AppLovin alart query parameter. Ex: alart123 Leading and trailing whitespace
|
|
747
765
|
#
|
|
@@ -754,33 +772,33 @@ module OursprivacyIngest
|
|
|
754
772
|
#
|
|
755
773
|
# @param beeswax_auction_id [String, nil] The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the `{{AUCTION_ID}
|
|
756
774
|
#
|
|
757
|
-
# @param browser_language [String, nil] The language of the browser. Ex: en-
|
|
775
|
+
# @param browser_language [String, nil] The language of the browser, lowercased. Ex: en-us Leading and trailing whitespa
|
|
758
776
|
#
|
|
759
777
|
# @param browser_name [String, nil] The name of the browser. Ex: Chrome Leading and trailing whitespace is removed b
|
|
760
778
|
#
|
|
761
779
|
# @param browser_version [String, nil] The version of the browser. Ex: 114.0 Leading and trailing whitespace is removed
|
|
762
780
|
#
|
|
763
|
-
# @param campaign_id [String, nil] The campaign id
|
|
781
|
+
# @param campaign_id [String, nil] The campaign id detected in the session. This is set by the web sdk automaticall
|
|
764
782
|
#
|
|
765
783
|
# @param clickid [String, nil] The Click ID. Ex: clickid123 Leading and trailing whitespace is removed before v
|
|
766
784
|
#
|
|
767
785
|
# @param clid [String, nil] The Generic Click ID. Ex: clid123 Leading and trailing whitespace is removed bef
|
|
768
786
|
#
|
|
769
|
-
# @param cpu_architecture [String, nil] The architecture of the CPU. Ex:
|
|
787
|
+
# @param cpu_architecture [String, nil] The architecture of the CPU. Ex: amd64 Leading and trailing whitespace is remove
|
|
770
788
|
#
|
|
771
789
|
# @param current_url [String, nil] The full url (including query params) of the current page Leading and trailing w
|
|
772
790
|
#
|
|
773
791
|
# @param dclid [String, nil] The DoubleClick Click ID. Ex: dclid123 Leading and trailing whitespace is remove
|
|
774
792
|
#
|
|
775
|
-
# @param device_model [String, nil] The model of the device. Ex: iPhone
|
|
793
|
+
# @param device_model [String, nil] The model of the device. Ex: iPhone Leading and trailing whitespace is removed b
|
|
776
794
|
#
|
|
777
795
|
# @param device_type [String, nil] The type of device the user is using. Ex: mobile Leading and trailing whitespace
|
|
778
796
|
#
|
|
779
797
|
# @param device_vendor [String, nil] The vendor of the device. Ex: Apple Leading and trailing whitespace is removed b
|
|
780
798
|
#
|
|
781
|
-
# @param duration [Float, nil] The time in milliseconds since the
|
|
799
|
+
# @param duration [Float, nil] The time in milliseconds since the previous event on this page, or since the web
|
|
782
800
|
#
|
|
783
|
-
# @param encoding [String, nil] The
|
|
801
|
+
# @param encoding [String, nil] The browser's encoding. Ex: UTF-8 Leading and trailing whitespace is removed bef
|
|
784
802
|
#
|
|
785
803
|
# @param engine_name [String, nil] The name of the browser engine. Ex: Blink Leading and trailing whitespace is rem
|
|
786
804
|
#
|
|
@@ -842,7 +860,7 @@ module OursprivacyIngest
|
|
|
842
860
|
#
|
|
843
861
|
# @param rdt_cid [String, nil] The Reddit Click ID. Ex: rdt_cid123 Leading and trailing whitespace is removed b
|
|
844
862
|
#
|
|
845
|
-
# @param received_at [String, nil] The time
|
|
863
|
+
# @param received_at [String, nil] The time an Ours server received the event, in ISO 8601 UTC
|
|
846
864
|
#
|
|
847
865
|
# @param referrer [String, nil] The referrer URL of the current page Leading and trailing whitespace is removed
|
|
848
866
|
#
|
|
@@ -850,7 +868,7 @@ module OursprivacyIngest
|
|
|
850
868
|
#
|
|
851
869
|
# @param sacid [String, nil] The StackAdapt Tracking ID. Ex: sacid123 Leading and trailing whitespace is remo
|
|
852
870
|
#
|
|
853
|
-
# @param sccid [String, nil] The
|
|
871
|
+
# @param sccid [String, nil] The Snapchat Click ID. Ex: sccid123 Leading and trailing whitespace is removed b
|
|
854
872
|
#
|
|
855
873
|
# @param screen_height [Float, nil] The height of the screen. Ex: 1080
|
|
856
874
|
#
|
|
@@ -860,15 +878,17 @@ module OursprivacyIngest
|
|
|
860
878
|
#
|
|
861
879
|
# @param sid [String, nil] The session ID as assigned automatically by the web SDK. This is required for se
|
|
862
880
|
#
|
|
863
|
-
# @param sr [String, nil]
|
|
881
|
+
# @param sr [String, nil] The screen resolution as width x height in pixels. Ex: 1920x1080 Leading and tra
|
|
864
882
|
#
|
|
865
883
|
# @param title [String, nil] The title of the current page Leading and trailing whitespace is removed before
|
|
866
884
|
#
|
|
867
885
|
# @param ttclid [String, nil] The TikTok Click ID. Ex: ttclid123 Leading and trailing whitespace is removed be
|
|
868
886
|
#
|
|
887
|
+
# @param ttd_impression_id [String, nil] The Trade Desk impression ID, captured from a configured ttd_impression_id URL p
|
|
888
|
+
#
|
|
869
889
|
# @param twclid [String, nil] The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed b
|
|
870
890
|
#
|
|
871
|
-
# @param uafvl [String, nil]
|
|
891
|
+
# @param uafvl [String, nil] The browser brands and full versions from User-Agent Client Hints, as brand;vers
|
|
872
892
|
#
|
|
873
893
|
# @param user_agent [String, nil] The user agent of the browser Leading and trailing whitespace is removed before
|
|
874
894
|
#
|
|
@@ -894,6 +914,8 @@ module OursprivacyIngest
|
|
|
894
914
|
# @param wbraid [String, nil] The WBRAID Identifier. The web SDK automatically captures this from the query pa
|
|
895
915
|
#
|
|
896
916
|
# @param webview [Boolean, nil] Whether the user is in a webview. Ex: true
|
|
917
|
+
#
|
|
918
|
+
# @param ylpcid [String, nil] The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
897
919
|
|
|
898
920
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
899
921
|
#
|
|
@@ -1558,6 +1580,12 @@ module OursprivacyIngest
|
|
|
1558
1580
|
# @return [String, nil]
|
|
1559
1581
|
optional :ttclid, String, nil?: true
|
|
1560
1582
|
|
|
1583
|
+
# @!attribute ttd_impression_id
|
|
1584
|
+
# Leading and trailing whitespace is removed before validation.
|
|
1585
|
+
#
|
|
1586
|
+
# @return [String, nil]
|
|
1587
|
+
optional :ttd_impression_id, String, nil?: true
|
|
1588
|
+
|
|
1561
1589
|
# @!attribute twclid
|
|
1562
1590
|
#
|
|
1563
1591
|
# @return [String, nil]
|
|
@@ -1632,6 +1660,11 @@ module OursprivacyIngest
|
|
|
1632
1660
|
# @return [String, nil]
|
|
1633
1661
|
optional :wbraid, String, nil?: true
|
|
1634
1662
|
|
|
1663
|
+
# @!attribute ylpcid
|
|
1664
|
+
#
|
|
1665
|
+
# @return [String, nil]
|
|
1666
|
+
optional :ylpcid, String, nil?: true
|
|
1667
|
+
|
|
1635
1668
|
# @!attribute zip
|
|
1636
1669
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
1637
1670
|
#
|
|
@@ -1642,7 +1675,7 @@ module OursprivacyIngest
|
|
|
1642
1675
|
},
|
|
1643
1676
|
nil?: true
|
|
1644
1677
|
|
|
1645
|
-
# @!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, graid: nil, grclid: 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, ob_click_id: 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)
|
|
1678
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: 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, ttd_impression_id: 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, ylpcid: nil, zip: nil)
|
|
1646
1679
|
# Some parameter documentations has been truncated, see
|
|
1647
1680
|
# {OursprivacyIngest::Models::BatchCreateParams::Event::UserProperties} for more
|
|
1648
1681
|
# details.
|
|
@@ -1756,6 +1789,8 @@ module OursprivacyIngest
|
|
|
1756
1789
|
#
|
|
1757
1790
|
# @param ttclid [String, nil]
|
|
1758
1791
|
#
|
|
1792
|
+
# @param ttd_impression_id [String, nil] Leading and trailing whitespace is removed before validation.
|
|
1793
|
+
#
|
|
1759
1794
|
# @param twclid [String, nil]
|
|
1760
1795
|
#
|
|
1761
1796
|
# @param user_agent [String, nil]
|
|
@@ -1780,6 +1815,8 @@ module OursprivacyIngest
|
|
|
1780
1815
|
#
|
|
1781
1816
|
# @param wbraid [String, nil]
|
|
1782
1817
|
#
|
|
1818
|
+
# @param ylpcid [String, nil]
|
|
1819
|
+
#
|
|
1783
1820
|
# @param zip [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil] Any JSON value: string, number, boolean, array, object, or null.
|
|
1784
1821
|
|
|
1785
1822
|
module Consent
|