Documentation

Overview

Package firebase provides access to the Firebase Management API.

For product documentation, see: https://firebase.google.com

Creating a client

Usage example:

import "google.golang.org/api/firebase/v1beta1"
...
ctx := context.Background()
firebaseService, err := firebase.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

firebaseService, err := firebase.NewService(ctx, option.WithScopes(firebase.FirebaseReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

firebaseService, err := firebase.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
firebaseService, err := firebase.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

	// View and administer all your Firebase data and settings
	FirebaseScope = "https://www.googleapis.com/auth/firebase"

	// View all your Firebase data and settings
	FirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFirebaseRequest

type AddFirebaseRequest struct {
	// LocationId: Deprecated. Instead, to set a Project's default GCP
	// resource location, call `FinalizeDefaultLocation`
	// (../projects.defaultLocation/finalize) after you add Firebase
	// resources to the GCP `Project`. The ID of the Project's default GCP
	// resource location. The location must be one of the available GCP
	// resource locations
	// (https://firebase.google.com/docs/projects/locations).
	LocationId string `json:"locationId,omitempty"`

	// RegionCode: Deprecated. Instead, to link a Project with a Google
	// Analytics account, call `AddGoogleAnalytics`
	// (../../v1beta1/projects/addGoogleAnalytics) after you add Firebase
	// resources to the GCP `Project`. The region code (CLDR) that the
	// account will use for Google Analytics data For example: US, GB, or DE
	// In Java, use `com.google.i18n.identifiers.RegionCode`.
	RegionCode string `json:"regionCode,omitempty"`

	// TimeZone: Deprecated. Instead, to link a Project with a Google
	// Analytics account, call `AddGoogleAnalytics`
	// (../../v1beta1/projects/addGoogleAnalytics) after you add Firebase
	// resources to the GCP `Project`. The time zone that the account will
	// use for Google Analytics data. For example: America/Los_Angeles or
	// Africa/Abidjan
	TimeZone string `json:"timeZone,omitempty"`

	// ForceSendFields is a list of field names (e.g. "LocationId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "LocationId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddFirebaseRequest: All fields are required.

func (*AddFirebaseRequest) MarshalJSON

func (s *AddFirebaseRequest) MarshalJSON() ([]byte, error)

type AddGoogleAnalyticsRequest

type AddGoogleAnalyticsRequest struct {
	// AnalyticsAccountId: The ID for the existing Google Analytics account
	// (http://www.google.com/analytics/) that you want to link with the
	// `FirebaseProject`. Specifying this field will provision a new Google
	// Analytics property in your Google Analytics account and associate the
	// new property with the `FirebaseProject`.
	AnalyticsAccountId string `json:"analyticsAccountId,omitempty"`

	// AnalyticsPropertyId: The ID for the existing Google Analytics
	// property that you want to associate with the `FirebaseProject`.
	AnalyticsPropertyId string `json:"analyticsPropertyId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AnalyticsAccountId")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnalyticsAccountId") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*AddGoogleAnalyticsRequest) MarshalJSON

func (s *AddGoogleAnalyticsRequest) MarshalJSON() ([]byte, error)

type AdminSdkConfig

type AdminSdkConfig struct {
	// DatabaseURL: The default Firebase Realtime Database URL.
	DatabaseURL string `json:"databaseURL,omitempty"`

	// LocationId: The ID of the Project's default GCP resource location.
	// The location is one of the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations). This field is
	// omitted if the default GCP resource location has not been finalized
	// yet. To set a Project's default GCP resource location, call
	// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
	// after you add Firebase resources to the Project.
	LocationId string `json:"locationId,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier for the
	// `FirebaseProject`. This identifier may appear in URLs or names for
	// some Firebase resources associated with the Project, but it should
	// generally be treated as a convenience alias to reference the Project.
	ProjectId string `json:"projectId,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket
	// name.
	StorageBucket string `json:"storageBucket,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DatabaseURL") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatabaseURL") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdminSdkConfig) MarshalJSON

func (s *AdminSdkConfig) MarshalJSON() ([]byte, error)

type AnalyticsDetails

type AnalyticsDetails struct {
	// AnalyticsProperty: The Analytics Property object associated with the
	// specified `FirebaseProject`. This object contains the details of the
	// Google Analytics property associated with the Project.
	AnalyticsProperty *AnalyticsProperty `json:"analyticsProperty,omitempty"`

	// StreamMappings:  - For `AndroidApps` and `IosApps`: a map of `app` to
	// `streamId` for each Firebase App in the specified `FirebaseProject`.
	// Each `app` and `streamId` appears only once. - For `WebApps`: a map
	// of `app` to `streamId` and `measurementId` for each `WebApp` in the
	// specified `FirebaseProject`. Each `app`, `streamId`, and
	// `measurementId` appears only once.
	StreamMappings []*StreamMapping `json:"streamMappings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AnalyticsProperty")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnalyticsProperty") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*AnalyticsDetails) MarshalJSON

func (s *AnalyticsDetails) MarshalJSON() ([]byte, error)

type AnalyticsProperty

type AnalyticsProperty struct {
	// DisplayName: The display name of the Google Analytics property
	// associated with the specified `FirebaseProject`.
	DisplayName string `json:"displayName,omitempty"`

	// Id: The globally unique, Google-assigned identifier of the Google
	// Analytics property associated with the specified `FirebaseProject`.
	// If you called `AddGoogleAnalytics`
	// (../../v1beta1/projects/addGoogleAnalytics) to link the
	// `FirebaseProject` with a Google Analytics account, the value in this
	// `id` field is the same as the ID of the property either specified or
	// provisioned with that call to `AddGoogleAnalytics`.
	Id string `json:"id,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AnalyticsProperty: Details of a Google Analytics property

func (*AnalyticsProperty) MarshalJSON

func (s *AnalyticsProperty) MarshalJSON() ([]byte, error)

type AndroidApp

type AndroidApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// for the `AndroidApp`. This identifier should be treated as an opaque
	// token, as the data format is not specified.
	AppId string `json:"appId,omitempty"`

	// DisplayName: The user-assigned display name for the `AndroidApp`.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The resource name of the AndroidApp, in the format: projects/
	// PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the
	// parent Project's `ProjectNumber`
	// (../projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
	// using project identifiers in Google's AIP 2510 standard
	// (https://google.aip.dev/cloud/2510). Note that the value for
	// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
	// APP_ID: the globally unique, Firebase-assigned identifier for the App
	// (see `appId` (../projects.androidApps#AndroidApp.FIELDS.app_id)).
	Name string `json:"name,omitempty"`

	// PackageName: Immutable. The canonical package name of the Android app
	// as would appear in the Google Play Developer Console.
	PackageName string `json:"packageName,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier of the parent
	// FirebaseProject for the `AndroidApp`.
	ProjectId string `json:"projectId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AppId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AndroidApp: Details of a Firebase App for Android.

func (*AndroidApp) MarshalJSON

func (s *AndroidApp) MarshalJSON() ([]byte, error)

type AndroidAppConfig

type AndroidAppConfig struct {
	// ConfigFileContents: The contents of the JSON configuration file.
	ConfigFileContents string `json:"configFileContents,omitempty"`

	// ConfigFilename: The filename that the configuration artifact for the
	// `AndroidApp` is typically saved as. For example:
	// `google-services.json`
	ConfigFilename string `json:"configFilename,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConfigFileContents") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AndroidAppConfig: Configuration metadata of a single Firebase App for Android.

func (*AndroidAppConfig) MarshalJSON

func (s *AndroidAppConfig) MarshalJSON() ([]byte, error)

type AvailableProjectsListCall

type AvailableProjectsListCall struct {
	// contains filtered or unexported fields
}

func (*AvailableProjectsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AvailableProjectsListCall) Do

Do executes the "firebase.availableProjects.list" call. Exactly one of *ListAvailableProjectsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAvailableProjectsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AvailableProjectsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AvailableProjectsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AvailableProjectsListCall) IfNoneMatch

func (c *AvailableProjectsListCall) IfNoneMatch(entityTag string) *AvailableProjectsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AvailableProjectsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Projects 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), the server will impose its own limit. This value cannot be negative.

func (*AvailableProjectsListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListAvailableProjects` indicating where in the set of Projects to resume listing.

func (*AvailableProjectsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AvailableProjectsService

type AvailableProjectsService struct {
	// contains filtered or unexported fields
}

func NewAvailableProjectsService

func NewAvailableProjectsService(s *Service) *AvailableProjectsService

func (*AvailableProjectsService) List

List: Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added to it. A Project will only be listed if: - The caller has sufficient Google IAM (https://cloud.google.com/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.

type DefaultResources

type DefaultResources struct {
	// HostingSite: The default Firebase Hosting site name, in the format:
	// PROJECT_ID Though rare, your `projectId` might already be used as the
	// name for an existing Hosting site in another project (learn more
	// about creating non-default, additional sites
	// (https://firebase.google.com/docs/hosting/multisites)). In these
	// cases, your `projectId` is appended with a hyphen then five
	// alphanumeric characters to create your default Hosting site name. For
	// example, if your `projectId` is `myproject123`, your default Hosting
	// site name might be: `myproject123-a5c16`
	HostingSite string `json:"hostingSite,omitempty"`

	// LocationId: The ID of the Project's default GCP resource location.
	// The location is one of the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations). This field is
	// omitted if the default GCP resource location has not been finalized
	// yet. To set a Project's default GCP resource location, call
	// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
	// after you add Firebase resources to the Project.
	LocationId string `json:"locationId,omitempty"`

	// RealtimeDatabaseInstance: The default Firebase Realtime Database
	// instance name, in the format: PROJECT_ID Though rare, your
	// `projectId` might already be used as the name for an existing
	// Realtime Database instance in another project (learn more about
	// database sharding
	// (https://firebase.google.com/docs/database/usage/sharding)). In these
	// cases, your `projectId` is appended with a hyphen then five
	// alphanumeric characters to create your default Realtime Database
	// instance name. For example, if your `projectId` is `myproject123`,
	// your default database instance name might be: `myproject123-a5c16`
	RealtimeDatabaseInstance string `json:"realtimeDatabaseInstance,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket,
	// in the format: PROJECT_ID.appspot.com
	StorageBucket string `json:"storageBucket,omitempty"`

	// ForceSendFields is a list of field names (e.g. "HostingSite") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "HostingSite") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DefaultResources: The default resources associated with the Project.

func (*DefaultResources) MarshalJSON

func (s *DefaultResources) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

type FinalizeDefaultLocationRequest

type FinalizeDefaultLocationRequest struct {
	// LocationId: The ID of the Project's default GCP resource location.
	// The location must be one of the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations).
	LocationId string `json:"locationId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "LocationId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "LocationId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*FinalizeDefaultLocationRequest) MarshalJSON

func (s *FinalizeDefaultLocationRequest) MarshalJSON() ([]byte, error)

type FirebaseAppInfo

type FirebaseAppInfo struct {
	// AppId: Output only. Immutable. The globally unique, Firebase-assigned
	// identifier for the `WebApp`. This identifier should be treated as an
	// opaque token, as the data format is not specified.
	AppId string `json:"appId,omitempty"`

	// DisplayName: The user-assigned display name of the Firebase App.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The resource name of the Firebase App, in the format:
	// projects/PROJECT_ID /iosApps/APP_ID or
	// projects/PROJECT_ID/androidApps/APP_ID or projects/
	// PROJECT_ID/webApps/APP_ID
	Name string `json:"name,omitempty"`

	// Namespace: Output only. Immutable. The platform-specific identifier
	// of the App. *Note:* For most use cases, use `appId`, which is the
	// canonical, globally unique identifier for referencing an App. This
	// string is derived from a native identifier for each platform:
	// `packageName` for an `AndroidApp`, `bundleId` for an `IosApp`, and
	// `webId` for a `WebApp`. Its contents should be treated as opaque, as
	// the native identifier format may change as platforms evolve. This
	// string is only unique within a `FirebaseProject` and its associated
	// Apps.
	Namespace string `json:"namespace,omitempty"`

	// Platform: The platform of the Firebase App.
	//
	// Possible values:
	//   "PLATFORM_UNSPECIFIED" - Unknown state. This is only used for
	// distinguishing unset values.
	//   "IOS" - The Firebase App is associated with iOS.
	//   "ANDROID" - The Firebase App is associated with Android.
	//   "WEB" - The Firebase App is associated with web.
	Platform string `json:"platform,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FirebaseAppInfo: A high-level summary of an App.

func (*FirebaseAppInfo) MarshalJSON

func (s *FirebaseAppInfo) MarshalJSON() ([]byte, error)

type FirebaseProject

type FirebaseProject struct {
	// DisplayName: The user-assigned display name of the Project.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The resource name of the Project, in the format:
	// projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's
	// `ProjectNumber` (../projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
	// using project identifiers in Google's AIP 2510 standard
	// (https://google.aip.dev/cloud/2510). Note that the value for
	// PROJECT_IDENTIFIER in any response body will be the `ProjectId`.
	Name string `json:"name,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier for the
	// Project. This identifier may appear in URLs or names for some
	// Firebase resources associated with the Project, but it should
	// generally be treated as a convenience alias to reference the Project.
	ProjectId string `json:"projectId,omitempty"`

	// ProjectNumber: Immutable. The globally unique, Google-assigned
	// canonical identifier for the Project. Use this identifier when
	// configuring integrations and/or making API calls to Firebase or
	// third-party services.
	ProjectNumber int64 `json:"projectNumber,omitempty,string"`

	// Resources: The default Firebase resources associated with the
	// Project.
	Resources *DefaultResources `json:"resources,omitempty"`

	// State: Output only. The lifecycle state of the Project. Updates to
	// the state must be performed via
	// com.google.cloudresourcemanager.v1.Projects.DeleteProject and
	// com.google.cloudresourcemanager.v1.Projects.UndeleteProject
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "ACTIVE" - The normal and active state.
	//   "DELETED" - The Project has been marked for deletion by the user.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FirebaseProject: A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* GCP `Project` (https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing 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.

func (*FirebaseProject) MarshalJSON

func (s *FirebaseProject) MarshalJSON() ([]byte, error)

type IosApp

type IosApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// for the `IosApp`. This identifier should be treated as an opaque
	// token, as the data format is not specified.
	AppId string `json:"appId,omitempty"`

	// AppStoreId: The automatically generated Apple ID assigned to the iOS
	// app by Apple in the iOS App Store.
	AppStoreId string `json:"appStoreId,omitempty"`

	// BundleId: Immutable. The canonical bundle ID of the iOS app as it
	// would appear in the iOS AppStore.
	BundleId string `json:"bundleId,omitempty"`

	// DisplayName: The user-assigned display name for the `IosApp`.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The resource name of the IosApp, in the format:
	// projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the
	// parent Project's `ProjectNumber`
	// (../projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
	// using project identifiers in Google's AIP 2510 standard
	// (https://google.aip.dev/cloud/2510). Note that the value for
	// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
	// APP_ID: the globally unique, Firebase-assigned identifier for the App
	// (see `appId` (../projects.iosApps#IosApp.FIELDS.app_id)).
	Name string `json:"name,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier of the parent
	// FirebaseProject for the `IosApp`.
	ProjectId string `json:"projectId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AppId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IosApp: Details of a Firebase App for iOS.

func (*IosApp) MarshalJSON

func (s *IosApp) MarshalJSON() ([]byte, error)

type IosAppConfig

type IosAppConfig struct {
	// ConfigFileContents: The content of the XML configuration file.
	ConfigFileContents string `json:"configFileContents,omitempty"`

	// ConfigFilename: The filename that the configuration artifact for the
	// `IosApp` is typically saved as. For example:
	// `GoogleService-Info.plist`
	ConfigFilename string `json:"configFilename,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConfigFileContents") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

IosAppConfig: Configuration metadata of a single Firebase App for iOS.

func (*IosAppConfig) MarshalJSON

func (s *IosAppConfig) MarshalJSON() ([]byte, error)

type ListAndroidAppsResponse

type ListAndroidAppsResponse struct {
	// Apps: List of each `AndroidApp` associated with the specified
	// `FirebaseProject`.
	Apps []*AndroidApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results. This token can be used in a
	// subsequent call to `ListAndroidApps` to find the next group of Apps.
	// Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListAndroidAppsResponse) MarshalJSON

func (s *ListAndroidAppsResponse) MarshalJSON() ([]byte, error)

type ListAvailableLocationsResponse

type ListAvailableLocationsResponse struct {
	// Locations: One page of results from a call to
	// `ListAvailableLocations`.
	Locations []*Location `json:"locations,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results and all available locations have
	// been listed. This token can be used in a subsequent call to
	// `ListAvailableLocations` to find more locations. Page tokens are
	// short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Locations") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListAvailableLocationsResponse) MarshalJSON

func (s *ListAvailableLocationsResponse) MarshalJSON() ([]byte, error)

type ListAvailableProjectsResponse

type ListAvailableProjectsResponse struct {
	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results. This token can be used in a
	// subsequent calls to `ListAvailableProjects` to find the next group of
	// Projects. Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ProjectInfo: The list of GCP `Projects` which can have Firebase
	// resources added to them.
	ProjectInfo []*ProjectInfo `json:"projectInfo,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListAvailableProjectsResponse) MarshalJSON

func (s *ListAvailableProjectsResponse) MarshalJSON() ([]byte, error)

type ListFirebaseProjectsResponse

type ListFirebaseProjectsResponse struct {
	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results. This token can be used in a
	// subsequent calls to `ListFirebaseProjects` to find the next group of
	// Projects. Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Results: One page of the list of Projects that are accessible to the
	// caller.
	Results []*FirebaseProject `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListFirebaseProjectsResponse) MarshalJSON

func (s *ListFirebaseProjectsResponse) MarshalJSON() ([]byte, error)

type ListIosAppsResponse

type ListIosAppsResponse struct {
	// Apps: List of each `IosApp` associated with the specified
	// `FirebaseProject`.
	Apps []*IosApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results. This token can be used in a
	// subsequent call to `ListIosApps` to find the next group of Apps. Page
	// tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListIosAppsResponse) MarshalJSON

func (s *ListIosAppsResponse) MarshalJSON() ([]byte, error)

type ListShaCertificatesResponse

type ListShaCertificatesResponse struct {
	// Certificates: The list of each `ShaCertificate` associated with the
	// `AndroidApp`.
	Certificates []*ShaCertificate `json:"certificates,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Certificates") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Certificates") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListShaCertificatesResponse) MarshalJSON

func (s *ListShaCertificatesResponse) MarshalJSON() ([]byte, error)

type ListWebAppsResponse

type ListWebAppsResponse struct {
	// Apps: List of each `WebApp` associated with the specified
	// `FirebaseProject`.
	Apps []*WebApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty, then this
	// response is the last page of results. This token can be used in a
	// subsequent call to `ListWebApps` to find the next group of Apps. Page
	// tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListWebAppsResponse) MarshalJSON

func (s *ListWebAppsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// Features: Products and services that are available in the GCP
	// resource location.
	//
	// Possible values:
	//   "LOCATION_FEATURE_UNSPECIFIED" - Used internally for distinguishing
	// unset values and is not intended for external use.
	//   "FIRESTORE" - This location supports Cloud Firestore database
	// instances. App Engine is available in this location, so it can be a
	// Project's [default GCP resource
	// location](//firebase.google.com/docs/projects/locations#default-cloud-
	// location).
	//   "DEFAULT_STORAGE" - This location supports default Cloud Storage
	// buckets. App Engine is available in this location, so it can be a
	// Project's [default GCP resource
	// location](//firebase.google.com/docs/projects/locations#default-cloud-
	// location).
	//   "FUNCTIONS" - Cloud Functions for Firebase is available in this
	// location.
	Features []string `json:"features,omitempty"`

	// LocationId: The ID of the GCP resource location. It will be one of
	// the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations#types).
	LocationId string `json:"locationId,omitempty"`

	// Type: Indicates whether the GCP resource location is a regional or
	// multi-regional location
	// (https://firebase.google.com/docs/projects/locations#types) for data
	// replication.
	//
	// Possible values:
	//   "LOCATION_TYPE_UNSPECIFIED" - Used internally for distinguishing
	// unset values and is not intended for external use.
	//   "REGIONAL" - The location is a regional location. Data in a
	// regional location is replicated in multiple zones within a region.
	//   "MULTI_REGIONAL" - The location is a multi-regional location. Data
	// in a multi-region location is replicated in multiple regions. Within
	// each region, data is replicated in multiple zones.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Features") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Features") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Location: A GCP resource location that can be selected for a FirebaseProject.

func (*Location) MarshalJSON

func (s *Location) MarshalJSON() ([]byte, error)

type MessageSet

type MessageSet struct {
}

MessageSet: This is proto2's version of MessageSet.

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. If
	// the original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationsGetCall

type OperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsGetCall) Do

Do executes the "firebase.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsGetCall) Header

func (c *OperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*OperationsGetCall) IfNoneMatch

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OperationsService

type OperationsService struct {
	// contains filtered or unexported fields
}

func NewOperationsService

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Get

Get: 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.

- name: The name of the operation resource.

type ProjectInfo

type ProjectInfo struct {
	// DisplayName: The user-assigned display name of the GCP `Project`, for
	// example: `My App`
	DisplayName string `json:"displayName,omitempty"`

	// LocationId: The ID of the Project's default GCP resource location.
	// The location is one of the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations). Not all
	// Projects will have this field populated. If it is not populated, it
	// means that the Project does not yet have a default GCP resource
	// location. To set a Project's default GCP resource location, call
	// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
	// after you add Firebase resources to the Project.
	LocationId string `json:"locationId,omitempty"`

	// Project: The resource name of the GCP `Project` to which Firebase
	// resources can be added, in the format: projects/PROJECT_IDENTIFIER
	// Refer to the `FirebaseProject` `name`
	// (../projects#FirebaseProject.FIELDS.name) field for details about
	// PROJECT_IDENTIFIER values.
	Project string `json:"project,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ProjectInfo: A reference to a Google Cloud Platform (GCP) `Project`.

func (*ProjectInfo) MarshalJSON

func (s *ProjectInfo) MarshalJSON() ([]byte, error)

type ProjectsAddFirebaseCall

type ProjectsAddFirebaseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAddFirebaseCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAddFirebaseCall) Do

Do executes the "firebase.projects.addFirebase" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAddFirebaseCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAddFirebaseCall) Header

func (c *ProjectsAddFirebaseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAddGoogleAnalyticsCall

type ProjectsAddGoogleAnalyticsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAddGoogleAnalyticsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAddGoogleAnalyticsCall) Do

Do executes the "firebase.projects.addGoogleAnalytics" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAddGoogleAnalyticsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAddGoogleAnalyticsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAndroidAppsCreateCall

type ProjectsAndroidAppsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsCreateCall) Do

Do executes the "firebase.projects.androidApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAndroidAppsGetCall

type ProjectsAndroidAppsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsGetCall) Do

Do executes the "firebase.projects.androidApps.get" call. Exactly one of *AndroidApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAndroidAppsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsGetConfigCall

type ProjectsAndroidAppsGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsGetConfigCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsGetConfigCall) Do

Do executes the "firebase.projects.androidApps.getConfig" call. Exactly one of *AndroidAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidAppConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsGetConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsGetConfigCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAndroidAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsListCall

type ProjectsAndroidAppsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsListCall) Do

Do executes the "firebase.projects.androidApps.list" call. Exactly one of *ListAndroidAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAndroidAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAndroidAppsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAndroidAppsListCall) PageSize

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsAndroidAppsListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing.

func (*ProjectsAndroidAppsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsAndroidAppsPatchCall

type ProjectsAndroidAppsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsPatchCall) Do

Do executes the "firebase.projects.androidApps.patch" call. Exactly one of *AndroidApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAndroidAppsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. Note that the fields `name`, `app_id`, `project_id`, and `package_name` are all immutable.

type ProjectsAndroidAppsService

type ProjectsAndroidAppsService struct {
	Sha *ProjectsAndroidAppsShaService
	// contains filtered or unexported fields
}

func NewProjectsAndroidAppsService

func NewProjectsAndroidAppsService(s *Service) *ProjectsAndroidAppsService

func (*ProjectsAndroidAppsService) Create

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

- parent: The resource name of the parent FirebaseProject in which to

create an AndroidApp, in the format:
projects/PROJECT_IDENTIFIER/androidApps Refer to the
`FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
field for details about PROJECT_IDENTIFIER values.

func (*ProjectsAndroidAppsService) Get

Get: Gets the specified AndroidApp.

- name: The resource name of the AndroidApp, in the format: projects/

PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique
identifier, the Unique Resource from Sub-Collection access pattern
may be used here, in the format: projects/-/androidApps/APP_ID
Refer to the `AndroidApp` `name`
(../projects.androidApps#AndroidApp.FIELDS.name) field for details
about PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsAndroidAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified AndroidApp.

- name: The resource name of the AndroidApp configuration to

download, in the format:
projects/PROJECT_IDENTIFIER/androidApps/APP_ID/config Since an
APP_ID is a unique identifier, the Unique Resource from
Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID Refer to the `AndroidApp` `name`
(../projects.androidApps#AndroidApp.FIELDS.name) field for details
about PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsAndroidAppsService) List

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

- parent: The resource name of the parent FirebaseProject for which

to list each associated AndroidApp, in the format:
projects/PROJECT_IDENTIFIER /androidApps Refer to the
`FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
field for details about PROJECT_IDENTIFIER values.

func (*ProjectsAndroidAppsService) Patch

Patch: Updates the attributes of the specified AndroidApp.

- name: The resource name of the AndroidApp, in the format: projects/

PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the
parent Project's `ProjectNumber`
(../projects#FirebaseProject.FIELDS.project_number)
***(recommended)*** or its `ProjectId`
(../projects#FirebaseProject.FIELDS.project_id). Learn more about
using project identifiers in Google's AIP 2510 standard
(https://google.aip.dev/cloud/2510). Note that the value for
PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
APP_ID: the globally unique, Firebase-assigned identifier for the
App (see `appId`
(../projects.androidApps#AndroidApp.FIELDS.app_id)).

type ProjectsAndroidAppsShaCreateCall

type ProjectsAndroidAppsShaCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsShaCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsShaCreateCall) Do

Do executes the "firebase.projects.androidApps.sha.create" call. Exactly one of *ShaCertificate or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ShaCertificate.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsShaCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsShaCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAndroidAppsShaDeleteCall

type ProjectsAndroidAppsShaDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsShaDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsShaDeleteCall) Do

Do executes the "firebase.projects.androidApps.sha.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsShaDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsShaDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAndroidAppsShaListCall

type ProjectsAndroidAppsShaListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAndroidAppsShaListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAndroidAppsShaListCall) Do

Do executes the "firebase.projects.androidApps.sha.list" call. Exactly one of *ListShaCertificatesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListShaCertificatesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsShaListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAndroidAppsShaListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAndroidAppsShaListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsShaService

type ProjectsAndroidAppsShaService struct {
	// contains filtered or unexported fields
}

func NewProjectsAndroidAppsShaService

func NewProjectsAndroidAppsShaService(s *Service) *ProjectsAndroidAppsShaService

func (*ProjectsAndroidAppsShaService) Create

Create: Adds a ShaCertificate to the specified AndroidApp.

- parent: The resource name of the parent AndroidApp to which to add

a ShaCertificate, in the format:
projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since an APP_ID is
a unique identifier, the Unique Resource from Sub-Collection access
pattern may be used here, in the format:
projects/-/androidApps/APP_ID Refer to the `AndroidApp` `name`
(../projects.androidApps#AndroidApp.FIELDS.name) field for details
about PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsAndroidAppsShaService) Delete

Delete: Removes a ShaCertificate from the specified AndroidApp.

- name: The resource name of the ShaCertificate to remove from the

parent AndroidApp, in the format:
projects/PROJECT_IDENTIFIER/androidApps/APP_ID /sha/SHA_HASH Refer
to the `ShaCertificate` `name`
(../projects.androidApps.sha#ShaCertificate.FIELDS.name) field for
details about PROJECT_IDENTIFIER, APP_ID, and SHA_HASH values. You
can obtain the full resource name of the `ShaCertificate` from the
response of `ListShaCertificates`
(../projects.androidApps.sha/list) or the original
`CreateShaCertificate` (../projects.androidApps.sha/create).

func (*ProjectsAndroidAppsShaService) List

List: Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.

- parent: The resource name of the parent AndroidApp for which to

list each associated ShaCertificate, in the format:
projects/PROJECT_IDENTIFIER /androidApps/APP_ID Since an APP_ID is
a unique identifier, the Unique Resource from Sub-Collection access
pattern may be used here, in the format:
projects/-/androidApps/APP_ID Refer to the `AndroidApp` `name`
(../projects.androidApps#AndroidApp.FIELDS.name) field for details
about PROJECT_IDENTIFIER and APP_ID values.

type ProjectsAvailableLocationsListCall

type ProjectsAvailableLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAvailableLocationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAvailableLocationsListCall) Do

Do executes the "firebase.projects.availableLocations.list" call. Exactly one of *ListAvailableLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAvailableLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAvailableLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAvailableLocationsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAvailableLocationsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAvailableLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsAvailableLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing.

func (*ProjectsAvailableLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsAvailableLocationsService

type ProjectsAvailableLocationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsAvailableLocationsService

func NewProjectsAvailableLocationsService(s *Service) *ProjectsAvailableLocationsService

func (*ProjectsAvailableLocationsService) List

List: 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 (https://firebase.google.com/docs/projects/locations), 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 (https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) 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.

- parent: The FirebaseProject for which to list GCP resource

locations, in the format: projects/PROJECT_IDENTIFIER Refer to the
`FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
field for details about PROJECT_IDENTIFIER 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.

type ProjectsDefaultLocationFinalizeCall

type ProjectsDefaultLocationFinalizeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsDefaultLocationFinalizeCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDefaultLocationFinalizeCall) Do

Do executes the "firebase.projects.defaultLocation.finalize" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDefaultLocationFinalizeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDefaultLocationFinalizeCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDefaultLocationService

type ProjectsDefaultLocationService struct {
	// contains filtered or unexported fields
}

func NewProjectsDefaultLocationService

func NewProjectsDefaultLocationService(s *Service) *ProjectsDefaultLocationService

func (*ProjectsDefaultLocationService) Finalize

Finalize: 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 (https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified `locationId` (#body.request_body.FIELDS.location_id). This location must be one of the available GCP resource locations (https://firebase.google.com/docs/projects/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` (../../v1beta1/operations), which can be used to track the provisioning process. The `response` (../../v1beta1/operations#Operation.FIELDS.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` (../../v1beta1/operations#Operation.FIELDS.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 (#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.

- parent: The resource name of the FirebaseProject for which the

default GCP resource location will be set, in the format:
projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.

type ProjectsGetAdminSdkConfigCall

type ProjectsGetAdminSdkConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGetAdminSdkConfigCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGetAdminSdkConfigCall) Do

Do executes the "firebase.projects.getAdminSdkConfig" call. Exactly one of *AdminSdkConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AdminSdkConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetAdminSdkConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGetAdminSdkConfigCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsGetAdminSdkConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsGetAnalyticsDetailsCall

type ProjectsGetAnalyticsDetailsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGetAnalyticsDetailsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGetAnalyticsDetailsCall) Do

Do executes the "firebase.projects.getAnalyticsDetails" call. Exactly one of *AnalyticsDetails or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyticsDetails.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetAnalyticsDetailsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGetAnalyticsDetailsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsGetAnalyticsDetailsCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsGetCall

type ProjectsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGetCall) Do

Do executes the "firebase.projects.get" call. Exactly one of *FirebaseProject or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FirebaseProject.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGetCall) Header

func (c *ProjectsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsGetCall) IfNoneMatch

func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsCreateCall

type ProjectsIosAppsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsIosAppsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsIosAppsCreateCall) Do

Do executes the "firebase.projects.iosApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsIosAppsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsIosAppsGetCall

type ProjectsIosAppsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsIosAppsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsIosAppsGetCall) Do

Do executes the "firebase.projects.iosApps.get" call. Exactly one of *IosApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsIosAppsGetCall) Header

func (c *ProjectsIosAppsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsIosAppsGetCall) IfNoneMatch

func (c *ProjectsIosAppsGetCall) IfNoneMatch(entityTag string) *ProjectsIosAppsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsGetConfigCall

type ProjectsIosAppsGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsIosAppsGetConfigCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsIosAppsGetConfigCall) Do

Do executes the "firebase.projects.iosApps.getConfig" call. Exactly one of *IosAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosAppConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsGetConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsIosAppsGetConfigCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsIosAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsListCall

type ProjectsIosAppsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsIosAppsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsIosAppsListCall) Do

Do executes the "firebase.projects.iosApps.list" call. Exactly one of *ListIosAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListIosAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsIosAppsListCall) Header

func (c *ProjectsIosAppsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsIosAppsListCall) IfNoneMatch

func (c *ProjectsIosAppsListCall) IfNoneMatch(entityTag string) *ProjectsIosAppsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsIosAppsListCall) PageSize

func (c *ProjectsIosAppsListCall) PageSize(pageSize int64) *ProjectsIosAppsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsIosAppsListCall) PageToken

func (c *ProjectsIosAppsListCall) PageToken(pageToken string) *ProjectsIosAppsListCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.

func (*ProjectsIosAppsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsIosAppsPatchCall

type ProjectsIosAppsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsIosAppsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsIosAppsPatchCall) Do

Do executes the "firebase.projects.iosApps.patch" call. Exactly one of *IosApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsIosAppsPatchCall) Header

func (c *ProjectsIosAppsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsIosAppsPatchCall) UpdateMask

func (c *ProjectsIosAppsPatchCall) UpdateMask(updateMask string) *ProjectsIosAppsPatchCall

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.

type ProjectsIosAppsService

type ProjectsIosAppsService struct {
	// contains filtered or unexported fields
}

func NewProjectsIosAppsService

func NewProjectsIosAppsService(s *Service) *ProjectsIosAppsService

func (*ProjectsIosAppsService) Create

func (r *ProjectsIosAppsService) Create(parent string, iosapp *IosApp) *ProjectsIosAppsCreateCall

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

- parent: The resource name of the parent FirebaseProject in which to

create an IosApp, in the format:
projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject`
`name` (../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.

func (*ProjectsIosAppsService) Get

Get: Gets the specified IosApp.

- name: The resource name of the IosApp, in the format:

projects/PROJECT_IDENTIFIER /iosApps/APP_ID Since an APP_ID is a
unique identifier, the Unique Resource from Sub-Collection access
pattern may be used here, in the format: projects/-/iosApps/APP_ID
Refer to the `IosApp` `name`
(../projects.iosApps#IosApp.FIELDS.name) field for details about
PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsIosAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified IosApp.

- name: The resource name of the App configuration to download, in

the format: projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since
an APP_ID is a unique identifier, the Unique Resource from
Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/APP_ID Refer to the `IosApp` `name`
(../projects.iosApps#IosApp.FIELDS.name) field for details about
PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsIosAppsService) List

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

- parent: The resource name of the parent FirebaseProject for which

to list each associated IosApp, in the format:
projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject`
`name` (../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.

func (*ProjectsIosAppsService) Patch

func (r *ProjectsIosAppsService) Patch(nameid string, iosapp *IosApp) *ProjectsIosAppsPatchCall

Patch: Updates the attributes of the specified IosApp.

- name: The resource name of the IosApp, in the format:

projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER:
the parent Project's `ProjectNumber`
(../projects#FirebaseProject.FIELDS.project_number)
***(recommended)*** or its `ProjectId`
(../projects#FirebaseProject.FIELDS.project_id). Learn more about
using project identifiers in Google's AIP 2510 standard
(https://google.aip.dev/cloud/2510). Note that the value for
PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
APP_ID: the globally unique, Firebase-assigned identifier for the
App (see `appId` (../projects.iosApps#IosApp.FIELDS.app_id)).

type ProjectsListCall

type ProjectsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsListCall) Do

Do executes the "firebase.projects.list" call. Exactly one of *ListFirebaseProjectsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListFirebaseProjectsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsListCall) Header

func (c *ProjectsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsListCall) IfNoneMatch

func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsListCall) PageSize

func (c *ProjectsListCall) PageSize(pageSize int64) *ProjectsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsListCall) PageToken

func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.

func (*ProjectsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsPatchCall

type ProjectsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPatchCall) Do

Do executes the "firebase.projects.patch" call. Exactly one of *FirebaseProject or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FirebaseProject.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsPatchCall) Header

func (c *ProjectsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsPatchCall) UpdateMask

func (c *ProjectsPatchCall) UpdateMask(updateMask string) *ProjectsPatchCall

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. If this list is empty, then no state will be updated. Note that the fields `name`, `projectId`, and `projectNumber` are all immutable.

type ProjectsRemoveAnalyticsCall

type ProjectsRemoveAnalyticsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsRemoveAnalyticsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsRemoveAnalyticsCall) Do

Do executes the "firebase.projects.removeAnalytics" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsRemoveAnalyticsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsRemoveAnalyticsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsSearchAppsCall

type ProjectsSearchAppsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSearchAppsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSearchAppsCall) Do

Do executes the "firebase.projects.searchApps" call. Exactly one of *SearchFirebaseAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchFirebaseAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSearchAppsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsSearchAppsCall) Filter

Filter sets the optional parameter "filter": A query string compatible with Google's AIP-160 (https://google.aip.dev/160) standard. Use any of the following fields in a query: * `app_id` (../projects.apps#FirebaseAppInfo.FIELDS.app_id) * `namespace` (../projects.apps#FirebaseAppInfo.FIELDS.namespace) * `platform` (../projects.apps#FirebaseAppInfo.FIELDS.platform) We also support the following "virtual" fields (fields which are not actually part of the returned resource object, but can be queried as if they are pre-populated with specific values): * `sha1_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `sha256_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `app_store_id`: This field is considered to be a singular `string` field, populated with the Apple App Store ID registered with the app. This field is empty if the app is not an iOS app. * `team_id`: This field is considered to be a singular `string` field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app.

func (*ProjectsSearchAppsCall) Header

func (c *ProjectsSearchAppsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsSearchAppsCall) IfNoneMatch

func (c *ProjectsSearchAppsCall) IfNoneMatch(entityTag string) *ProjectsSearchAppsCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSearchAppsCall) PageSize

