Class: Google::Apis::FirebaseV1beta1::WebAppConfig

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

Overview

Configuration metadata of a single Firebase App for the web.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WebAppConfig

Returns a new instance of WebAppConfig.



1503
1504
1505
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1503

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

Instance Attribute Details

#api_key ⇒ String

The keyString of the API key associated with the WebApp. Note that this value is not the apiKeyId (the UID) of the API key associated with the WebApp. Corresponds to the JSON property apiKey

Returns:

  • (String) 


1444
1445
1446
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1444

def api_key
  @api_key
end

#app_id ⇒ String

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. Corresponds to the JSON property appId

Returns:

  • (String) 


1449
1450
1451
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1449

def app_id
  @app_id
end

#auth_domain ⇒ String

The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com Corresponds to the JSON property authDomain

Returns:

  • (String) 


1455
1456
1457
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1455

def auth_domain
  @auth_domain
end

#database_url ⇒ String

The default Firebase Realtime Database URL. Corresponds to the JSON property databaseURL

Returns:

  • (String) 


1460
1461
1462
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1460

def database_url
  @database_url
end

#location_id ⇒ String

The ID of the Project's default GCP resource location. The location is one of the available GCP resource locations. This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the Project. Corresponds to the JSON property locationId

Returns:

  • (String) 


1470
1471
1472
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1470

def location_id
  @location_id
end

#measurement_id ⇒ String

The unique Google-assigned identifier of the Google Analytics web stream associated with the WebApp. Firebase SDKs use this ID to interact with Google Analytics APIs. This field is only present if the WebApp is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the Analytics documentation. To generate a measurementId and link the WebApp with a Google Analytics web stream, call AddGoogleAnalytics. For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches the measurementId when your app initializes Analytics. Having this ID in your config object is optional, but it does serve as a fallback in the rare case that the dynamic fetch fails. Corresponds to the JSON property measurementId

Returns:

  • (String) 


1486
1487
1488
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1486

def measurement_id
  @measurement_id
end

#messaging_sender_id ⇒ String

The sender ID for use with Firebase Cloud Messaging. Corresponds to the JSON property messagingSenderId

Returns:

  • (String) 


1491
1492
1493
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1491

def messaging_sender_id
  @messaging_sender_id
end

#project_id ⇒ String

Immutable. A user-assigned unique identifier for the FirebaseProject. Corresponds to the JSON property projectId

Returns:

  • (String) 


1496
1497
1498
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1496

def project_id
  @project_id
end

#storage_bucket ⇒ String

The default Cloud Storage for Firebase storage bucket name. Corresponds to the JSON property storageBucket

Returns:

  • (String) 


1501
1502
1503
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1501

def storage_bucket
  @storage_bucket
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1508

def update!(**args)
  @api_key = args[:api_key] if args.key?(:api_key)
  @app_id = args[:app_id] if args.key?(:app_id)
  @auth_domain = args[:auth_domain] if args.key?(:auth_domain)
  @database_url = args[:database_url] if args.key?(:database_url)
  @location_id = args[:location_id] if args.key?(:location_id)
  @measurement_id = args[:measurement_id] if args.key?(:measurement_id)
  @messaging_sender_id = args[:messaging_sender_id] if args.key?(:messaging_sender_id)
  @project_id = args[:project_id] if args.key?(:project_id)
  @storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
end