google_api_firebase v0.4.3 GoogleApi.Firebase.V1beta1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Adds Firebase resources to the specified existing
[Google Cloud Platform (GCP) Project
]
(https://cloud.google.com/resource-manager/reference/rest/v1/projects).
Links the specified FirebaseProject with an existing Google Analytics account.
Requests the creation of a new AndroidApp in the specified FirebaseProject.
Gets the specified AndroidApp.
Gets the configuration artifact associated with the specified AndroidApp.
Lists each AndroidApp associated with the specified FirebaseProject.
Updates the attributes of the specified AndroidApp.
Adds a ShaCertificate to the specified AndroidApp.
Removes a ShaCertificate from the specified AndroidApp.
Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).
Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.
Gets the specified FirebaseProject.
Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization.
Gets the Google Analytics details currently associated with the specified FirebaseProject.
Requests the creation of a new IosApp in the specified FirebaseProject.
Gets the specified IosApp.
Gets the configuration artifact associated with the specified IosApp.
Lists each IosApp associated with the specified FirebaseProject.
Updates the attributes of the specified IosApp.
Lists each FirebaseProject accessible to the caller.
Updates the attributes of the specified FirebaseProject.
Unlinks the specified FirebaseProject from its Google Analytics account.
Lists all available Apps for the specified FirebaseProject.
Requests the creation of a new WebApp in the specified FirebaseProject.
Gets the specified WebApp.
Gets the configuration artifact associated with the specified WebApp.
Lists each WebApp associated with the specified FirebaseProject.
Updates the attributes of the specified WebApp.
Link to this section Functions
firebase_projects_add_firebase(connection, project, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_add_firebase( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Adds Firebase resources to the specified existing
[Google Cloud Platform (GCP) Project
]
(https://cloud.google.com/resource-manager/reference/rest/v1/projects).
Since a FirebaseProject is actually also a GCP Project
, a
FirebaseProject
has the same underlying GCP identifiers (projectNumber
and projectId
). This allows for easy interop with Google APIs.
The result of this call is an Operation
.
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
.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverproject
(type:String.t
) - The resource name of the GCPProject
to which Firebase resources will be added, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.After calling
AddFirebase
, the unique Project identifiers (projectNumber
andprojectId
) of the underlying GCPProject
are also the identifiers of the FirebaseProject.optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.AddFirebaseRequest.t
) -
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebase_projects_add_google_analytics(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_add_google_analytics( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Links the specified FirebaseProject with an existing Google Analytics account.
Using this call, you can either:
- <li>Specify an `analyticsAccountId` to provision a new Google Analytics property within the specified account and associate the new property with the `FirebaseProject`.<li>Specify an existing `analyticsPropertyId` to associate the property with the `FirebaseProject`.</ul>Note that when you call `AddGoogleAnalytics`:<ol><li>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`.<li>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.</ol>Learn more about the hierarchy and structure of Google Analyticsaccounts in the[Analyticsdocumentation](https://support.google.com/analytics/answer/9303323).The result of this call is an [`Operation`](../../v1beta1/operations).Poll the `Operation` to track the provisioning process by callingGetOperation until[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When`done` is `true`, the `Operation` has either succeeded or failed. If the`Operation` succeeded, its[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set toan AnalyticsDetails; if the `Operation` failed, its[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to agoogle.rpc.Status.To call `AddGoogleAnalytics`, a project member must be an Owner forthe existing `FirebaseProject` and have the[`Edit` permission](https://support.google.com/analytics/answer/2884495)for the Google Analytics account.If the `FirebaseProject` already has Google Analytics enabled, and youcall `AddGoogleAnalytics` using an `analyticsPropertyId` that's differentfrom the currently associated property, then the call will fail. Analyticsmay have already been enabled in the Firebase console or by specifying`timeZone` and `regionCode` in the call to[`AddFirebase`](../../v1beta1/projects/addFirebase).## Parameters* `connection` (*type:* `GoogleApi.Firebase.V1beta1.Connection.t`) - Connection to server* `parent` (*type:* `String.t`) - The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about <var>PROJECT_IDENTIFIER</var> values.* `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. * `:alt` (*type:* `String.t`) - Data format for response. * `:callback` (*type:* `String.t`) - JSONP * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. * `:key` (*type:* `String.t`) - 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. * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. * `:quotaUser` (*type:* `String.t`) - 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. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). * `:body` (*type:* `GoogleApi.Firebase.V1beta1.Model.AddGoogleAnalyticsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options## Returns* `{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}` on success* `{:error, info}` on failure
firebase_projects_android_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.AndroidApp.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.AndroidApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the specified AndroidApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the AndroidApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/androidApps/<var>APP_ID</var></code> <br> Refer to theAndroidApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.AndroidApp{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_get_config(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_get_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.AndroidAppConfig.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the configuration artifact associated with the specified AndroidApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the AndroidApp configuration to download, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var>/config</code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/androidApps/<var>APP_ID</var></code> <br> Refer to theAndroidApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.AndroidAppConfig{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListAndroidAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - The resource name of the parent FirebaseProject for which to list each associated AndroidApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of Apps to return in the response.The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.
:pageToken
(type:String.t
) - Token returned from a previous call toListAndroidApps
indicating where in the set of Apps to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListAndroidAppsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.AndroidApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the attributes of the specified AndroidApp.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the AndroidApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></code>- <var>PROJECT_IDENTIFIER</var>: the parent Project's
ProjectNumber
(recommended) or itsProjectId
. Learn more about using project identifiers in Google's AIP 2510 standard. <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any response body will be theProjectId
. - <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
for the App
(see
appId
).
- <var>PROJECT_IDENTIFIER</var>: the parent Project's
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Specifies which fields to update.Note that the fields
name
,app_id
,project_id
, andpackage_name
are all immutable.:body
(type:GoogleApi.Firebase.V1beta1.Model.AndroidApp.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.AndroidApp{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_sha_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_sha_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ShaCertificate.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Adds a ShaCertificate to the specified AndroidApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the parent AndroidApp to which to add a ShaCertificate, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/androidApps/<var>APP_ID</var></code> <br> Refer to theAndroidApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.ShaCertificate.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ShaCertificate{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_sha_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_sha_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Removes a ShaCertificate from the specified AndroidApp.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the ShaCertificate to remove from the parent AndroidApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var>/sha/<var>SHA_HASH</var></code> Refer to theShaCertificate
name
field for details about <var>PROJECT_IDENTIFIER</var>, <var>APP_ID</var>, and <var>SHA_HASH</var> values.You can obtain the full resource name of the
ShaCertificate
from the response ofListShaCertificates
or the originalCreateShaCertificate
.optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
firebase_projects_android_apps_sha_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_android_apps_sha_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListShaCertificatesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the parent AndroidApp for which to list each associated ShaCertificate, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/androidApps/<var>APP_ID</var></code> <br> Refer to theAndroidApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListShaCertificatesResponse{}}
on success -
{:error, info}
on failure
firebase_projects_available_locations_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_available_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListAvailableLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - The FirebaseProject for which to list GCP resource locations, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.If no unique project identifier is specified (that is,
projects/-
), the returned list does not take into account org-specific or project-specific location restrictions.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of locations to return in the response.The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. This value cannot be negative.
:pageToken
(type:String.t
) - Token returned from a previous call toListAvailableLocations
indicating where in the list of locations to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListAvailableLocationsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_default_location_finalize(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_default_location_finalize( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the FirebaseProject for which the default GCP resource location will be set, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.FinalizeDefaultLocationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebase_projects_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Firebase.V1beta1.Model.FirebaseProject.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the specified FirebaseProject.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the FirebaseProject, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.FirebaseProject{}}
on success -
{:error, info}
on failure
firebase_projects_get_admin_sdk_config(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_get_admin_sdk_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.AdminSdkConfig.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the FirebaseProject, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/adminSdkConfig</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.AdminSdkConfig{}}
on success -
{:error, info}
on failure
firebase_projects_get_analytics_details(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_get_analytics_details( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.AnalyticsDetails.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the FirebaseProject, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/analyticsDetails</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.AnalyticsDetails{}}
on success -
{:error, info}
on failure
firebase_projects_ios_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_ios_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the parent FirebaseProject in which to create an IosApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.IosApp.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebase_projects_ios_apps_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_ios_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.IosApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the specified IosApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the IosApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/iosApps/<var>APP_ID</var></code> <br> Refer to theIosApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.IosApp{}}
on success -
{:error, info}
on failure
firebase_projects_ios_apps_get_config(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_ios_apps_get_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.IosAppConfig.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the configuration artifact associated with the specified IosApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the App configuration to download, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var>/config</code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/iosApps/<var>APP_ID</var></code> <br> Refer to theIosApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.IosAppConfig{}}
on success -
{:error, info}
on failure
firebase_projects_ios_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_ios_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListIosAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of Apps to return in the response.The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
:pageToken
(type:String.t
) - Token returned from a previous call toListIosApps
indicating where in the set of Apps to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListIosAppsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_ios_apps_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_ios_apps_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.IosApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the attributes of the specified IosApp.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the IosApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code>- <var>PROJECT_IDENTIFIER</var>: the parent Project's
ProjectNumber
(recommended) or itsProjectId
. Learn more about using project identifiers in Google's AIP 2510 standard. <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any response body will be theProjectId
. - <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
for the App (see
appId
).
- <var>PROJECT_IDENTIFIER</var>: the parent Project's
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Specifies which fields to update.Note that the fields
name
,appId
,projectId
, andbundleId
are all immutable.:body
(type:GoogleApi.Firebase.V1beta1.Model.IosApp.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.IosApp{}}
on success -
{:error, info}
on failure
firebase_projects_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListFirebaseProjectsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of Projects to return in the response.The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. This value cannot be negative.
:pageToken
(type:String.t
) - Token returned from a previous call toListFirebaseProjects
indicating where in the set of Projects to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListFirebaseProjectsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Firebase.V1beta1.Model.FirebaseProject.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the attributes of the specified FirebaseProject.
All query parameters are required.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the Project, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> <var>PROJECT_IDENTIFIER</var>: the Project'sProjectNumber
(recommended) or itsProjectId
. <br>Learn more about using project identifiers in Google's AIP 2510 standard. <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any response body will be theProjectId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Specifies which fields to update.If this list is empty, then no state will be updated. Note that the fields
name
,projectId
, andprojectNumber
are all immutable.:body
(type:GoogleApi.Firebase.V1beta1.Model.FirebaseProject.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.FirebaseProject{}}
on success -
{:error, info}
on failure
firebase_projects_remove_analytics(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_remove_analytics( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.RemoveAnalyticsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
firebase_projects_search_apps(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_search_apps( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.SearchFirebaseAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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).
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - The parent FirebaseProject for which to list Apps, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var></code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of Apps to return in the response.The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. This value cannot be negative.
:pageToken
(type:String.t
) - Token returned from a previous call toSearchFirebaseApps
indicating where in the set of Apps to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.SearchFirebaseAppsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_web_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_web_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The resource name of the parent FirebaseProject in which to create a WebApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Firebase.V1beta1.Model.WebApp.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebase_projects_web_apps_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_web_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.WebApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the specified WebApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the WebApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/webApps/<var>APP_ID</var></code> <br> Refer to theWebApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.WebApp{}}
on success -
{:error, info}
on failure
firebase_projects_web_apps_get_config(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_web_apps_get_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.WebAppConfig.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the configuration artifact associated with the specified WebApp.
Parameters
-
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the WebApp configuration to download, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var>/config</code> <br> Since an <var>APP_ID</var> is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: <code>projects/-/webApps/<var>APP_ID</var></code> <br> Refer to theWebApp
name
field for details about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.WebAppConfig{}}
on success -
{:error, info}
on failure
firebase_projects_web_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_web_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.ListWebAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps</code> Refer to theFirebaseProject
name
field for details about <var>PROJECT_IDENTIFIER</var> values.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of Apps to return in the response.The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.
:pageToken
(type:String.t
) - Token returned from a previous call toListWebApps
indicating where in the set of Apps to resume listing.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.ListWebAppsResponse{}}
on success -
{:error, info}
on failure
firebase_projects_web_apps_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
firebase_projects_web_apps_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firebase.V1beta1.Model.WebApp.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the attributes of the specified WebApp.
Parameters
connection
(type:GoogleApi.Firebase.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the WebApp, in the format: <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code>- <var>PROJECT_IDENTIFIER</var>: the parent Project's
ProjectNumber
(recommended) or itsProjectId
. Learn more about using project identifiers in Google's AIP 2510 standard. <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any response body will be theProjectId
. - <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
for the App (see
appId
).
- <var>PROJECT_IDENTIFIER</var>: the parent Project's
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Specifies which fields to update.Note that the fields
name
,appId
, andprojectId
are all immutable.:body
(type:GoogleApi.Firebase.V1beta1.Model.WebApp.t
) -
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firebase.V1beta1.Model.WebApp{}}
on success -
{:error, info}
on failure