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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firebase_v1beta1/classes.rb,
generated/google/apis/firebase_v1beta1/representations.rb,
generated/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.



1283
1284
1285
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1283

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

Instance Attribute Details

#api_keyString

The API key associated with the WebApp. Corresponds to the JSON property apiKey

Returns:

  • (String)


1224
1225
1226
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1224

def api_key
  @api_key
end

#app_idString

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

Returns:

  • (String)


1229
1230
1231
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1229

def app_id
  @app_id
end

#auth_domainString

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

Returns:

  • (String)


1235
1236
1237
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1235

def auth_domain
  @auth_domain
end

#database_urlString

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

Returns:

  • (String)


1240
1241
1242
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1240

def database_url
  @database_url
end

#location_idString

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)


1250
1251
1252
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1250

def location_id
  @location_id
end

#measurement_idString

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)


1266
1267
1268
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1266

def measurement_id
  @measurement_id
end

#messaging_sender_idString

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

Returns:

  • (String)


1271
1272
1273
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1271

def messaging_sender_id
  @messaging_sender_id
end

#project_idString

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

Returns:

  • (String)


1276
1277
1278
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1276

def project_id
  @project_id
end

#storage_bucketString

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

Returns:

  • (String)


1281
1282
1283
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1281

def storage_bucket
  @storage_bucket
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1288

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