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) 


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

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) 


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

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) 


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

optional :ad_id, String, nil?: true

#admitad_uid ⇒ String?

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

Returns:

  • (String, nil) 


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

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) 


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

optional :adset_id, String, nil?: true

#alart ⇒ String?

The AppLovin alart query parameter. Ex: alart123

Returns:

  • (String, nil) 


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

optional :alart, String, nil?: true

#aleid ⇒ String?

The AppLovin aleid query parameter. Ex: aleid123

Returns:

  • (String, nil) 


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

optional :aleid, String, nil?: true

#axwrt ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :axwrt, String, nil?: true

#basis_cid ⇒ String?

The Basis DSP Click ID. Ex: basis_cid123

Returns:

  • (String, nil) 


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

optional :basis_cid, String, nil?: true

#browser_language ⇒ String?

The language of the browser. Ex: en-US

Returns:

  • (String, nil) 


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

optional :browser_language, String, nil?: true

#browser_name ⇒ String?

The name of the browser. Ex: Chrome

Returns:

  • (String, nil) 


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

optional :browser_name, String, nil?: true

#browser_version ⇒ String?

The version of the browser. Ex: 114.0

Returns:

  • (String, nil) 


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

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) 


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

optional :campaign_id, String, nil?: true

#clickid ⇒ String?

The Click ID. Ex: clickid123

Returns:

  • (String, nil) 


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

optional :clickid, String, nil?: true

#clid ⇒ String?

The Generic Click ID. Ex: clid123

Returns:

  • (String, nil) 


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

optional :clid, String, nil?: true

#cpu_architecture ⇒ String?

The architecture of the CPU. Ex: x64

Returns:

  • (String, nil) 


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

optional :cpu_architecture, String, nil?: true

#current_url ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :current_url, String, nil?: true

#dclid ⇒ String?

The DoubleClick Click ID. Ex: dclid123

Returns:

  • (String, nil) 


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

optional :dclid, String, nil?: true

#device_model ⇒ String?

The model of the device. Ex: iPhone 13

Returns:

  • (String, nil) 


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

optional :device_model, String, nil?: true

#device_type ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :device_type, String, nil?: true

#device_vendor ⇒ String?

The vendor of the device. Ex: Apple

Returns:

  • (String, nil) 


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

optional :device_vendor, String, nil?: true

#duration ⇒ Float?

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

Returns:

  • (Float, nil) 


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

optional :duration, Float, nil?: true

#encoding ⇒ String?

The browsers encoding. Ex: UTF-8

Returns:

  • (String, nil) 


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

optional :encoding, String, nil?: true

#engine_name ⇒ String?

The name of the browser engine. Ex: Blink

Returns:

  • (String, nil) 


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

optional :engine_name, String, nil?: true

#engine_version ⇒ String?

The version of the browser engine. Ex: 114.0

Returns:

  • (String, nil) 


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

optional :engine_version, String, nil?: true

#epik ⇒ String?

The Pinterest Click ID. Ex: epik456

Returns:

  • (String, nil) 


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

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) 


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

optional :fbc, String, nil?: true

#fbclid ⇒ String?

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

Returns:

  • (String, nil) 


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

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) 


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

optional :fbp, String, nil?: true

#fv ⇒ Boolean?

Deprecated

Returns:

  • (Boolean, nil) 


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

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

#gad_source ⇒ String?

The Google Ad Source. Ex: google

Returns:

  • (String, nil) 


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

optional :gad_source, String, nil?: true

#gbraid ⇒ String?

The Google Braid ID. Ex: gbraid123

Returns:

  • (String, nil) 


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

optional :gbraid, String, nil?: true

#gclid ⇒ String?

The Google Click ID. Ex: gclid123

Returns:

  • (String, nil) 


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

optional :gclid, String, nil?: true

#host ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :host, String, nil?: true

#iframe ⇒ Boolean?

Whether the user is in an iframe. Ex: true

Returns:

  • (Boolean, nil) 


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

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

#im_ref ⇒ String?

The Impact Click ID reference. Ex: im_ref123

Returns:

  • (String, nil) 


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

optional :im_ref, String, nil?: true