func (c *ProjectsSearchAppsCall) PageSize(pageSize int64) *ProjectsSearchAppsCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsSearchAppsCall) PageToken

func (c *ProjectsSearchAppsCall) PageToken(pageToken string) *ProjectsSearchAppsCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.

func (*ProjectsSearchAppsCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsService

type ProjectsService struct {
	AndroidApps *ProjectsAndroidAppsService

	AvailableLocations *ProjectsAvailableLocationsService

	DefaultLocation *ProjectsDefaultLocationService

	IosApps *ProjectsIosAppsService

	WebApps *ProjectsWebAppsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) AddFirebase

func (r *ProjectsService) AddFirebase(projectid string, addfirebaserequest *AddFirebaseRequest) *ProjectsAddFirebaseCall

AddFirebase: Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs. The result of this call is an `Operation` (../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until `done` (../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its `response` (../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its `error` (../../v1beta1/operations#Operation.FIELDS.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`.

- project: The resource name of the GCP `Project` to which Firebase

resources will be added, in the format: projects/PROJECT_IDENTIFIER
Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values. After calling `AddFirebase`, the unique
Project identifiers ( `projectNumber`
(https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number)
and `projectId`
(https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id))
of the underlying GCP `Project` are also the identifiers of the
FirebaseProject.

func (*ProjectsService) AddGoogleAnalytics

func (r *ProjectsService) AddGoogleAnalytics(parent string, addgoogleanalyticsrequest *AddGoogleAnalyticsRequest) *ProjectsAddGoogleAnalyticsCall

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

- parent: The resource name of the FirebaseProject to link to an

existing Google Analytics account, in the format:
projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.

func (*ProjectsService) Get

func (r *ProjectsService) Get(name string) *ProjectsGetCall

Get: Gets the specified FirebaseProject.

- name: The resource name of the FirebaseProject, in the format:

projects/ PROJECT_IDENTIFIER Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.

func (*ProjectsService) GetAdminSdkConfig

func (r *ProjectsService) GetAdminSdkConfig(name string) *ProjectsGetAdminSdkConfigCall

GetAdminSdkConfig: 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 (https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command.

- name: The resource name of the FirebaseProject, in the format:

projects/ PROJECT_IDENTIFIER/adminSdkConfig Refer to the
`FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
field for details about PROJECT_IDENTIFIER values.

func (*ProjectsService) GetAnalyticsDetails

func (r *ProjectsService) GetAnalyticsDetails(name string) *ProjectsGetAnalyticsDetailsCall

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

- name: The resource name of the FirebaseProject, in the format:

projects/ PROJECT_IDENTIFIER/analyticsDetails Refer to the
`FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
field for details about PROJECT_IDENTIFIER values.

func (*ProjectsService) List

func (r *ProjectsService) List() *ProjectsListCall

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

func (*ProjectsService) Patch

func (r *ProjectsService) Patch(nameid string, firebaseproject *FirebaseProject) *ProjectsPatchCall

Patch: Updates the attributes of the specified FirebaseProject. All query parameters (#query-parameters) are required.

- name: The resource name of the Project, in the format:

projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's
`ProjectNumber` (../projects#FirebaseProject.FIELDS.project_number)
***(recommended)*** or its `ProjectId`
(../projects#FirebaseProject.FIELDS.project_id). Learn more about
using project identifiers in Google's AIP 2510 standard
(https://google.aip.dev/cloud/2510). Note that the value for
PROJECT_IDENTIFIER in any response body will be the `ProjectId`.

func (*ProjectsService) RemoveAnalytics

func (r *ProjectsService) RemoveAnalytics(parent string, removeanalyticsrequest *RemoveAnalyticsRequest) *ProjectsRemoveAnalyticsCall

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

- parent: The resource name of the FirebaseProject to unlink from its

Google Analytics account, in the format:
projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.

func (*ProjectsService) SearchApps

func (r *ProjectsService) SearchApps(parent string) *ProjectsSearchAppsCall

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

- parent: The parent FirebaseProject for which to list Apps, in the

format: projects/ PROJECT_IDENTIFIER Refer to the `FirebaseProject`
`name` (../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.

type ProjectsWebAppsCreateCall

type ProjectsWebAppsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsWebAppsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsWebAppsCreateCall) Do

Do executes the "firebase.projects.webApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsWebAppsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsWebAppsGetCall

type ProjectsWebAppsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsWebAppsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsWebAppsGetCall) Do

Do executes the "firebase.projects.webApps.get" call. Exactly one of *WebApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsWebAppsGetCall) Header

func (c *ProjectsWebAppsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsWebAppsGetCall) IfNoneMatch

func (c *ProjectsWebAppsGetCall) IfNoneMatch(entityTag string) *ProjectsWebAppsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsWebAppsGetConfigCall

type ProjectsWebAppsGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsWebAppsGetConfigCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsWebAppsGetConfigCall) Do

Do executes the "firebase.projects.webApps.getConfig" call. Exactly one of *WebAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebAppConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsGetConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsWebAppsGetConfigCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsWebAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsWebAppsListCall

type ProjectsWebAppsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsWebAppsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsWebAppsListCall) Do

Do executes the "firebase.projects.webApps.list" call. Exactly one of *ListWebAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListWebAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsWebAppsListCall) Header

func (c *ProjectsWebAppsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsWebAppsListCall) IfNoneMatch

func (c *ProjectsWebAppsListCall) IfNoneMatch(entityTag string) *ProjectsWebAppsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsWebAppsListCall) PageSize

func (c *ProjectsWebAppsListCall) PageSize(pageSize int64) *ProjectsWebAppsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsWebAppsListCall) PageToken

func (c *ProjectsWebAppsListCall) PageToken(pageToken string) *ProjectsWebAppsListCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing.

func (*ProjectsWebAppsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsWebAppsPatchCall

type ProjectsWebAppsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsWebAppsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsWebAppsPatchCall) Do

Do executes the "firebase.projects.webApps.patch" call. Exactly one of *WebApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebApp.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsWebAppsPatchCall) Header

func (c *ProjectsWebAppsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsWebAppsPatchCall) UpdateMask

func (c *ProjectsWebAppsPatchCall) UpdateMask(updateMask string) *ProjectsWebAppsPatchCall

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. Note that the fields `name`, `appId`, and `projectId` are all immutable.

type ProjectsWebAppsService

type ProjectsWebAppsService struct {
	// contains filtered or unexported fields
}

func NewProjectsWebAppsService

func NewProjectsWebAppsService(s *Service) *ProjectsWebAppsService

func (*ProjectsWebAppsService) Create

func (r *ProjectsWebAppsService) Create(parent string, webapp *WebApp) *ProjectsWebAppsCreateCall

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

- parent: The resource name of the parent FirebaseProject in which to

create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps
Refer to the `FirebaseProject` `name`
(../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.

func (*ProjectsWebAppsService) Get

Get: Gets the specified WebApp.

- name: The resource name of the WebApp, in the format:

projects/PROJECT_IDENTIFIER /webApps/APP_ID Since an APP_ID is a
unique identifier, the Unique Resource from Sub-Collection access
pattern may be used here, in the format: projects/-/webApps/APP_ID
Refer to the `WebApp` `name`
(../projects.webApps#WebApp.FIELDS.name) field for details about
PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsWebAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified WebApp.

- name: The resource name of the WebApp configuration to download, in

the format: projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since
an APP_ID is a unique identifier, the Unique Resource from
Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/APP_ID Refer to the `WebApp` `name`
(../projects.webApps#WebApp.FIELDS.name) field for details about
PROJECT_IDENTIFIER and APP_ID values.

func (*ProjectsWebAppsService) List

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

- parent: The resource name of the parent FirebaseProject for which

to list each associated WebApp, in the format:
projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject`
`name` (../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.

func (*ProjectsWebAppsService) Patch

func (r *ProjectsWebAppsService) Patch(nameid string, webapp *WebApp) *ProjectsWebAppsPatchCall

Patch: Updates the attributes of the specified WebApp.

- name: The resource name of the WebApp, in the format:

projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER:
the parent Project's `ProjectNumber`
(../projects#FirebaseProject.FIELDS.project_number)
***(recommended)*** or its `ProjectId`
(../projects#FirebaseProject.FIELDS.project_id). Learn more about
using project identifiers in Google's AIP 2510 standard
(https://google.aip.dev/cloud/2510). Note that the value for
PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
APP_ID: the globally unique, Firebase-assigned identifier for the
App (see `appId` (../projects.webApps#WebApp.FIELDS.app_id)).

type RemoveAnalyticsRequest

type RemoveAnalyticsRequest struct {
	// AnalyticsPropertyId: Optional. The ID of the Google Analytics
	// property associated with the specified `FirebaseProject`. - If not
	// set, then the Google Analytics property that is currently associated
	// with the specified `FirebaseProject` is removed. - If set, and the
	// specified `FirebaseProject` is currently associated with a
	// *different* Google Analytics property, then the response is a `412
	// Precondition Failed` error.
	AnalyticsPropertyId string `json:"analyticsPropertyId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AnalyticsPropertyId")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnalyticsPropertyId") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*RemoveAnalyticsRequest) MarshalJSON

func (s *RemoveAnalyticsRequest) MarshalJSON() ([]byte, error)

type SearchFirebaseAppsResponse

type SearchFirebaseAppsResponse struct {
	// Apps: One page of results from a call to `SearchFirebaseApps`.
	Apps []*FirebaseAppInfo `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. This token can be used in a
	// subsequent calls to `SearchFirebaseApps` to find the next group of
	// Apps. Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*SearchFirebaseAppsResponse) MarshalJSON

func (s *SearchFirebaseAppsResponse) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	AvailableProjects *AvailableProjectsService

	Operations *OperationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ShaCertificate

type ShaCertificate struct {
	// CertType: The type of SHA certificate encoded in the hash.
	//
	// Possible values:
	//   "SHA_CERTIFICATE_TYPE_UNSPECIFIED" - Unknown state. This is only
	// used for distinguishing unset values.
	//   "SHA_1" - Certificate is a SHA-1 type certificate.
	//   "SHA_256" - Certificate is a SHA-256 type certificate.
	CertType string `json:"certType,omitempty"`

	// Name: The resource name of the ShaCertificate for the AndroidApp, in
	// the format:
	// projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH *
	// PROJECT_IDENTIFIER: the parent Project's `ProjectNumber`
	// (../projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
	// using project identifiers in Google's AIP 2510 standard
	// (https://google.aip.dev/cloud/2510). Note that the value for
	// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
	// APP_ID: the globally unique, Firebase-assigned identifier for the App
	// (see `appId` (../projects.androidApps#AndroidApp.FIELDS.app_id)). *
	// SHA_HASH: the certificate hash for the App (see `shaHash`
	// (../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)).
	Name string `json:"name,omitempty"`

	// ShaHash: The certificate hash for the `AndroidApp`.
	ShaHash string `json:"shaHash,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CertType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CertType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ShaCertificate: A SHA-1 or SHA-256 certificate associated with the AndroidApp.

func (*ShaCertificate) MarshalJSON

func (s *ShaCertificate) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type StatusProto

type StatusProto struct {
	// CanonicalCode: The canonical error code (see codes.proto) that most
	// closely corresponds to this status. May be missing.
	CanonicalCode int64 `json:"canonicalCode,omitempty"`

	// Code: Numeric code drawn from the space specified below. Often, this
	// is the canonical error space, and code is drawn from
	// google3/util/task/codes.proto
	Code int64 `json:"code,omitempty"`

	// Message: Detail message
	Message string `json:"message,omitempty"`

	// MessageSet: message_set associates an arbitrary proto message with
	// the status.
	MessageSet *MessageSet `json:"messageSet,omitempty"`

	// Space: The following are usually only present when code != 0 Space to
	// which this status belongs
	Space string `json:"space,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CanonicalCode") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CanonicalCode") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StatusProto: Wire-format for a Status object

func (*StatusProto) MarshalJSON

func (s *StatusProto) MarshalJSON() ([]byte, error)

type StreamMapping

type StreamMapping struct {
	// App: The resource name of the Firebase App associated with the Google
	// Analytics data stream, in the format:
	// projects/PROJECT_IDENTIFIER/androidApps/APP_ID or
	// projects/PROJECT_IDENTIFIER/iosApps/APP_ID or
	// projects/PROJECT_IDENTIFIER /webApps/APP_ID Refer to the
	// `FirebaseProject` `name` (../projects#FirebaseProject.FIELDS.name)
	// field for details about PROJECT_IDENTIFIER values.
	App string `json:"app,omitempty"`

	// MeasurementId: Applicable for Firebase Web Apps only. The unique
	// Google-assigned identifier of the Google Analytics web stream
	// associated with the Firebase Web App. Firebase SDKs use this ID to
	// interact with Google Analytics APIs. Learn more about this ID and
	// Google Analytics web streams in the Analytics documentation
	// (https://support.google.com/analytics/topic/9303475).
	MeasurementId string `json:"measurementId,omitempty"`

	// StreamId: The unique Google-assigned identifier of the Google
	// Analytics data stream associated with the Firebase App. Learn more
	// about Google Analytics data streams in the Analytics documentation
	// (https://support.google.com/analytics/answer/9303323).
	StreamId int64 `json:"streamId,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "App") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "App") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StreamMapping: A mapping of a Firebase App to a Google Analytics data stream

func (*StreamMapping) MarshalJSON

func (s *StreamMapping) MarshalJSON() ([]byte, error)

type WebApp

type WebApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// for the `WebApp`. This identifier should be treated as an opaque
	// token, as the data format is not specified.
	AppId string `json:"appId,omitempty"`

	// AppUrls: The URLs where the `WebApp` is hosted.
	AppUrls []string `json:"appUrls,omitempty"`

	// DisplayName: The user-assigned display name for the `WebApp`.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The resource name of the WebApp, in the format:
	// projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the
	// parent Project's `ProjectNumber`
	// (../projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
	// using project identifiers in Google's AIP 2510 standard
	// (https://google.aip.dev/cloud/2510). Note that the value for
	// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
	// APP_ID: the globally unique, Firebase-assigned identifier for the App
	// (see `appId` (../projects.webApps#WebApp.FIELDS.app_id)).
	Name string `json:"name,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier of the parent
	// FirebaseProject for the `WebApp`.
	ProjectId string `json:"projectId,omitempty"`

	// WebId: Output only. Immutable. A unique, Firebase-assigned identifier
	// for the `WebApp`. This identifier is only used to populate the
	// `namespace` value for the `WebApp`. For most use cases, use `appId`
	// to identify or reference the App. The `webId` value is only unique
	// within a `FirebaseProject` and its associated Apps.
	WebId string `json:"webId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AppId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

WebApp: Details of a Firebase App for the web.

func (*WebApp) MarshalJSON

func (s *WebApp) MarshalJSON() ([]byte, error)

type WebAppConfig

type WebAppConfig struct {
	// ApiKey: The API key associated with the `WebApp`.
	ApiKey string `json:"apiKey,omitempty"`

	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// for the `WebApp`.
	AppId string `json:"appId,omitempty"`

	// AuthDomain: The domain Firebase Auth configures for OAuth redirects,
	// in the format: PROJECT_ID.firebaseapp.com
	AuthDomain string `json:"authDomain,omitempty"`

	// DatabaseURL: The default Firebase Realtime Database URL.
	DatabaseURL string `json:"databaseURL,omitempty"`

	// LocationId: The ID of the Project's default GCP resource location.
	// The location is one of the available GCP resource locations
	// (https://firebase.google.com/docs/projects/locations). This field is
	// omitted if the default GCP resource location has not been finalized
	// yet. To set a Project's default GCP resource location, call
	// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
	// after you add Firebase resources to the Project.
	LocationId string `json:"locationId,omitempty"`

	// MeasurementId: The unique Google-assigned identifier of the Google
	// Analytics web stream associated with the `WebApp`. Firebase SDKs use
	// this ID to interact with Google Analytics APIs. This field is only
	// present if the `WebApp` is linked to a web stream in a Google
	// Analytics App + Web property. Learn more about this ID and Google
	// Analytics web streams in the Analytics documentation
	// (https://support.google.com/analytics/topic/9303475). To generate a
	// `measurementId` and link the `WebApp` with a Google Analytics web
	// stream, call `AddGoogleAnalytics`
	// (../../v1beta1/projects/addGoogleAnalytics). For apps using the
	// Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically
	// fetches the `measurementId` when your app initializes Analytics.
	// Having this ID in your config object is optional, but it does serve
	// as a fallback in the rare case that the dynamic fetch fails.
	MeasurementId string `json:"measurementId,omitempty"`

	// MessagingSenderId: The sender ID for use with Firebase Cloud
	// Messaging.
	MessagingSenderId string `json:"messagingSenderId,omitempty"`

	// ProjectId: Immutable. A user-assigned unique identifier for the
	// `FirebaseProject`.
	ProjectId string `json:"projectId,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket
	// name.
	StorageBucket string `json:"storageBucket,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ApiKey") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiKey") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

WebAppConfig: Configuration metadata of a single Firebase App for the web.

func (*WebAppConfig) MarshalJSON

func (s *WebAppConfig) MarshalJSON() ([]byte, error)

Source Files