Class: OursprivacyIngest::Resources::Visitor

Inherits:

Object

• Object
• OursprivacyIngest::Resources::Visitor

Defined in:

lib/oursprivacy_ingest/resources/visitor.rb

Instance Method Summary

• #initialize(client:) ⇒ Visitor constructor private

  A new instance of Visitor.

• #upsert(token:, user_properties:, default_properties: nil, email: nil, external_id: nil, identity_context: nil, user_id: nil, request_options: {}) ⇒ OursprivacyIngest::Models::VisitorUpsertResponse

  Some parameter documentations has been truncated, see Models::VisitorUpsertParams for more details.

Constructor Details

#initialize(client:) ⇒ Visitor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Visitor.

Parameters:

• client (OursprivacyIngest::Client)

# File 'lib/oursprivacy_ingest/resources/visitor.rb', line 56

def initialize(client:)
  @client = client
end

Instance Method Details

#upsert(token:, user_properties:, default_properties: nil, email: nil, external_id: nil, identity_context: nil, user_id: nil, request_options: {}) ⇒ OursprivacyIngest::Models::VisitorUpsertResponse

Some parameter documentations has been truncated, see Models::VisitorUpsertParams for more details.

Set or update properties on an existing visitor, or create a new visitor if no match is found. This fires a $identify event, making the call visible in the event stream. Identity resolution runs in priority order: userId (direct, no lookup) → externalId (lookup by your ID) → email (fallback lookup). When a visitor is found, their Ours Visitor ID is used going forward so all future events are attached to the same profile. For top-level visitor properties: null clears the existing value, while undefined, omitted fields, and empty strings are ignored. For entries inside custom_properties: null, undefined, and empty strings are all ignored (custom_properties use merge semantics). See docs.oursprivacy.com/docs/data-types for details and common pitfalls.

Parameters:

• token (String) —

  The token for your Source. You can find this in the dashboard.

• user_properties (OursprivacyIngest::Models::VisitorUpsertParams::UserProperties) —

  User properties to associate with this user. The existing user properties will b

• default_properties (OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties, nil) —

  These properties are used throughout the Ours app to pass known values onto dest

• email (String, nil) —

  The email address of a user. Used as a fallback lookup when neither userId nor e

• external_id (String, nil) —

  Your system’s unique identifier for this user. We search your account for an exi

• identity_context (OursprivacyIngest::Models::VisitorUpsertParams::IdentityContext, nil) —

  End-user network context for server-side calls. Required for probabilistic ident

• user_id (String, nil) —

  The Ours Visitor ID stored in local storage and cookies on your web properties.

• request_options (OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (OursprivacyIngest::Models::VisitorUpsertResponse)

See Also:

• Models::VisitorUpsertParams

# File 'lib/oursprivacy_ingest/resources/visitor.rb', line 41

def upsert(params)
  parsed, options = OursprivacyIngest::VisitorUpsertParams.dump_request(params)
  path = @client.base_url_overridden? ? "identify" : "https://api.oursprivacy.com/api/v1/identify"
  @client.request(
    method: :post,
    path: path,
    body: parsed,
    model: OursprivacyIngest::Models::VisitorUpsertResponse,
    options: options
  )
end