#ip ⇒ String?

The IP address of the user. Ex: 127.0.0.1

Returns:

  • (String, nil) 


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

optional :ip, String, nil?: true

#irclickid ⇒ String?

The Impact Click ID. Ex: irclickid123

Returns:

  • (String, nil) 


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

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) 


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

optional :is_bot, String, nil?: true

#li_fat_id ⇒ String?

The LinkedIn Click ID. Ex: li_fat_id123

Returns:

  • (String, nil) 


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

optional :li_fat_id, String, nil?: true

#msclkid ⇒ String?

The Microsoft Click ID. Ex: msclkid123

Returns:

  • (String, nil) 


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

optional :msclkid, String, nil?: true

#ndclid ⇒ String?

The NextDoor Click ID. Ex: ndclid123

Returns:

  • (String, nil) 


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

optional :ndclid, String, nil?: true

#new_s ⇒ Boolean?

Deprecated

Returns:

  • (Boolean, nil) 


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

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

#os_name ⇒ String?

The name of the operating system. Ex: Windows

Returns:

  • (String, nil) 


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

optional :os_name, String, nil?: true

#os_version ⇒ String?

The version of the operating system. Ex: 10.0

Returns:

  • (String, nil) 


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

optional :os_version, String, nil?: true

#page_hash ⇒ Float?

A random set of numbers for the page load

Returns:

  • (Float, nil) 


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

optional :page_hash, Float, nil?: true

#pathname ⇒ String?

The pathname of the current page. Ex: /home

Returns:

  • (String, nil) 


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

optional :pathname, String, nil?: true

#qclid ⇒ String?

The Quora Click ID. Ex: qclid123

Returns:

  • (String, nil) 


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

optional :qclid, String, nil?: true

#rdt_cid ⇒ String?

The Reddit Click ID. Ex: rdt_cid123

Returns:

  • (String, nil) 


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

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) 


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

optional :received_at, String, nil?: true

#referrer ⇒ String?

The referrer URL of the current page

Returns:

  • (String, nil) 


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

optional :referrer, String, nil?: true

#referring_domain ⇒ String?

The referring domain of the current page

Returns:

  • (String, nil) 


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

optional :referring_domain, String, nil?: true

#sacid ⇒ String?

The StackAdapt Tracking ID. Ex: sacid123

Returns:

  • (String, nil) 


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

optional :sacid, String, nil?: true

#sccid ⇒ String?

The SnapChat Click ID. Ex: sccid123

Returns:

  • (String, nil) 


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

optional :sccid, String, nil?: true

#screen_height ⇒ Float?

The height of the screen. Ex: 1080

Returns:

  • (Float, nil) 


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

optional :screen_height, Float, nil?: true

#screen_width ⇒ Float?

The width of the screen. Ex: 1920

Returns:

  • (Float, nil) 


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

optional :screen_width, Float, nil?: true

#session_count ⇒ Float?

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

Returns:

  • (Float, nil) 


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

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) 


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

optional :sid, String, nil?: true

#sr ⇒ String?

Returns:

  • (String, nil) 


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

optional :sr, String, nil?: true

#title ⇒ String?

The title of the current page

Returns:

  • (String, nil) 


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

optional :title, String, nil?: true

#ttclid ⇒ String?

The TikTok Click ID. Ex: ttclid123

Returns:

  • (String, nil) 


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

optional :ttclid, String, nil?: true

#twclid ⇒ String?

The Twitter Click ID. Ex: twclid123

Returns:

  • (String, nil) 


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

optional :twclid, String, nil?: true

#uafvl ⇒ String?

User agent as a full list of strings.

Returns:

  • (String, nil) 


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

optional :uafvl, String, nil?: true

#user_agent ⇒ String?

The user agent of the browser

Returns:

  • (String, nil) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

optional :utm_term, String, nil?: true

#version ⇒ String?

The version of the web SDK

Returns:

  • (String, nil) 


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

optional :version, String, nil?: true

#wbraid ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :wbraid, String, nil?: true

#webview ⇒ Boolean?

Whether the user is in a webview. Ex: true

Returns:

  • (Boolean, nil) 


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

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