Documentation

Google_Service_FirebaseManagement_Resource_Projects extends Google_Service_Resource
in package

Application

The "projects" collection of methods.

Typical usage is: $firebaseService = new Google_Service_FirebaseManagement(...); $projects = $firebaseService->projects;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addFirebase() : Google_Service_FirebaseManagement_Operation: Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource- manager/reference/rest/v1/projects). 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. The result of this call is an [`Operation`](../../v1beta1/operations).
addGoogleAnalytics() : Google_Service_FirebaseManagement_Operation: Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). 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](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.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](https://support.google.com/analytics/answer/2884495) 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`](../../v1beta1/projects/addFirebase).
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_FirebaseManagement_FirebaseProject: Gets the specified FirebaseProject. (projects.get)
getAdminSdkConfig() : Google_Service_FirebaseManagement_AdminSdkConfig: Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization.
getAnalyticsDetails() : Google_Service_FirebaseManagement_AnalyticsDetails: 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`.
listProjects() : Google_Service_FirebaseManagement_ListFirebaseProjectsResponse: 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. (projects.listProjects)
patch() : Google_Service_FirebaseManagement_FirebaseProject: Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required. (projects.patch)
removeAnalytics() : Google_Service_FirebaseManagement_FirebaseEmpty: 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`](../../v1beta1/projects/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`. (projects.removeAnalytics)
searchApps() : Google_Service_FirebaseManagement_SearchFirebaseAppsResponse: 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). (projects.searchApps)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

addFirebase()

Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource- manager/reference/rest/v1/projects). 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. The result of this call is an [`Operation`](../../v1beta1/operations).


    public
                addFirebase(string $project, Google_Service_FirebaseManagement_AddFirebaseRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_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 GCP 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. (projects.addFirebase)

Parameters

$project : string: The resource name of the GCP Project to which Firebase resources will be added, 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](https://cloud.google.com/resource- manager/reference/rest/v1/projects#Project.FIELDS.project_number) and [projectId](https://cloud.google.com/resource- manager/reference/rest/v1/projects#Project.FIELDS.project_id)) of the underlying GCP Project are also the identifiers of the FirebaseProject.
$postBody : Google_Service_FirebaseManagement_AddFirebaseRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_Operation —

addGoogleAnalytics()

Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). 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](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.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](https://support.google.com/analytics/answer/2884495) 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`](../../v1beta1/projects/addFirebase).


    public
                addGoogleAnalytics(string $parent, Google_Service_FirebaseManagement_AddGoogleAnalyticsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_Operation

(projects.addGoogleAnalytics)

Parameters

$parent : string: 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.
$postBody : Google_Service_FirebaseManagement_AddGoogleAnalyticsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_Operation —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

get()

Gets the specified FirebaseProject. (projects.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_FirebaseProject

Parameters

$name : string: The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_FirebaseProject —

getAdminSdkConfig()

Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization.


    public
                getAdminSdkConfig(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_AdminSdkConfig

Typically, this configuration is used with the Firebase Admin SDK initialize App command. (projects.getAdminSdkConfig)

Parameters

$name : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_AdminSdkConfig —

getAnalyticsDetails()

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`.


    public
                getAnalyticsDetails(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_AnalyticsDetails

(projects.getAnalyticsDetails)

Parameters

$name : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_AnalyticsDetails —

listProjects()

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. (projects.listProjects)


    public
                listProjects([array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_ListFirebaseProjectsResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_ListFirebaseProjectsResponse —

patch()

Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required. (projects.patch)


    public
                patch(string $name, Google_Service_FirebaseManagement_FirebaseProject $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_FirebaseProject

Parameters

$name : string: 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.
$postBody : Google_Service_FirebaseManagement_FirebaseProject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_FirebaseProject —

removeAnalytics()

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`](../../v1beta1/projects/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`. (projects.removeAnalytics)


    public
                removeAnalytics(string $parent, Google_Service_FirebaseManagement_RemoveAnalyticsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_FirebaseEmpty

Parameters

$parent : string: 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.
$postBody : Google_Service_FirebaseManagement_RemoveAnalyticsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_FirebaseEmpty —

searchApps()

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). (projects.searchApps)


    public
                searchApps(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseManagement_SearchFirebaseAppsResponse

Parameters

$parent : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseManagement_SearchFirebaseAppsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —