Class: Google::Apis::FirebasedynamiclinksV1::FirebaseDynamicLinksService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/firebasedynamiclinks_v1/service.rb

Overview

Firebase Dynamic Links API

Programmatically creates and manages Firebase Dynamic Links.

Examples:

require 'google/apis/firebasedynamiclinks_v1'

Firebasedynamiclinks = Google::Apis::FirebasedynamiclinksV1 # Alias the module
service = Firebasedynamiclinks::FirebaseDynamicLinksService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ FirebaseDynamicLinksService

Returns a new instance of FirebaseDynamicLinksService



45
46
47
48
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 45

def initialize
  super('https://firebasedynamiclinks-ipv6.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

Creates a short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. Repeated calls with the same long Dynamic Link or Dynamic Link information will produce the same short Dynamic Link. The Dynamic Link domain in the request must be owned by requester's Firebase project.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



75
76
77
78
79
80
81
82
83
84
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 75

def create_short_link_short_dynamic_link(create_short_dynamic_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/shortLinks', options)
  command.request_representation = Google::Apis::FirebasedynamiclinksV1::CreateShortDynamicLinkRequest::Representation
  command.request_object = create_short_dynamic_link_request_object
  command.response_representation = Google::Apis::FirebasedynamiclinksV1::CreateShortDynamicLinkResponse::Representation
  command.response_class = Google::Apis::FirebasedynamiclinksV1::CreateShortDynamicLinkResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_link_stats(dynamic_link, duration_days: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasedynamiclinksV1::DynamicLinkStats

Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens.

Parameters:

  • dynamic_link (String) —

    Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz

  • duration_days (Fixnum) —

    The span of time requested in days.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



110
111
112
113
114
115
116
117
118
119
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 110

def get_link_stats(dynamic_link, duration_days: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{dynamicLink}/linkStats', options)
  command.response_representation = Google::Apis::FirebasedynamiclinksV1::DynamicLinkStats::Representation
  command.response_class = Google::Apis::FirebasedynamiclinksV1::DynamicLinkStats
  command.params['dynamicLink'] = dynamic_link unless dynamic_link.nil?
  command.query['durationDays'] = duration_days unless duration_days.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#install_attribution(get_ios_post_install_attribution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasedynamiclinksV1::GetIosPostInstallAttributionResponse

Get iOS strong/weak-match info for post-install attribution.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



140
141
142
143
144
145
146
147
148
149
 
# File 'generated/google/apis/firebasedynamiclinks_v1/service.rb', line 140

def install_attribution(get_ios_post_install_attribution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/installAttribution', options)
  command.request_representation = Google::Apis::FirebasedynamiclinksV1::GetIosPostInstallAttributionRequest::Representation
  command.request_object = get_ios_post_install_attribution_request_object
  command.response_representation = Google::Apis::FirebasedynamiclinksV1::GetIosPostInstallAttributionResponse::Representation
  command.response_class = Google::Apis::FirebasedynamiclinksV1::GetIosPostInstallAttributionResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end