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

Firebase Dynamic Links API enables third party developers to programmatically create and manage 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



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

def initialize
  super('https://firebasedynamiclinks.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.



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

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.



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

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:



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

def create_short_link_short_dynamic_link(create_short_dynamic_link_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end