Class: Google::Apis::FirebaseV1beta1::FirebaseManagementService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::FirebaseV1beta1::FirebaseManagementService
- Defined in:
- generated/google/apis/firebase_v1beta1/service.rb
Overview
Firebase Management API
The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Adds Firebase resources to the specified existing Google Cloud Platform (GCP)
Project
. -
#add_project_google_analytics(parent, add_google_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Links a FirebaseProject with an existing Google Analytics account.
-
#create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new AndroidApp be created.
-
#create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ShaCertificate
Adds a SHA certificate to the specified AndroidApp.
-
#create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new IosApp be created.
-
#create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new WebApp be created.
-
#delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty
Removes a SHA certificate from the specified AndroidApp.
-
#finalize_default_location(parent, finalize_default_location_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Gets the latest state of a long-running operation.
-
#get_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject
Gets the FirebaseProject identified by the specified resource name.
-
#get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AdminSdkConfig
Gets the configuration artifact used by servers to simplify initialization.
-
#get_project_analytics_details(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AnalyticsDetails
Gets the Google Analytics details currently associated with a FirebaseProject.
-
#get_project_android_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp
Gets the AndroidApp identified by the specified resource name.
-
#get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidAppConfig
Gets the configuration artifact associated with the specified AndroidApp.
-
#get_project_ios_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp
Gets the IosApp identified by the specified resource name.
-
#get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosAppConfig
Gets the configuration artifact associated with the specified IosApp.
-
#get_project_web_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp
Gets the WebApp identified by the specified resource name.
-
#get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebAppConfig
Gets the configuration artifact associated with the specified WebApp.
-
#initialize ⇒ FirebaseManagementService
constructor
A new instance of FirebaseManagementService.
-
#list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse
Returns a list of Google Cloud Platform (GCP)
Projects
that are available to have Firebase resources added to them. -
#list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse
Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.
-
#list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse
Lists each AndroidApp associated with the specified parent Project.
-
#list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse
Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).
-
#list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListIosAppsResponse
Lists each IosApp associated with the specified parent Project.
-
#list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListWebAppsResponse
Lists each WebApp associated with the specified parent Project.
-
#list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse
Lists each FirebaseProject accessible to the caller.
-
#patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject
Updates the attributes of the FirebaseProject identified by the specified resource name.
-
#patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp
Updates the attributes of the AndroidApp identified by the specified resource name.
-
#patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp
Updates the attributes of the IosApp identified by the specified resource name.
-
#patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp
Updates the attributes of the WebApp identified by the specified resource name.
-
#remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty
Unlinks the specified
FirebaseProject
from its Google Analytics account. -
#search_project_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse
A convenience method that lists all available Apps for the specified FirebaseProject.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ FirebaseManagementService
Returns a new instance of FirebaseManagementService.
46 47 48 49 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 46 def initialize super('https://firebase.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Adds Firebase resources to the specified existing
Google Cloud Platform (GCP) Project
.
Since a FirebaseProject is actually also a GCP Project
, a
FirebaseProject
uses underlying GCP identifiers (most importantly,
the projectId
) as its own for easy interop with GCP 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 GCP Project
.
To call AddFirebase
, a member must be an Editor or Owner for the
existing GCP Project
. Service accounts cannot call AddFirebase
.
187 188 189 190 191 192 193 194 195 196 197 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 187 def add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+project}:addFirebase', ) command.request_representation = Google::Apis::FirebaseV1beta1::AddFirebaseRequest::Representation command.request_object = add_firebase_request_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['project'] = project unless project.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#add_project_google_analytics(parent, add_google_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Links a 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 your `FirebaseProject`.
- Specify an existing `analyticsPropertyId` to associate the property with your `FirebaseProject`.
Note that when you call AddGoogleAnalytics
:
- The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in your `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 Android Apps and iOS Apps.
- If no corresponding data streams are found for your Firebase Apps, new data streams are provisioned in the Google Analytics property for each of your 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 your 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 member must be an Owner for
the existing FirebaseProject
and have the
Edit
permission
for the Google Analytics account.
If a 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
.
274 275 276 277 278 279 280 281 282 283 284 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 274 def add_project_google_analytics(parent, add_google_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}:addGoogleAnalytics', ) command.request_representation = Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest::Representation command.request_object = add_google_analytics_request_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new AndroidApp be created.
The result of this call is an Operation
which can be used to track
the provisioning process. The Operation
is automatically deleted after
completion, so there is no need to call DeleteOperation
.
611 612 613 614 615 616 617 618 619 620 621 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 611 def create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/androidApps', ) command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation command.request_object = android_app_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ShaCertificate
Adds a SHA certificate to the specified AndroidApp.
804 805 806 807 808 809 810 811 812 813 814 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 804 def create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/sha', ) command.request_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation command.request_object = sha_certificate_object command.response_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation command.response_class = Google::Apis::FirebaseV1beta1::ShaCertificate command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new IosApp be created.
The result of this call is an Operation
which can be used to track
the provisioning process. The Operation
is automatically deleted after
completion, so there is no need to call DeleteOperation
.
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1051 def create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/iosApps', ) command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation command.request_object = ios_app_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests that a new WebApp be created.
The result of this call is an Operation
which can be used to track
the provisioning process. The Operation
is automatically deleted after
completion, so there is no need to call DeleteOperation
.
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1243 def create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/webApps', ) command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty
Removes a SHA certificate from the specified AndroidApp.
841 842 843 844 845 846 847 848 849 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 841 def delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation command.response_class = Google::Apis::FirebaseV1beta1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#finalize_default_location(parent, finalize_default_location_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Sets the default Google Cloud Platform (GCP) resource location for the
specified FirebaseProject.
This method creates an App Engine application with a
default Cloud Storage
bucket,
located in the specified
location_id
.
This location must be one of the available
GCP resource
locations.
After the default GCP resource location is finalized, or if it was
already set, it cannot be changed. The default GCP resource location for
the specified FirebaseProject might already be set because either the
GCP Project
already has an App Engine application or
FinalizeDefaultLocation
was previously called with a specified
location_id
. Any new calls to FinalizeDefaultLocation
with a
different specified location_id
will return a 409 error.
The result of this call is an Operation
,
which can be used to track the provisioning process. The
response
type of
the Operation
is google.protobuf.Empty.
The Operation
can be polled by its name
using
GetOperation until done
is
true. When done
is true, the Operation
has either succeeded or failed.
If the Operation
has succeeded, its
response
will be
set to a google.protobuf.Empty; if the Operation
has failed, its
error
will be set to a google.rpc.Status. The Operation
is
automatically deleted after completion, so there is no need to call
DeleteOperation.
All fields listed in the request body are required.
To call FinalizeDefaultLocation
, a member must be an Owner
of the project.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1013 def finalize_default_location(parent, finalize_default_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/defaultLocation:finalize', ) command.request_representation = Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest::Representation command.request_object = finalize_default_location_request_object command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
125 126 127 128 129 130 131 132 133 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 125 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation command.response_class = Google::Apis::FirebaseV1beta1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject
Gets the FirebaseProject identified by the specified resource name.
307 308 309 310 311 312 313 314 315 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 307 def get_project(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AdminSdkConfig
Gets the configuration artifact used by servers to simplify initialization.
Typically, this configuration is used with the Firebase Admin SDK
initializeApp
command.
343 344 345 346 347 348 349 350 351 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 343 def get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::AdminSdkConfig::Representation command.response_class = Google::Apis::FirebaseV1beta1::AdminSdkConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_analytics_details(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AnalyticsDetails
Gets the Google Analytics details currently associated with a
FirebaseProject.
If the FirebaseProject
is not yet linked to Google Analytics, then
the response to GetAnalyticsDetails
is NOT_FOUND.
378 379 380 381 382 383 384 385 386 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 378 def get_project_analytics_details(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::AnalyticsDetails::Representation command.response_class = Google::Apis::FirebaseV1beta1::AnalyticsDetails command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_android_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp
Gets the AndroidApp identified by the specified resource name.
647 648 649 650 651 652 653 654 655 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 647 def get_project_android_app(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidAppConfig
Gets the configuration artifact associated with the specified AndroidApp.
683 684 685 686 687 688 689 690 691 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 683 def get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::AndroidAppConfig::Representation command.response_class = Google::Apis::FirebaseV1beta1::AndroidAppConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_ios_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp
Gets the IosApp identified by the specified resource name.
1087 1088 1089 1090 1091 1092 1093 1094 1095 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1087 def get_project_ios_app(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::IosApp command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosAppConfig
Gets the configuration artifact associated with the specified IosApp.
1121 1122 1123 1124 1125 1126 1127 1128 1129 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1121 def get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::IosAppConfig::Representation command.response_class = Google::Apis::FirebaseV1beta1::IosAppConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_web_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp
Gets the WebApp identified by the specified resource name.
1279 1280 1281 1282 1283 1284 1285 1286 1287 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1279 def get_project_web_app(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::WebApp command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebAppConfig
Gets the configuration artifact associated with the specified WebApp.
1313 1314 1315 1316 1317 1318 1319 1320 1321 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1313 def get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebaseV1beta1::WebAppConfig::Representation command.response_class = Google::Apis::FirebaseV1beta1::WebAppConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse
Returns a list of Google Cloud Platform (GCP) Projects
that are available to have Firebase resources added to them.
A GCP Project
will only be returned if:
The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.
The GCP `Project` is not already a FirebaseProject.
The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.
92 93 94 95 96 97 98 99 100 101 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 92 def list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/availableProjects', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse
Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.
876 877 878 879 880 881 882 883 884 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 876 def list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/sha', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse
Lists each AndroidApp associated with the specified parent Project.
The elements are returned in no particular order, but will be a
consistent view of the Apps when additional requests are made with a
pageToken
.
727 728 729 730 731 732 733 734 735 736 737 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 727 def list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/androidApps', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse
Returns a list of valid Google Cloud Platform (GCP) resource locations for
the specified Project (including a FirebaseProject).
One of these locations can be selected as the Project's default GCP
resource location,
which is the geographical location where project resources, such as Cloud
Firestore, will be provisioned by default. However, if the default GCP
resource location has already been set for the Project, then this setting
cannot be changed.
This call checks for any location restrictions for the specified
Project and, thus, might return a subset of all possible GCP resource
locations. To list all GCP resource locations (regardless of any
restrictions), call the endpoint without specifying a projectId
(that is,
/v1beta1/
parent=projects/-/listAvailableLocations
).
To call ListAvailableLocations
with a specified project, a member
must be at minimum a Viewer of the project. Calls without a specified
project do not require any specific project permissions.
939 940 941 942 943 944 945 946 947 948 949 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 939 def list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/availableLocations', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListIosAppsResponse
Lists each IosApp associated with the specified parent Project.
The elements are returned in no particular order, but will be a
consistent view of the Apps when additional requests are made with a
pageToken
.
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1165 def list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/iosApps', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListIosAppsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListIosAppsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListWebAppsResponse
Lists each WebApp associated with the specified parent Project.
The elements are returned in no particular order, but will be a
consistent view of the Apps when additional requests are made with a
pageToken
.
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1357 def list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/webApps', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListWebAppsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListWebAppsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::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.
430 431 432 433 434 435 436 437 438 439 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 430 def list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects', ) command.response_representation = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject
Updates the attributes of the FirebaseProject identified by the
specified resource name.
All query parameters are required.
472 473 474 475 476 477 478 479 480 481 482 483 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 472 def patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation command.request_object = firebase_project_object command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp
Updates the attributes of the AndroidApp identified by the specified resource name.
766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 766 def patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation command.request_object = android_app_object command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp
Updates the attributes of the IosApp identified by the specified resource name.
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1204 def patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation command.request_object = ios_app_object command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::IosApp command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp
Updates the attributes of the WebApp identified by the specified resource name.
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1396 def patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation command.response_class = Google::Apis::FirebaseV1beta1::WebApp command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty
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 member must be an Owner for
the FirebaseProject
.
524 525 526 527 528 529 530 531 532 533 534 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 524 def remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}:removeAnalytics', ) command.request_representation = Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest::Representation command.request_object = remove_analytics_request_object command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation command.response_class = Google::Apis::FirebaseV1beta1::Empty command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_project_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse
A convenience method that lists all available Apps for the specified
FirebaseProject.
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).
573 574 575 576 577 578 579 580 581 582 583 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 573 def search_project_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}:searchApps', ) command.response_representation = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse::Representation command.response_class = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |