Class: OursprivacyIngest::Models::BatchCreateParams::Event::UserProperties

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OursprivacyIngest::Models::BatchCreateParams::Event::UserProperties

Defined in:

lib/oursprivacy_ingest/models/batch_create_params.rb,
sig/oursprivacy_ingest/models/batch_create_params.rbs

Overview

See Also:

• OursprivacyIngest::Models::BatchCreateParams::Event#user_properties

Instance Attribute Summary

• #_ef_transaction_id ⇒ String^?
• #ad_id ⇒ String^?
• #admitad_uid ⇒ String^?
• #adset_id ⇒ String^?
• #alart ⇒ String^?
• #aleid ⇒ String^?
• #axwrt ⇒ String^?
• #basis_cid ⇒ String^?
• #beeswax_auction_id ⇒ String^?
• #campaign_id ⇒ String^?
• #city ⇒ String^?
• #clickid ⇒ String^?
• #clid ⇒ String^?
• #company_name ⇒ String^?
• #consent ⇒ Hash{Symbol=>String, nil}^?
• #country ⇒ String^?
• #custom_properties ⇒ Hash{Symbol=>String, nil}^?
• #date_of_birth ⇒ String^?
• #dclid ⇒ String^?
• #email ⇒ String^?
• #epik ⇒ String^?
• #external_id ⇒ String^?
• #fbc ⇒ String^?
• #fbclid ⇒ String^?
• #fbp ⇒ String^?
• #first_name ⇒ String^?
• #gad_source ⇒ String^?
• #gbraid ⇒ String^?
• #gclid ⇒ String^?
• #gender ⇒ String^?
• #im_ref ⇒ String^?
• #ip ⇒ String^?

  The IP address of the user.

• #irclickid ⇒ String^?
• #is_bot ⇒ String^?
• #job_title ⇒ String^?
• #last_name ⇒ String^?
• #li_fat_id ⇒ String^?
• #msclkid ⇒ String^?
• #ndclid ⇒ String^?
• #ob_click_id ⇒ String^?
• #oppref ⇒ String^?
• #phone_number ⇒ String^?
• #qclid ⇒ String^?
• #rdt_cid ⇒ String^?
• #referrer ⇒ String^?
• #referring_domain ⇒ String^?
• #sacid ⇒ String^?
• #sccid ⇒ String^?
• #sid ⇒ String^?
• #state ⇒ String^?
• #ttclid ⇒ String^?
• #twclid ⇒ String^?
• #user_agent ⇒ String^?
• #user_agent_full_list ⇒ String^?
• #utm_campaign ⇒ String^?
• #utm_content ⇒ String^?
• #utm_medium ⇒ String^?
• #utm_name ⇒ String^?
• #utm_source ⇒ String^?
• #utm_term ⇒ String^?
• #viant_click_id ⇒ String^?
• #viant_impression_id ⇒ String^?
• #wbraid ⇒ String^?
• #zip ⇒ String^?

Instance Method Summary

• #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, 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) ⇒ Object constructor

  Properties to set on the visitor.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, 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

#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, 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) ⇒ Object

Properties to set on the visitor. (optional) You can also update these properties via the identify endpoint.

Parameters:

• _ef_transaction_id (String, nil) (defaults to: nil)
• ad_id (String, nil) (defaults to: nil)
• admitad_uid (String, nil) (defaults to: nil)
• adset_id (String, nil) (defaults to: nil)
• alart (String, nil) (defaults to: nil)
• aleid (String, nil) (defaults to: nil)
• axwrt (String, nil) (defaults to: nil)
• basis_cid (String, nil) (defaults to: nil)
• beeswax_auction_id (String, nil) (defaults to: nil)
• campaign_id (String, nil) (defaults to: nil)
• city (String, nil) (defaults to: nil)
• clickid (String, nil) (defaults to: nil)
• clid (String, nil) (defaults to: nil)
• company_name (String, nil) (defaults to: nil)
• consent (Hash{Symbol=>String, nil}, nil) (defaults to: nil)
• country (String, nil) (defaults to: nil)
• custom_properties (Hash{Symbol=>String, nil}, nil) (defaults to: nil)
• date_of_birth (String, nil) (defaults to: nil)
• dclid (String, nil) (defaults to: nil)
• email (String, nil) (defaults to: nil)
• epik (String, nil) (defaults to: nil)
• external_id (String, nil) (defaults to: nil)
• fbc (String, nil) (defaults to: nil)
• fbclid (String, nil) (defaults to: nil)
• fbp (String, nil) (defaults to: nil)
• first_name (String, nil) (defaults to: nil)
• gad_source (String, nil) (defaults to: nil)
• gbraid (String, nil) (defaults to: nil)
• gclid (String, nil) (defaults to: nil)
• gender (String, nil) (defaults to: nil)
• im_ref (String, nil) (defaults to: nil)
• ip (String, nil) (defaults to: nil) —

  The IP address of the user

• irclickid (String, nil) (defaults to: nil)
• is_bot (String, nil) (defaults to: nil)
• job_title (String, nil) (defaults to: nil)
• last_name (String, nil) (defaults to: nil)
• li_fat_id (String, nil) (defaults to: nil)
• msclkid (String, nil) (defaults to: nil)
• ndclid (String, nil) (defaults to: nil)
• ob_click_id (String, nil) (defaults to: nil)
• oppref (String, nil) (defaults to: nil)
• phone_number (String, nil) (defaults to: nil)
• qclid (String, nil) (defaults to: nil)
• rdt_cid (String, nil) (defaults to: nil)
• referrer (String, nil) (defaults to: nil)
• referring_domain (String, nil) (defaults to: nil)
• sacid (String, nil) (defaults to: nil)
• sccid (String, nil) (defaults to: nil)
• sid (String, nil) (defaults to: nil)
• state (String, nil) (defaults to: nil)
• ttclid (String, nil) (defaults to: nil)
• twclid (String, nil) (defaults to: nil)
• user_agent (String, nil) (defaults to: nil)
• user_agent_full_list (String, nil) (defaults to: nil)
• utm_campaign (String, nil) (defaults to: nil)
• utm_content (String, nil) (defaults to: nil)
• utm_medium (String, nil) (defaults to: nil)
• utm_name (String, nil) (defaults to: nil)
• utm_source (String, nil) (defaults to: nil)
• utm_term (String, nil) (defaults to: nil)
• viant_click_id (String, nil) (defaults to: nil)
• viant_impression_id (String, nil) (defaults to: nil)
• wbraid (String, nil) (defaults to: nil)
• zip (String, nil) (defaults to: nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1148

Instance Attribute Details

#_ef_transaction_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 828

optional :_ef_transaction_id, String, nil?: true

#ad_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :ad_id, String, nil?: true

#admitad_uid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 838

optional :admitad_uid, String, nil?: true

#adset_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 843

optional :adset_id, String, nil?: true

#alart ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 848

optional :alart, String, nil?: true

#aleid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :aleid, String, nil?: true

#axwrt ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 858

optional :axwrt, String, nil?: true

#basis_cid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :basis_cid, String, nil?: true

#beeswax_auction_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 868

optional :beeswax_auction_id, String, nil?: true

#campaign_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 873

optional :campaign_id, String, nil?: true

#city ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 878

optional :city, String, nil?: true

#clickid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :clickid, String, nil?: true

#clid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 888

optional :clid, String, nil?: true

#company_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :company_name, String, nil?: true

#consent ⇒ Hash{Symbol=>String, nil}^?

Parameters:

• value (::Hash[Symbol, String?], nil)

Returns:

• (Hash{Symbol=>String, nil}, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 898

optional :consent, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true

#country ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 903

optional :country, String, nil?: true

#custom_properties ⇒ Hash{Symbol=>String, nil}^?

Parameters:

• value (::Hash[Symbol, String?], nil)

Returns:

• (Hash{Symbol=>String, nil}, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 908

optional :custom_properties,
OursprivacyIngest::Internal::Type::HashOf[String, nil?: true],
nil?: true

#date_of_birth ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 915

optional :date_of_birth, String, nil?: true

#dclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 920

optional :dclid, String, nil?: true

#email ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :email, String, nil?: true

#epik ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 930

optional :epik, String, nil?: true

#external_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :external_id, String, nil?: true

#fbc ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 940

optional :fbc, String, nil?: true

#fbclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 945

optional :fbclid, String, nil?: true

#fbp ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 950

optional :fbp, String, nil?: true

#first_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :first_name, String, nil?: true

#gad_source ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :gad_source, String, nil?: true

#gbraid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 965

optional :gbraid, String, nil?: true

#gclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 970

optional :gclid, String, nil?: true

#gender ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 975

optional :gender, String, nil?: true

#im_ref ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 980

optional :im_ref, String, nil?: true

#ip ⇒ String^?

The IP address of the user

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 986

optional :ip, String, nil?: true

#irclickid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :irclickid, String, nil?: true

#is_bot ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 996

optional :is_bot, String, nil?: true

#job_title ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1001

optional :job_title, String, nil?: true

#last_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1006

optional :last_name, String, nil?: true

#li_fat_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1011

optional :li_fat_id, String, nil?: true

#msclkid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1016

optional :msclkid, String, nil?: true

#ndclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1021

optional :ndclid, String, nil?: true

#ob_click_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1026

optional :ob_click_id, String, nil?: true

#oppref ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1031

optional :oppref, String, nil?: true

#phone_number ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1036

optional :phone_number, String, nil?: true

#qclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1041

optional :qclid, String, nil?: true

#rdt_cid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1046

optional :rdt_cid, String, nil?: true

#referrer ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1051

optional :referrer, String, nil?: true

#referring_domain ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1056

optional :referring_domain, String, nil?: true

#sacid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1061

optional :sacid, String, nil?: true

#sccid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1066

optional :sccid, String, nil?: true

#sid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1071

optional :sid, String, nil?: true

#state ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1076

optional :state, String, nil?: true

#ttclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1081

optional :ttclid, String, nil?: true

#twclid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1086

optional :twclid, String, nil?: true

#user_agent ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1091

optional :user_agent, String, nil?: true

#user_agent_full_list ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1096

optional :user_agent_full_list, String, nil?: true

#utm_campaign ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1101

optional :utm_campaign, String, nil?: true

#utm_content ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1106

optional :utm_content, String, nil?: true

#utm_medium ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1111

optional :utm_medium, String, nil?: true

#utm_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1116

optional :utm_name, String, nil?: true

#utm_source ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1121

optional :utm_source, String, nil?: true

#utm_term ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1126

optional :utm_term, String, nil?: true

#viant_click_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1131

optional :viant_click_id, String, nil?: true

#viant_impression_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1136

optional :viant_impression_id, String, nil?: true

#wbraid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1141

optional :wbraid, String, nil?: true

#zip ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/oursprivacy_ingest/models/batch_create_params.rb', line 1146

optional :zip, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/oursprivacy_ingest/models/batch_create_params.rbs', line 769

def to_hash: -> {