Class: Google::Apis::CloudsearchV1::DeepLinkData

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Deep-linking data is used to construct a deep-link URI for an activity or frame's embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeepLinkData

Returns a new instance of DeepLinkData.



6565
6566
6567
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6565

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

Instance Attribute Details

#app_id ⇒ Fixnum

Application ID (or project ID) from Google API Console. Corresponds to the JSON property appId

Returns:

  • (Fixnum) 


6540
6541
6542
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6540

def app_id
  @app_id
end

#client ⇒ Array<Google::Apis::CloudsearchV1::PackagingServiceClient>

The data for a Google API Console client is entered by a developer during client registration and is stored in PackagingService. Corresponds to the JSON property client

Returns:



6546
6547
6548
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6546

def client
  @client
end

#deep_link_id ⇒ String

The ID for non-URL content. Embeds may either have no analogous web presence or prefer a native mobile experience if supported. In the case of no web presence, instead of setting the "url" field of an embed, such developers will set this field and other content fields, e.g. thumbnail, title, description. If set, this field is used to construct the deep-link URI. Note that the native experience is preferred over the web link and the web link is used as a fallback. Corresponds to the JSON property deepLinkId

Returns:

  • (String) 


6557
6558
6559
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6557

def deep_link_id
  @deep_link_id
end

#url ⇒ String

Analogous web presence. Used as desktop fallback or when no native link data is present. Corresponds to the JSON property url

Returns:

  • (String) 


6563
6564
6565
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6563

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6570
6571
6572
6573
6574
6575
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6570

def update!(**args)
  @app_id = args[:app_id] if args.key?(:app_id)
  @client = args[:client] if args.key?(:client)
  @deep_link_id = args[:deep_link_id] if args.key?(:deep_link_id)
  @url = args[:url] if args.key?(:url)
end