View Source API Reference google_api_firebase v0.13.1

API client metadata for GoogleApi.Firebase.V1beta1.

API calls for all endpoints tagged AvailableProjects.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Firebase.V1beta1.

All fields are required.

Attributes

• analyticsAccountId (type: String.t, default: nil) - The ID for the existing Google Analytics account that you want to link with the FirebaseProject. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with the FirebaseProject.
• analyticsPropertyId (type: String.t, default: nil) - The ID for the existing Google Analytics property that you want to associate with the FirebaseProject.

Attributes

• databaseURL (type: String.t, default: nil) - DEPRECATED. Instead, find the default Firebase Realtime Database instance name using the list endpoint within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance. The default Firebase Realtime Database URL.
• locationId (type: String.t, default: nil) - DEPRECATED. Instead, use product-specific REST APIs to find the location of resources. 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.
• projectId (type: String.t, default: nil) - Immutable. A user-assigned unique identifier for the FirebaseProject. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
• storageBucket (type: String.t, default: nil) - DEPRECATED. Instead, find the default Cloud Storage for Firebase bucket using the list endpoint within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket. The default Cloud Storage for Firebase storage bucket name.

Attributes

• analyticsProperty (type: GoogleApi.Firebase.V1beta1.Model.AnalyticsProperty.t, default: nil) - The Analytics Property object associated with the specified FirebaseProject. This object contains the details of the Google Analytics property associated with the Project.
• streamMappings (type: list(GoogleApi.Firebase.V1beta1.Model.StreamMapping.t), default: nil) - - For AndroidApps and IosApps: a map of app to streamId for each Firebase App in the specified FirebaseProject. Each app and streamId appears only once. - For WebApps: a map of app to streamId and measurementId for each WebApp in the specified FirebaseProject. Each app, streamId, and measurementId appears only once.

Details of a Google Analytics property

Details of a Firebase App for Android.

Configuration metadata of a single Firebase App for Android.

DEPRECATED. Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the resources within the Project. Instead, retrieve information about each resource directly from its resource-specific API. The default auto-provisioned resources associated with the Project.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Attributes

• locationId (type: String.t, default: nil) - The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations.

A high-level summary of an App.

A FirebaseProject is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a FirebaseProject by calling AddFirebase and specifying an existing GCP Project. This adds Firebase resources to the existing GCP Project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs.

Details of a Firebase App for iOS.

Configuration metadata of a single Firebase App for iOS.

Attributes

• apps (type: list(GoogleApi.Firebase.V1beta1.Model.AndroidApp.t), default: nil) - List of each AndroidApp associated with the specified FirebaseProject.
• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListAndroidApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.

Attributes

• locations (type: list(GoogleApi.Firebase.V1beta1.Model.Location.t), default: nil) - One page of results from a call to ListAvailableLocations.
• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. This token can be used in a subsequent call to ListAvailableLocations to find more locations. Page tokens are short-lived and should not be persisted.

Attributes

• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to ListAvailableProjects to find the next group of Projects. Page tokens are short-lived and should not be persisted.
• projectInfo (type: list(GoogleApi.Firebase.V1beta1.Model.ProjectInfo.t), default: nil) - The list of GCP Projects which can have Firebase resources added to them.

Attributes

• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to ListFirebaseProjects to find the next group of Projects. Page tokens are short-lived and should not be persisted.
• results (type: list(GoogleApi.Firebase.V1beta1.Model.FirebaseProject.t), default: nil) - One page of the list of Projects that are accessible to the caller.

Attributes

• apps (type: list(GoogleApi.Firebase.V1beta1.Model.IosApp.t), default: nil) - List of each IosApp associated with the specified FirebaseProject.
• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListIosApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.

Attributes

• certificates (type: list(GoogleApi.Firebase.V1beta1.Model.ShaCertificate.t), default: nil) - The list of each ShaCertificate associated with the AndroidApp.

Attributes

• apps (type: list(GoogleApi.Firebase.V1beta1.Model.WebApp.t), default: nil) - List of each WebApp associated with the specified FirebaseProject.
• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListWebApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.

DEPRECATED. This Location is no longer used to determine Firebase resource locations. Instead, consult product documentation to determine valid locations for each resource used in your Project. A GCP resource location that can be selected for a FirebaseProject.

This is proto2's version of MessageSet.

This resource represents a long-running operation that is the result of a network API call.

Describes the progress of an LRO. It is included in the metadata field of the Operation.

Metadata about a long-running Product operation.

A reference to a Google Cloud Platform (GCP) Project.

Attributes

• analyticsPropertyId (type: String.t, default: nil) - Optional. The ID of the Google Analytics property associated with the specified FirebaseProject. - If not set, then the Google Analytics property that is currently associated with the specified FirebaseProject is removed. - If set, and the specified FirebaseProject is currently associated with a different Google Analytics property, then the response is a 412 Precondition Failed error.

Attributes

• allowMissing (type: boolean(), default: nil) - If set to true, and the App is not found, the request will succeed but no action will be taken on the server.
• etag (type: String.t, default: nil) - Checksum provided in the AndroidApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• immediate (type: boolean(), default: nil) - Determines whether to immediately delete the AndroidApp. If set to true, the App is immediately deleted from the Project and cannot be undeleted (that is, restored to the Project). If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteAndroidApp.
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be removed.

Attributes

• allowMissing (type: boolean(), default: nil) - If set to true, and the App is not found, the request will succeed but no action will be taken on the server.
• etag (type: String.t, default: nil) - Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• immediate (type: boolean(), default: nil) - Determines whether to immediately delete the IosApp. If set to true, the App is immediately deleted from the Project and cannot be undeleted (that is, restored to the Project). If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteIosApp
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be removed.

Attributes

• allowMissing (type: boolean(), default: nil) - If set to true, and the App is not found, the request will succeed but no action will be taken on the server.
• etag (type: String.t, default: nil) - Checksum provided in the WebApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• immediate (type: boolean(), default: nil) - Determines whether to immediately delete the WebApp. If set to true, the App is immediately deleted from the Project and cannot be undeleted (that is, restored to the Project). If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteWebApp
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be removed.

Attributes

• apps (type: list(GoogleApi.Firebase.V1beta1.Model.FirebaseAppInfo.t), default: nil) - One page of results from a call to SearchFirebaseApps.
• nextPageToken (type: String.t, default: nil) - If the result list is too large to fit in a single response, then a token is returned. This token can be used in a subsequent calls to SearchFirebaseApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.

A SHA-1 or SHA-256 certificate associated with the AndroidApp.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Wire-format for a Status object

A mapping of a Firebase App to a Google Analytics data stream

Attributes

• etag (type: String.t, default: nil) - Checksum provided in the AndroidApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be undeleted.

Attributes

• etag (type: String.t, default: nil) - Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be undeleted.

Attributes

• etag (type: String.t, default: nil) - Checksum provided in the WebApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
• validateOnly (type: boolean(), default: nil) - If set to true, the request is only validated. The App will not be undeleted.

Details of a Firebase App for the web.

Configuration metadata of a single Firebase App for the web.