Class: OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/oursprivacy_ingest/models/visitor_upsert_params.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from OursprivacyIngest::Internal::Type::BaseModel

Instance Attribute Details

#_ef_transaction_id ⇒ String?

The Everflow affiliate Click (Transaction) ID, captured from the ‘_ef_transaction_id` URL parameter. Ex: ef_click_abc123

Returns:

  • (String, nil) 


549
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 549

optional :_ef_transaction_id, String, nil?: true

#active_duration ⇒ Float?

The active time in milliseconds that the user had this tab active

Returns:

  • (Float, nil) 


555
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 555

optional :active_duration, Float, api_name: :activeDuration, nil?: true

#ad_id ⇒ String?

The ad id for detected in the session. This is set by the web sdk automatically.

Returns:

  • (String, nil) 


561
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 561

optional :ad_id, String, nil?: true

#admitad_uid ⇒ String?

The Admitad (Mitgo) affiliate Click ID. Ex: admitad_uid_abc123

Returns:

  • (String, nil) 


567
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 567

optional :admitad_uid, String, nil?: true

#adset_id ⇒ String?

The adset id for detected in the session. This is set by the web sdk automatically.

Returns:

  • (String, nil) 


574
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 574

optional :adset_id, String, nil?: true

#alart ⇒ String?

The AppLovin alart query parameter. Ex: alart123

Returns:

  • (String, nil) 


580
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 580

optional :alart, String, nil?: true

#aleid ⇒ String?

The AppLovin aleid query parameter. Ex: aleid123

Returns:

  • (String, nil) 


586
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 586

optional :aleid, String, nil?: true

#axwrt ⇒ String?

The AppLovin Axon pixel cookie value (_axwrt). Web-only.

Returns:

  • (String, nil) 


592
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 592

optional :axwrt, String, nil?: true

#basis_cid ⇒ String?

The Basis DSP Click ID. Ex: basis_cid123

Returns:

  • (String, nil) 


598
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 598

optional :basis_cid, String, nil?: true

#beeswax_auction_id ⇒ String?

The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the ‘{AUCTION_ID}` macro on creative click URLs. Ex: bx-auc-abc123

Returns:

  • (String, nil) 


605
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 605

optional :beeswax_auction_id, String, nil?: true

#browser_language ⇒ String?

The language of the browser. Ex: en-US

Returns:

  • (String, nil) 


611
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 611

optional :browser_language, String, nil?: true

#browser_name ⇒ String?

The name of the browser. Ex: Chrome

Returns:

  • (String, nil) 


617
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 617

optional :browser_name, String, nil?: true

#browser_version ⇒ String?

The version of the browser. Ex: 114.0

Returns:

  • (String, nil) 


623
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 623

optional :browser_version, String, nil?: true

#campaign_id ⇒ String?

The campaign id for detected in the session. This is set by the web sdk automatically.

Returns:

  • (String, nil) 


630
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 630

optional :campaign_id, String, nil?: true

#clickid ⇒ String?

The Click ID. Ex: clickid123

Returns:

  • (String, nil) 


636
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 636

optional :clickid, String, nil?: true

#clid ⇒ String?

The Generic Click ID. Ex: clid123

Returns:

  • (String, nil) 


642
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 642

optional :clid, String, nil?: true

#cpu_architecture ⇒ String?

The architecture of the CPU. Ex: x64

Returns:

  • (String, nil) 


648
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 648

optional :cpu_architecture, String, nil?: true

#current_url ⇒ String?

The full url (including query params) of the current page

Returns:

  • (String, nil) 


654
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 654

optional :current_url, String, nil?: true

#dclid ⇒ String?

The DoubleClick Click ID. Ex: dclid123

Returns:

  • (String, nil) 


660
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 660

optional :dclid, String, nil?: true

#device_model ⇒ String?

The model of the device. Ex: iPhone 13

Returns:

  • (String, nil) 


666
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 666

optional :device_model, String, nil?: true

#device_type ⇒ String?

The type of device the user is using. Ex: mobile

Returns:

  • (String, nil) 


672
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 672

optional :device_type, String, nil?: true

#device_vendor ⇒ String?

The vendor of the device. Ex: Apple

Returns:

  • (String, nil) 


678
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 678

optional :device_vendor, String, nil?: true

#duration ⇒ Float?

The time in milliseconds since the page was loaded // script was loaded

Returns:

  • (Float, nil) 


684
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 684

optional :duration, Float, nil?: true

#encoding ⇒ String?

The browsers encoding. Ex: UTF-8

Returns:

  • (String, nil) 


690
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 690

optional :encoding, String, nil?: true

#engine_name ⇒ String?

The name of the browser engine. Ex: Blink

