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.
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 the specified 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 the creation of a new AndroidApp in the specified FirebaseProject.
-
#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 ShaCertificate 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 the creation of a new IosApp in the specified FirebaseProject.
-
#create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation
Requests the creation of a new WebApp in the specified FirebaseProject.
-
#delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty
Removes a ShaCertificate 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 specified FirebaseProject.
-
#get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AdminSdkConfig
Gets the configuration artifact associated with the specified FirebaseProject, which can be 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 the specified FirebaseProject.
-
#get_project_android_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp
Gets the specified AndroidApp.
-
#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 specified IosApp.
-
#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 specified WebApp.
-
#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
Lists each Google Cloud Platform (GCP)
Project
that can have Firebase resources added to it. -
#list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse
Lists the 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 FirebaseProject.
-
#list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse
Lists the 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 FirebaseProject.
-
#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 FirebaseProject.
-
#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 specified FirebaseProject.
-
#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 specified AndroidApp.
-
#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 specified IosApp.
-
#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 specified WebApp.
-
#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, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse
Lists all available Apps for the specified FirebaseProject.
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
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
. 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
.
172 173 174 175 176 177 178 179 180 181 182 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 172 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 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
.
239 240 241 242 243 244 245 246 247 248 249 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 239 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 the creation of a new AndroidApp in the specified FirebaseProject.
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
.
580 581 582 583 584 585 586 587 588 589 590 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 580 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 ShaCertificate to the specified AndroidApp.
777 778 779 780 781 782 783 784 785 786 787 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 777 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 the creation of a new IosApp in the specified FirebaseProject. 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
.
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1008 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 the creation of a new WebApp in the specified FirebaseProject. 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
.
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1205 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 ShaCertificate from the specified AndroidApp.
816 817 818 819 820 821 822 823 824 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 816 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 locationId
. 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 underlying
GCP Project
already has an App Engine application or
FinalizeDefaultLocation
was previously called with a specified locationId
.
Any new calls to FinalizeDefaultLocation
with a different specified
locationId
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.
969 970 971 972 973 974 975 976 977 978 979 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 969 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.
115 116 117 118 119 120 121 122 123 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 115 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 specified FirebaseProject.
273 274 275 276 277 278 279 280 281 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 273 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 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.
309 310 311 312 313 314 315 316 317 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 309 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 the specified
FirebaseProject. If the FirebaseProject
is not yet linked to Google
Analytics, then the response to GetAnalyticsDetails
is NOT_FOUND
.
344 345 346 347 348 349 350 351 352 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 344 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 specified AndroidApp.
617 618 619 620 621 622 623 624 625 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 617 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.
652 653 654 655 656 657 658 659 660 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 652 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 specified IosApp.
1044 1045 1046 1047 1048 1049 1050 1051 1052 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1044 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.
1079 1080 1081 1082 1083 1084 1085 1086 1087 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1079 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 specified WebApp.
1241 1242 1243 1244 1245 1246 1247 1248 1249 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1241 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.
1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1276 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
Lists each Google Cloud Platform (GCP) Project
that can have Firebase resources
added to it. A Project will only be listed if: - The caller has sufficient
Google IAM permissions to call AddFirebase. -
The Project is not already a FirebaseProject. - The Project is not in an
Organization which has policies that prevent Firebase resources from being
added.
83 84 85 86 87 88 89 90 91 92 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 83 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
Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
852 853 854 855 856 857 858 859 860 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 852 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 FirebaseProject. 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
.
694 695 696 697 698 699 700 701 702 703 704 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 694 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
Lists the 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
the Project's 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
possible 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 unique project identifier (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.
909 910 911 912 913 914 915 916 917 918 919 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 909 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 FirebaseProject. 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
.
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1121 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 FirebaseProject. 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
.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1318 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.
387 388 389 390 391 392 393 394 395 396 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 387 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 specified FirebaseProject. All query parameters are required.
430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 430 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 specified AndroidApp.
738 739 740 741 742 743 744 745 746 747 748 749 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 738 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 specified IosApp.
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1165 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 specified WebApp.
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1362 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 project member must be an Owner for the FirebaseProject
.
476 477 478 479 480 481 482 483 484 485 486 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 476 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, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::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).
540 541 542 543 544 545 546 547 548 549 550 551 |
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 540 def search_project_apps(parent, filter: nil, 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['filter'] = filter unless filter.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 |