Class ProjectsResource

The "projects" collection of methods.

Inheritance

object

ProjectsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseManagement.v1beta1

Assembly: Google.Apis.FirebaseManagement.v1beta1.dll

Syntax

public class ProjectsResource

Constructors

ProjectsResource(IClientService)

Constructs a new resource.

Declaration

public ProjectsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

AndroidApps

Gets the AndroidApps resource.

Declaration

public virtual ProjectsResource.AndroidAppsResource AndroidApps { get; }

Property Value

Type	Description
ProjectsResource.AndroidAppsResource

AvailableLocations

Gets the AvailableLocations resource.

Declaration

public virtual ProjectsResource.AvailableLocationsResource AvailableLocations { get; }

Property Value

Type	Description
ProjectsResource.AvailableLocationsResource

DefaultLocation

Gets the DefaultLocation resource.

Declaration

public virtual ProjectsResource.DefaultLocationResource DefaultLocation { get; }

Property Value

Type	Description
ProjectsResource.DefaultLocationResource

IosApps

Gets the IosApps resource.

Declaration

public virtual ProjectsResource.IosAppsResource IosApps { get; }

Property Value

Type	Description
ProjectsResource.IosAppsResource

WebApps

Gets the WebApps resource.

Declaration

public virtual ProjectsResource.WebAppsResource WebApps { get; }

Property Value

Type	Description
ProjectsResource.WebAppsResource

Methods

AddFirebase(AddFirebaseRequest, string)

Adds Firebase resources and enables Firebase services in the specified existing Google Cloud Project. Since a FirebaseProject is actually also a Google Cloud Project, a FirebaseProject has the same underlying Google Cloud identifiers (projectNumber and projectId). This allows for easy interop with Google APIs. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to a FirebaseProject; if the Operation failed, its error is set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying Google Cloud Project. To call AddFirebase, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): firebase.projects.update, resourcemanager.projects.get, serviceusage.services.enable, and serviceusage.services.get.

Declaration

public virtual ProjectsResource.AddFirebaseRequest AddFirebase(AddFirebaseRequest body, string project)

Parameters

Type	Name	Description
AddFirebaseRequest	body	The body of the request.
string	project	The resource name of the Google Cloud Project in which Firebase resources will be added and Firebase services enabled, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values. After calling AddFirebase, the unique Project identifiers ( projectNumber and projectId) of the underlying Google Cloud Project are also the identifiers of the FirebaseProject.

Returns

Type	Description
ProjectsResource.AddFirebaseRequest

AddGoogleAnalytics(AddGoogleAnalyticsRequest, string)

Links the specified FirebaseProject with an existing Google Analytics account. Using this call, you can either: - Specify an analyticsAccountId to provision a new Google Analytics property within the specified account and associate the new property with the FirebaseProject. - Specify an existing analyticsPropertyId to associate the property with the FirebaseProject. Note that when you call AddGoogleAnalytics: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the FirebaseProject (based on the packageName or bundleId associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to AndroidApps and IosApps. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the Analytics documentation. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to an AnalyticsDetails; if the Operation failed, its error is set to a google.rpc.Status. To call AddGoogleAnalytics, a project member must be an Owner for the existing FirebaseProject and have the Edit permission for the Google Analytics account. If the FirebaseProject already has Google Analytics enabled, and you call AddGoogleAnalytics using an analyticsPropertyId that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying timeZone and regionCode in the call to AddFirebase.

Declaration

public virtual ProjectsResource.AddGoogleAnalyticsRequest AddGoogleAnalytics(AddGoogleAnalyticsRequest body, string parent)

Parameters

Type	Name	Description
AddGoogleAnalyticsRequest	body	The body of the request.
string	parent	The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.AddGoogleAnalyticsRequest

Get(string)

Gets the specified FirebaseProject.

Declaration

public virtual ProjectsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.GetRequest

GetAdminSdkConfig(string)

Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with the Firebase Admin SDK initializeApp command.

Declaration

public virtual ProjectsResource.GetAdminSdkConfigRequest GetAdminSdkConfig(string name)

Parameters

Type	Name	Description
string	name	The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/adminSdkConfig Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.GetAdminSdkConfigRequest

GetAnalyticsDetails(string)

Gets the Google Analytics details currently associated with the specified FirebaseProject. If the FirebaseProject is not yet linked to Google Analytics, then the response to GetAnalyticsDetails is NOT_FOUND.

Declaration

public virtual ProjectsResource.GetAnalyticsDetailsRequest GetAnalyticsDetails(string name)

Parameters

Type	Name	Description
string	name	The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/analyticsDetails Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.GetAnalyticsDetailsRequest

List()

Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a pageToken. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.

Declaration

public virtual ProjectsResource.ListRequest List()

Returns

Type	Description
ProjectsResource.ListRequest

Patch(FirebaseProject, string)

Updates the attributes of the specified FirebaseProject. All query parameters are required.

Declaration

public virtual ProjectsResource.PatchRequest Patch(FirebaseProject body, string name)

Parameters

Type	Name	Description
FirebaseProject	body	The body of the request.
string	name	The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId.

Returns

Type	Description
ProjectsResource.PatchRequest

RemoveAnalytics(RemoveAnalyticsRequest, string)

Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified FirebaseProject with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to the FirebaseProject by calling AddGoogleAnalytics and specifying the same analyticsPropertyId. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a new data stream for each Web App. To call RemoveAnalytics, a project member must be an Owner for the FirebaseProject.

Declaration

public virtual ProjectsResource.RemoveAnalyticsRequest RemoveAnalytics(RemoveAnalyticsRequest body, string parent)

Parameters

Type	Name	Description
RemoveAnalyticsRequest	body	The body of the request.
string	parent	The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.RemoveAnalyticsRequest

SearchApps(string)

Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

Declaration

public virtual ProjectsResource.SearchAppsRequest SearchApps(string parent)

Parameters

Type	Name	Description
string	parent	The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Returns

Type	Description
ProjectsResource.SearchAppsRequest