Returns:

  • (String, nil) 


696
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 696

optional :engine_name, String, nil?: true

#engine_version ⇒ String?

The version of the browser engine. Ex: 114.0

Returns:

  • (String, nil) 


702
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 702

optional :engine_version, String, nil?: true

#epik ⇒ String?

The Pinterest Click ID. Ex: epik456

Returns:

  • (String, nil) 


708
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 708

optional :epik, String, nil?: true

#fbc ⇒ String?

Facebook Click ID with prefix format for Conversions API tracking. Ex: fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890

Returns:

  • (String, nil) 


715
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 715

optional :fbc, String, nil?: true

#fbclid ⇒ String?

Raw Facebook Click ID query parameter without prefix from ad clicks. Ex: AbCdEfGhIjKlMnOpQrStUvWxYz1234567890

Returns:

  • (String, nil) 


722
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 722

optional :fbclid, String, nil?: true

#fbp ⇒ String?

Facebook Browser ID parameter for identifying browsers and attributing events. Ex: fb.1.1554763741205.1098115397

Returns:

  • (String, nil) 


729
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 729

optional :fbp, String, nil?: true

#fv ⇒ Boolean?

Deprecated

Returns:

  • (Boolean, nil) 


735
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 735

optional :fv, OursprivacyIngest::Internal::Type::Boolean, nil?: true

#gad_source ⇒ String?

The Google Ad Source. Ex: google

Returns:

  • (String, nil) 


741
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 741

optional :gad_source, String, nil?: true

#gbraid ⇒ String?

The Google Braid ID. Ex: gbraid123

Returns:

  • (String, nil) 


747
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 747

optional :gbraid, String, nil?: true

#gclid ⇒ String?

The Google Click ID. Ex: gclid123

Returns:

  • (String, nil) 


753
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 753

optional :gclid, String, nil?: true

#host ⇒ String?

The host of the current page. Ex: example.com

Returns:

  • (String, nil) 


759
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 759

optional :host, String, nil?: true

#iframe ⇒ Boolean?

Whether the user is in an iframe. Ex: true

Returns:

  • (Boolean, nil) 


765
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 765

optional :iframe, OursprivacyIngest::Internal::Type::Boolean, nil?: true

#im_ref ⇒ String?

The Impact Click ID reference. Ex: im_ref123

Returns:

  • (String, nil) 


771
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 771

optional :im_ref, String, nil?: true

#ip ⇒ String?

The IP address of the user. Ex: 127.0.0.1

Returns:

  • (String, nil) 


777
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 777

optional :ip, String, nil?: true

#irclickid ⇒ String?

The Impact Click ID. Ex: irclickid123

Returns:

  • (String, nil) 


783
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 783

optional :irclickid, String, nil?: true

#is_bot ⇒ String?

Whether we have detected that the user is a bot. This is set automatically by the Ours server primarily for events tracked through the web SDK.

Returns:

  • (String, nil) 


790
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 790

optional :is_bot, String, nil?: true

#li_fat_id ⇒ String?

The LinkedIn Click ID. Ex: li_fat_id123

Returns:

  • (String, nil) 


796
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 796

optional :li_fat_id, String, nil?: true

#msclkid ⇒ String?

The Microsoft Click ID. Ex: msclkid123

Returns:

  • (String, nil) 


802
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 802

optional :msclkid, String, nil?: true

#ndclid ⇒ String?

The NextDoor Click ID. Ex: ndclid123

Returns:

  • (String, nil) 


808
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 808

optional :ndclid, String, nil?: true

#new_s ⇒ Boolean?

Deprecated

Returns:

  • (Boolean, nil) 


814
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 814

optional :new_s, OursprivacyIngest::Internal::Type::Boolean, nil?: true

#oppref ⇒ String?

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

Returns:

  • (String, nil) 


823
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 823

optional :oppref, String, nil?: true

#os_name ⇒ String?

The name of the operating system. Ex: Windows

Returns:

  • (String, nil) 


829
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 829

optional :os_name, String, nil?: true

#os_version ⇒ String?

The version of the operating system. Ex: 10.0

Returns:

  • (String, nil) 


835
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 835

optional :os_version, String, nil?: true

#page_hash ⇒ Float?

A random set of numbers for the page load

Returns:

  • (Float, nil) 


841
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 841

optional :page_hash, Float, nil?: true

#pathname ⇒ String?

The pathname of the current page. Ex: /home

Returns:

  • (String, nil) 


847
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 847

optional :pathname, String, nil?: true

#qclid ⇒ String?

The Quora Click ID. Ex: qclid123

Returns:

  • (String, nil) 


853
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 853

optional :qclid, String, nil?: true

