Class: Google::Apis::FirebasedynamiclinksV1::GetIosPostInstallAttributionResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firebasedynamiclinks_v1/classes.rb,
generated/google/apis/firebasedynamiclinks_v1/representations.rb,
generated/google/apis/firebasedynamiclinks_v1/representations.rb

Overview

Response for iSDK to execute strong match flow for post-install attribution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GetIosPostInstallAttributionResponse

Returns a new instance of GetIosPostInstallAttributionResponse



645
646
647
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 645

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_minimum_versionString

The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this. Corresponds to the JSON property appMinimumVersion

Returns:

  • (String)


559
560
561
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 559

def app_minimum_version
  @app_minimum_version
end

#attribution_confidenceString

The confidence of the returned attribution. Corresponds to the JSON property attributionConfidence

Returns:

  • (String)


564
565
566
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 564

def attribution_confidence
  @attribution_confidence
end

The deep-link attributed post-install via one of several techniques (fingerprint, copy unique). Corresponds to the JSON property deepLink

Returns:

  • (String)


570
571
572
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 570

def deep_link
  @deep_link
end

User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com Corresponds to the JSON property externalBrowserDestinationLink

Returns:

  • (String)


580
581
582
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 580

def external_browser_destination_link
  @external_browser_destination_link
end

The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter). Corresponds to the JSON property fallbackLink

Returns:

  • (String)


588
589
590
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 588

def fallback_link
  @fallback_link
end

#invitation_idString

Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique). Corresponds to the JSON property invitationId

Returns:

  • (String)


594
595
596
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 594

def invitation_id
  @invitation_id
end

#is_strong_match_executableBoolean Also known as: is_strong_match_executable?

Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false. Corresponds to the JSON property isStrongMatchExecutable

Returns:

  • (Boolean)


601
602
603
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 601

def is_strong_match_executable
  @is_strong_match_executable
end

#match_messageString

Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible. Corresponds to the JSON property matchMessage

Returns:

  • (String)


608
609
610
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 608

def match_message
  @match_message
end

#request_ip_versionString

Which IP version the request was made from. Corresponds to the JSON property requestIpVersion

Returns:

  • (String)


613
614
615
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 613

def request_ip_version
  @request_ip_version
end

Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique). Corresponds to the JSON property requestedLink

Returns:

  • (String)


619
620
621
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 619

def requested_link
  @requested_link
end

The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links). Corresponds to the JSON property resolvedLink

Returns:

  • (String)


628
629
630
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 628

def resolved_link
  @resolved_link
end

#utm_campaignString

Scion campaign value to be propagated by iSDK to Scion at post-install. Corresponds to the JSON property utmCampaign

Returns:

  • (String)


633
634
635
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 633

def utm_campaign
  @utm_campaign
end

#utm_mediumString

Scion medium value to be propagated by iSDK to Scion at post-install. Corresponds to the JSON property utmMedium

Returns:

  • (String)


638
639
640
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 638

def utm_medium
  @utm_medium
end

#utm_sourceString

Scion source value to be propagated by iSDK to Scion at post-install. Corresponds to the JSON property utmSource

Returns:

  • (String)


643
644
645
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 643

def utm_source
  @utm_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
# File 'generated/google/apis/firebasedynamiclinks_v1/classes.rb', line 650

def update!(**args)
  @app_minimum_version = args[:app_minimum_version] if args.key?(:app_minimum_version)
  @attribution_confidence = args[:attribution_confidence] if args.key?(:attribution_confidence)
  @deep_link = args[:deep_link] if args.key?(:deep_link)
  @external_browser_destination_link = args[:external_browser_destination_link] if args.key?(:external_browser_destination_link)
  @fallback_link = args[:fallback_link] if args.key?(:fallback_link)
  @invitation_id = args[:invitation_id] if args.key?(:invitation_id)
  @is_strong_match_executable = args[:is_strong_match_executable] if args.key?(:is_strong_match_executable)
  @match_message = args[:match_message] if args.key?(:match_message)
  @request_ip_version = args[:request_ip_version] if args.key?(:request_ip_version)
  @requested_link = args[:requested_link] if args.key?(:requested_link)
  @resolved_link = args[:resolved_link] if args.key?(:resolved_link)
  @utm_campaign = args[:utm_campaign] if args.key?(:utm_campaign)
  @utm_medium = args[:utm_medium] if args.key?(:utm_medium)
  @utm_source = args[:utm_source] if args.key?(:utm_source)
end