#rdt_cid ⇒ String?

The Reddit Click ID. Ex: rdt_cid123

Returns:

  • (String, nil) 


859
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 859

optional :rdt_cid, String, nil?: true

#received_at ⇒ String?

The time the event was received by an Ours server in ISO format

Returns:

  • (String, nil) 


865
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 865

optional :received_at, String, nil?: true

#referrer ⇒ String?

The referrer URL of the current page

Returns:

  • (String, nil) 


871
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 871

optional :referrer, String, nil?: true

#referring_domain ⇒ String?

The referring domain of the current page

Returns:

  • (String, nil) 


877
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 877

optional :referring_domain, String, nil?: true

#sacid ⇒ String?

The StackAdapt Tracking ID. Ex: sacid123

Returns:

  • (String, nil) 


883
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 883

optional :sacid, String, nil?: true

#sccid ⇒ String?

The SnapChat Click ID. Ex: sccid123

Returns:

  • (String, nil) 


889
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 889

optional :sccid, String, nil?: true

#screen_height ⇒ Float?

The height of the screen. Ex: 1080

Returns:

  • (Float, nil) 


895
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 895

optional :screen_height, Float, nil?: true

#screen_width ⇒ Float?

The width of the screen. Ex: 1920

Returns:

  • (Float, nil) 


901
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 901

optional :screen_width, Float, nil?: true

#session_count ⇒ Float?

The number of sessions the user has had. Ex: 3

Returns:

  • (Float, nil) 


907
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 907

optional :session_count, Float, api_name: :sessionCount, nil?: true

#sid ⇒ String?

The session ID as assigned automatically by the web SDK. This is required for session replay

Returns:

  • (String, nil) 


914
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 914

optional :sid, String, nil?: true

#sr ⇒ String?

Returns:

  • (String, nil) 


919
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 919

optional :sr, String, nil?: true

#title ⇒ String?

The title of the current page

Returns:

  • (String, nil) 


925
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 925

optional :title, String, nil?: true

#ttclid ⇒ String?

The TikTok Click ID. Ex: ttclid123

Returns:

  • (String, nil) 


931
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 931

optional :ttclid, String, nil?: true

#twclid ⇒ String?

The Twitter Click ID. Ex: twclid123

Returns:

  • (String, nil) 


937
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 937

optional :twclid, String, nil?: true

#uafvl ⇒ String?

User agent as a full list of strings.

Returns:

  • (String, nil) 


943
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 943

optional :uafvl, String, nil?: true

#user_agent ⇒ String?

The user agent of the browser

Returns:

  • (String, nil) 


949
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 949

optional :user_agent, String, nil?: true

#utm_campaign ⇒ String?

The UTM Campaign. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


955
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 955

optional :utm_campaign, String, nil?: true

#utm_content ⇒ String?

The UTM Content. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


961
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 961

optional :utm_content, String, nil?: true

#utm_medium ⇒ String?

The UTM Medium. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


967
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 967

optional :utm_medium, String, nil?: true

#utm_name ⇒ String?

The UTM Name. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


973
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 973

optional :utm_name, String, nil?: true

#utm_source ⇒ String?

The UTM Source. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


979
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 979

optional :utm_source, String, nil?: true

#utm_term ⇒ String?

The UTM Term. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


985
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 985

optional :utm_term, String, nil?: true

#version ⇒ String?

The version of the web SDK

Returns:

  • (String, nil) 


991
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 991

optional :version, String, nil?: true

#viant_click_id ⇒ String?

The Viant (Adelphic) Click ID, captured from the ‘viant_click_id` URL parameter (Viant `$ADELPHIC_CLICKID` macro). Sent as `xid` on Viant postbacks. Ex: viant_click_abc123

Returns:

  • (String, nil) 


999
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 999

optional :viant_click_id, String, nil?: true

#viant_impression_id ⇒ String?

The Viant (Adelphic) Impression ID, captured from the ‘viant_impression_id` URL parameter (Viant `$ADELPHIC_IMPRESSIONID` macro). Sent as `imp_id` on Viant postbacks for post-view attribution. Ex: viant_imp_abc123

Returns:

  • (String, nil) 


1007
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 1007

optional :viant_impression_id, String, nil?: true

#wbraid ⇒ String?

The WBRAID Identifier. The web SDK automatically captures this from the query params.

Returns:

  • (String, nil) 


1014
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 1014

optional :wbraid, String, nil?: true

#webview ⇒ Boolean?

Whether the user is in a webview. Ex: true

Returns:

  • (Boolean, nil) 


1020
 
# File 'lib/oursprivacy_ingest/models/visitor_upsert_params.rb', line 1020

optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true