Firebase API Reference

产品

建造
发布和监控
从事

用例价钱文档

概述
基本面
建造
发布和监控
从事
参考
样品

支持

转到控制台

文档

概述基本面

添加 Firebase - iOS
添加 Firebase - Android
添加 Firebase - 网页
添加 Firebase - C++
添加 Firebase - Unity
添加 Firebase - 服务器环境
管理 Firebase 项目
支持的平台和框架
使用 App Check 保护项目资源
使用模拟器套件

建造

模拟器套件
验证
Realtime Database
Firestore
贮存
机器学习
托管
Cloud Functions
安全规则
扩展

发布和监控

Crashlytics
性能监控
测试实验室
应用分发

从事

Analytics
远程配置
预测
A/B 测试
云消息
应用内消息
Dynamic Links
谷歌广告
Google Ads
应用索引

参考样品图书馆

产品
- More
用例
价钱
文档
- More
- 概述
- 基本面
  - More
- 建造
  - More
- 发布和监控
  - More
- 从事
  - More
- 参考
- 样品
- 图书馆
支持
转到控制台

API Reference
CLI reference
iOS — Swift
iOS — Objective-C
Android — Java
- Package Summary
- ads
- ads
  - 概览
  - AdError
  - AdFormat
  - AdInspectorError
    概览
    AdInspectorErrorCode
  - AdListener
  - AdLoadCallback
  - AdLoader
    概览
    Builder
  - AdRequest
    概览
    Builder
  - AdSize
  - AdValue
    概览
    PrecisionType
  - AdView
  - AdapterResponseInfo
  - BaseAdView
  - FullScreenContentCallback
  - LoadAdError
  - MediaAspectRatio
  - MediaContent
  - MediationUtils
  - MobileAds
  - MuteThisAdListener
  - MuteThisAdReason
  - OnAdInspectorClosedListener
  - OnPaidEventListener
  - OnUserEarnedRewardListener
  - RequestConfiguration
    概览
    Builder
    MaxAdContentRating
    TagForChildDirectedTreatment
    TagForUnderAgeOfConsent
  - ResponseInfo
  - VideoController
    概览
    VideoLifecycleCallbacks
  - VideoOptions
    概览
    Builder
- ads.admanager
  - 概览
  - AdManagerAdRequest
    概览
    Builder
  - AdManagerAdView
  - AdManagerInterstitialAd
  - AdManagerInterstitialAdLoadCallback
  - AppEventListener
- ads.appopen
  - 概览
  - AppOpenAd
    概览
    AppOpenAdLoadCallback
    AppOpenAdOrientation
- ads.formats
  - 概览
  - AdManagerAdViewOptions
    概览
    Builder
  - MediaView
  - NativeAd
    概览
    AdChoicesInfo
    Image
  - NativeAdOptions
    概览
    AdChoicesPlacement
    Builder
    NativeMediaAspectRatio
  - OnAdManagerAdViewLoadedListener
  - UnifiedNativeAdAssetNames
- ads.h5
- ads.initialization
  - 概览
  - AdapterStatus
    概览
    State
  - InitializationStatus
  - OnInitializationCompleteListener
- ads.interstitial
- ads.mediation
- ads.mediation.admob
  - 概览
  - AdMobExtras
- ads.mediation.customevent
- ads.mediation.rtb
- ads.nativead
  - 概览
  - AdChoicesView
  - MediaView
  - NativeAd
    概览
    AdChoicesInfo
    Image
    OnNativeAdLoadedListener
    UnconfirmedClickListener
  - NativeAdAssetNames
  - NativeAdOptions
    概览
    AdChoicesPlacement
    Builder
    NativeMediaAspectRatio
  - NativeAdView
  - NativeAdViewHolder
  - NativeCustomFormatAd
    概览
    DisplayOpenMeasurement
    OnCustomClickListener
    OnCustomFormatAdLoadedListener
- ads.rewarded
  - 概览
  - OnAdMetadataChangedListener
  - RewardItem
  - RewardedAd
  - RewardedAdLoadCallback
  - ServerSideVerificationOptions
    概览
    Builder
- ads.rewardedinterstitial
- ads.search
  - 概览
  - DynamicHeightSearchAdRequest
    概览
    Builder
  - SearchAdView
- appindexing
- appindexing
  - 概览
  - Action
    概览
    Builder
  - AndroidAppUri
  - AppIndex
  - AppIndexApi
    概览
    ActionResult
    AppIndexingLink
  - Thing
    概览
    Builder
- firebase.appindexing
  - 概览
  - Action
    概览
    Builder
    
    Action.Metadata
    概览
    Builder
  - AndroidAppUri
  - FirebaseAppIndex
  - FirebaseAppIndexingException
  - FirebaseAppIndexingInvalidArgumentException
  - FirebaseAppIndexingTooManyArgumentsException
  - FirebaseUserActions
  - Indexable
    概览
    Builder
    
    Indexable.Metadata
    概览
    Builder
  - Scope
- firebase.appindexing.builders
- measurement
- measurement
- measurement.api
- firebase.analytics
  - 概览
  - FirebaseAnalytics
    概览
    ConsentStatus
    ConsentType
    Event
    Param
    UserProperty
- measurement.impl
- measurement
  - 概览
  - AppMeasurementContentProvider
- firebase
- firebase
- firebase.auth
- firebase.provider
  - 概览
  - FirebaseInitProvider
- firebase.appcheck
- firebase.appcheck
  - 概览
  - AppCheckProvider
  - AppCheckProviderFactory
  - AppCheckToken
  - FirebaseAppCheck
    概览
    AppCheckListener
- firebase.appcheck-debug
- firebase.appcheck.debug
  - 概览
  - DebugAppCheckProviderFactory
- firebase.appcheck-debug-testing
- firebase.appcheck.debug.testing
  - 概览
  - DebugAppCheckTestHelper
    概览
    MaybeThrowingRunnable
- firebase.appcheck-safetynet
- firebase.appcheck.safetynet
  - 概览
  - SafetyNetAppCheckProviderFactory
- firebase.auth
- firebase.auth
- firebase.auth.api.model.json
  - 概览
  - JsonHelper
- firebase.crashlytics
- firebase.crashlytics
  - 概览
  - CustomKeysAndValues
    概览
    Builder
  - FirebaseCrashlytics
- firebase.database
- firebase.database
  - 概览
  - ChildEventListener
  - DataSnapshot
  - DatabaseError
  - DatabaseException
  - DatabaseReference
    概览
    CompletionListener
  - Exclude
  - FirebaseDatabase
  - GenericTypeIndicator
  - IgnoreExtraProperties
  - Logger
    概览
    Level
  - MutableData
  - OnDisconnect
  - PropertyName
  - Query
  - ServerValue
  - ThrowOnExtraProperties
  - Transaction
    概览
    Handler
    Result
  - ValueEventListener
- firebase.dynamiclinks
- firebase.dynamiclinks
  - 概览
  - DynamicLink
    概览
    
    DynamicLink.AndroidParameters
    概览
    Builder
    Builder
    
    DynamicLink.GoogleAnalyticsParameters
    概览
    Builder
    
    DynamicLink.IosParameters
    概览
    Builder
    
    DynamicLink.ItunesConnectAnalyticsParameters
    概览
    Builder
    
    DynamicLink.NavigationInfoParameters
    概览
    Builder
    
    DynamicLink.SocialMetaTagParameters
    概览
    Builder
  - FirebaseDynamicLinks
  - PendingDynamicLinkData
  - ShortDynamicLink
    概览
    Suffix
    Warning
- firebase.firestore
- firebase.firestore
  - 概览
  - Blob
  - CollectionReference
  - DocumentChange
    概览
    Type
  - DocumentId
  - DocumentReference
  - DocumentSnapshot
    概览
    ServerTimestampBehavior
  - EventListener
  - Exclude
  - FieldPath
  - FieldValue
  - FirebaseFirestore
  - FirebaseFirestoreException
    概览
    Code
  - FirebaseFirestoreSettings
    概览
    Builder
  - GeoPoint
  - IgnoreExtraProperties
  - ListenerRegistration
  - LoadBundleTask
  - LoadBundleTaskProgress
    概览
    TaskState
  - MetadataChanges
  - OnProgressListener
  - PropertyName
  - Query
    概览
    Direction
  - QueryDocumentSnapshot
  - QuerySnapshot
  - ServerTimestamp
  - SetOptions
  - SnapshotMetadata
  - Source
  - ThrowOnExtraProperties
  - Transaction
    概览
    Function
  - WriteBatch
    概览
    Function
- firebase.functions
- firebase.functions
  - 概览
  - FirebaseFunctions
  - FirebaseFunctionsException
    概览
    Code
  - HttpsCallableReference
  - HttpsCallableResult
- firebase.inappmessaging
- firebase.inappmessaging
- firebase.inappmessaging.model
- firebase.inappmessaging.display
- firebase.inappmessaging.display
  - 概览
  - FirebaseInAppMessagingDisplay
- firebase.iid
- firebase.iid
- firebase.installations
- firebase.installations
  - 概览
  - FirebaseInstallations
- firebase.messaging
- firebase.messaging
  - 概览
  - FirebaseMessaging
  - FirebaseMessagingService
  - RemoteMessage
    概览
    Builder
    MessagePriority
    Notification
  - SendException
- firebase.ml.common
- firebase.ml.common
  - 概览
  - FirebaseMLException
    概览
    Code
- firebase.ml.common.modeldownload
  - 概览
  - FirebaseLocalModel
    概览
    Builder
  - FirebaseModelDownloadConditions
    概览
    Builder
  - FirebaseModelManager
  - FirebaseRemoteModel
- firebase.ml.interpreter
- firebase.ml.custom
  - 概览
  - FirebaseCustomLocalModel
    概览
    Builder
  - FirebaseCustomRemoteModel
    概览
    Builder
  - FirebaseModelDataType
    概览
    DataType
  - FirebaseModelInputOutputOptions
    概览
    Builder
  - FirebaseModelInputs
    概览
    Builder
  - FirebaseModelInterpreter
  - FirebaseModelInterpreterOptions
    概览
    Builder
  - FirebaseModelOutputs
- firebase.ml.modeldownloader
- firebase.ml.modeldownloader
  - 概览
  - CustomModel
  - CustomModelDownloadConditions
    概览
    Builder
  - DownloadType
  - FirebaseMlException
    概览
    Code
  - FirebaseModelDownloader
- firebase.ml.naturallanguage
- firebase.ml.naturallanguage
  - 概览
  - FirebaseNaturalLanguage
- firebase.ml.naturallanguage.languageid
  - 概览
  - FirebaseLanguageIdentification
  - FirebaseLanguageIdentificationOptions
    概览
    Builder
  - IdentifiedLanguage
- firebase.ml.naturallanguage.smartreply
  - 概览
  - FirebaseSmartReply
  - FirebaseTextMessage
  - SmartReplySuggestion
  - SmartReplySuggestionResult
    概览
    Status
- firebase.ml.naturallanguage.translate
- firebase.ml.naturallanguage.translate
  - 概览
  - FirebaseTranslateLanguage
    概览
    TranslateLanguage
  - FirebaseTranslateRemoteModel
    概览
    Builder
  - FirebaseTranslator
  - FirebaseTranslatorOptions
    概览
    Builder
- firebase.ml.vision
- firebase.ml.vision
  - 概览
  - FirebaseVision
- firebase.ml.vision.automl
  - 概览
  - FirebaseAutoMLLocalModel
    概览
    Builder
  - FirebaseAutoMLRemoteModel
    概览
    Builder
- firebase.ml.vision.barcode
  - 概览
  - FirebaseVisionBarcode
    概览
    
    FirebaseVisionBarcode.Address
    概览
    AddressType
    BarcodeFormat
    BarcodeValueType
    CalendarDateTime
    CalendarEvent
    ContactInfo
    DriverLicense
    
    FirebaseVisionBarcode.Email
    概览
    FormatType
    GeoPoint
    PersonName
    
    FirebaseVisionBarcode.Phone
    概览
    FormatType
    Sms
    UrlBookmark
    
    FirebaseVisionBarcode.WiFi
    概览
    EncryptionType
  - FirebaseVisionBarcodeDetector
  - FirebaseVisionBarcodeDetectorOptions
    概览
    Builder
- firebase.ml.vision.cloud
  - 概览
  - FirebaseVisionCloudDetectorOptions
    概览
    Builder
    ModelType
- firebase.ml.vision.cloud.landmark
- firebase.ml.vision.common
  - 概览
  - FirebaseVisionImage
  - FirebaseVisionImageMetadata
    概览
    Builder
    ImageFormat
    Rotation
  - FirebaseVisionLatLng
  - FirebaseVisionPoint
- firebase.ml.vision.document
  - 概览
  - FirebaseVisionCloudDocumentRecognizerOptions
    概览
    Builder
  - FirebaseVisionDocumentText
    概览
    Block
    Paragraph
    
    FirebaseVisionDocumentText.RecognizedBreak
    概览
    BreakType
    Symbol
    Word
  - FirebaseVisionDocumentTextRecognizer
- firebase.ml.vision.face
  - 概览
  - FirebaseVisionFace
  - FirebaseVisionFaceContour
    概览
    ContourType
  - FirebaseVisionFaceDetector
  - FirebaseVisionFaceDetectorOptions
    概览
    Builder
    ClassificationMode
    ContourMode
    LandmarkMode
    PerformanceMode
  - FirebaseVisionFaceLandmark
    概览
    LandmarkType
- firebase.ml.vision.label
  - 概览
  - FirebaseVisionCloudImageLabelerOptions
    概览
    Builder
  - FirebaseVisionImageLabel
  - FirebaseVisionImageLabeler
    概览
    ImageLabelerType
  - FirebaseVisionOnDeviceAutoMLImageLabelerOptions
    概览
    Builder
  - FirebaseVisionOnDeviceImageLabelerOptions
    概览
    Builder
- firebase.ml.vision.objects
  - 概览
  - FirebaseVisionObject
    概览
    Category
  - FirebaseVisionObjectDetector
  - FirebaseVisionObjectDetectorOptions
    概览
    Builder
    DetectorMode
- firebase.ml.vision.text
  - 概览
  - FirebaseVisionCloudTextRecognizerOptions
    概览
    Builder
    CloudTextModelType
  - FirebaseVisionText
    概览
    Element
    Line
    TextBlock
  - FirebaseVisionTextRecognizer
    概览
    RecognizerType
  - RecognizedLanguage
- firebase.perf
- firebase.perf
  - 概览
  - FirebasePerformance
    概览
    HttpMethod
- firebase.perf.metrics
- firebase.remoteconfig
- firebase.remoteconfig
- firebase.storage
- firebase.storage
  - 概览
  - CancellableTask
  - ControllableTask
  - FileDownloadTask
    概览
    TaskSnapshot
  - FirebaseStorage
  - ListResult
  - OnPausedListener
  - OnProgressListener
  - StorageException
    概览
    ErrorCode
  - StorageMetadata
    概览
    Builder
  - StorageReference
  - StorageTask
    概览
    ProvideError
    SnapshotBase
  - StreamDownloadTask
    概览
    StreamProcessor
    TaskSnapshot
  - UploadTask
    概览
    TaskSnapshot
- Inter-operational packages
- firebase.auth.internal
Android — Kotlin
- Package Summary
- firebase
- com.google.firebase
  - 概览
  - Classes
    FirebaseApp
    FirebaseOptions
    FirebaseOptions.Builder
  - Exceptions
    FirebaseNetworkException
    FirebaseTooManyRequestsException
- com.google.firebase.provider
  - 概览
  - Classes
    FirebaseInitProvider
- com.google.firebase.ktx
  - 概览
  - Objects
    Firebase
- firebase.analytics
- com.google.firebase.analytics
- com.google.firebase.analytics.ktx
  - 概览
  - Classes
    ParametersBuilder
- firebase.auth
- com.google.firebase.auth
- com.google.firebase.auth.ktx
- firebase.crashlytics
- com.google.firebase.crashlytics
  - 概览
  - Classes
    CustomKeysAndValues
    CustomKeysAndValues.Builder
    FirebaseCrashlytics
- com.google.firebase.crashlytics.ktx
  - 概览
  - Classes
    KeyValueBuilder
- firebase.database
- com.google.firebase.database
  - 概览
  - Classes
    DatabaseError
    DatabaseReference
    DataSnapshot
    FirebaseDatabase
    GenericTypeIndicator
    MutableData
    OnDisconnect
    Query
    ServerValue
    Transaction
    Transaction.Result
  - Interfaces
    ChildEventListener
    DatabaseReference.CompletionListener
    Logger
    Transaction.Handler
    ValueEventListener
  - Enums
    Logger.Level
  - Annotations
    Exclude
    IgnoreExtraProperties
    PropertyName
    ThrowOnExtraProperties
  - Exceptions
    DatabaseException
- com.google.firebase.database.ktx
- firebase.dynamiclinks
- com.google.firebase.dynamiclinks
- com.google.firebase.dynamiclinks.ktx
- firebase.firestore
- com.google.firebase
  - 概览
  - Classes
    Timestamp
- com.google.firebase.firestore
- com.google.firebase.firestore.ktx
- firebase.functions
- com.google.firebase.functions
  - 概览
  - Classes
    FirebaseFunctions
    HttpsCallableReference
    HttpsCallableResult
  - Enums
    FirebaseFunctionsException.Code
  - Exceptions
    FirebaseFunctionsException
- com.google.firebase.functions.ktx
- firebase.inappmessaging
- com.google.firebase.inappmessaging
- com.google.firebase.inappmessaging.model
  - 概览
  - Classes
    Action
    BannerMessage
    Button
    CampaignMetadata
    CardMessage
    ImageData
    ImageOnlyMessage
    InAppMessage
    ModalMessage
    Text
  - Enums
    MessageType
- com.google.firebase.inappmessaging.ktx
- firebase.inappmessaging.display
- com.google.firebase.inappmessaging.display
  - 概览
  - Classes
    FirebaseInAppMessagingDisplay
- com.google.firebase.inappmessaging.display.ktx
- firebase.installations
- com.google.firebase.installations
  - 概览
  - Classes
    FirebaseInstallations
- com.google.firebase.installations.ktx
- firebase.messaging
- com.google.firebase.messaging.ktx
- com.google.firebase.messaging
  - 概览
  - Classes
    FirebaseMessaging
    FirebaseMessagingService
    RemoteMessage
    RemoteMessage.Builder
    RemoteMessage.Notification
  - Annotations
    RemoteMessage.MessagePriority
  - Exceptions
    SendException
- firebase.ml.modeldownloader
- com.google.firebase.ml.modeldownloader.ktx
- com.google.firebase.ml.modeldownloader
  - 概览
  - Classes
    CustomModel
    CustomModelDownloadConditions
    CustomModelDownloadConditions.Builder
    FirebaseModelDownloader
  - Enums
    DownloadType
  - Annotations
    FirebaseMlException.Code
  - Exceptions
    FirebaseMlException
- firebase.perf
- com.google.firebase.perf
  - 概览
  - Classes
    FirebasePerformance
  - Annotations
    FirebasePerformance.HttpMethod
- com.google.firebase.perf.metrics
  - 概览
  - Classes
    HttpMetric
    Trace
  - Annotations
    AddTrace
- com.google.firebase.perf.ktx
- firebase.remoteconfig
- com.google.firebase.remoteconfig
- com.google.firebase.remoteconfig.ktx
- firebase.storage
- com.google.firebase.storage
- com.google.firebase.storage.ktx
JavaScript - version 8
- Overview
- firebase
  - 概览
  - FirebaseError
- firebase.app
  - 概览
  - App
- firebase.appcheck
- firebase.analytics
- firebase.auth
- firebase.database
- firebase.firestore
- firebase.functions
- firebase.installations
  - 概览
  - Installations
- firebase.messaging
- firebase.performance
- firebase.remoteconfig
- firebase.storage
JavaScript — version 9
Node.js (Client)
C++
- 概览
- firebase
  - 概览
  - Classes
    App
    AppOptions
    Future
    FutureBase
    FutureHandle
    ModuleInitializer
    Timestamp
    Variant
- firebase::admob
- firebase::admob::rewarded_video
  - 概览
  - Classes
    Listener
    PollableRewardListener
  - Structs
    RewardItem
- firebase::analytics
  - 概览
  - Structs
    Parameter
- firebase::auth
- firebase::database
  - 概览
  - Classes
    ChildListener
    Database
    DatabaseReference
    DataSnapshot
    DisconnectionHandler
    MutableData
    Query
    ValueListener
- firebase::dynamic_links
- firebase::firestore
  - 概览
  - Classes
    CollectionReference
    DocumentChange
    DocumentReference
    DocumentSnapshot
    EventListener
    FieldPath
    FieldValue
    Firestore
    GeoPoint
    ListenerRegistration
    LoadBundleTaskProgress
    Query
    QuerySnapshot
    SetOptions
    Settings
    SnapshotMetadata
    Transaction
    WriteBatch
- firebase::functions
  - 概览
  - Classes
    Functions
    HttpsCallableReference
    HttpsCallableResult
- firebase::installations
  - 概览
  - Classes
    Installations
- firebase::messaging
  - 概览
  - Classes
    Listener
    PollableListener
  - Structs
    AndroidNotificationParams
    Message
    MessagingOptions
    Notification
- firebase::performance
  - 概览
  - Classes
    HttpMetric
    Trace
- firebase::remote_config
  - 概览
  - Classes
    RemoteConfig
  - Structs
    ConfigInfo
    ConfigKeyValue
    ConfigKeyValueVariant
    ConfigSettings
    ValueInfo
- firebase::storage
  - 概览
  - Classes
    Controller
    Listener
    Metadata
    Storage
    StorageReference
- std
  - 概览
  - Structs
    FieldPath >
- Modules
- Namespaces
- Related Pages
  - Deprecated List
Unity
- 概览
- Firebase
  - 概览
  - Classes
    AppOptions
    FirebaseApp
    FirebaseApp.EnableModuleParams
    FirebaseException
    InitializationException
- Firebase.Analytics
  - 概览
  - Classes
    FirebaseAnalytics
    Parameter
- Firebase.Auth
- Firebase.Crashlytics
  - 概览
  - Classes
    Crashlytics
- Firebase.Database
  - 概览
  - Classes
    ChildChangedEventArgs
    DatabaseError
    DatabaseException
    DatabaseReference
    DataSnapshot
    FirebaseDatabase
    MutableData
    OnDisconnect
    Query
    ServerValue
    TransactionResult
    ValueChangedEventArgs
- Firebase.DynamicLinks
  - 概览
  - Classes
    AndroidParameters
    DynamicLinkComponents
    DynamicLinkOptions
    DynamicLinks
    GoogleAnalyticsParameters
    IOSParameters
    ITunesConnectAnalyticsParameters
    ReceivedDynamicLink
    ReceivedDynamicLinkEventArgs
    ShortDynamicLink
    SocialMetaTagParameters
- Firebase.Extensions
  - 概览
  - Classes
    TaskExtension
- Firebase.Firestore
- Firebase.Functions
  - 概览
  - Classes
    FirebaseFunctions
    FunctionsException
    HttpsCallableReference
    HttpsCallableResult
- Firebase.Installations
  - 概览
  - Classes
    FirebaseInstallations
- Firebase.Messaging
  - 概览
  - Classes
    AndroidNotificationParams
    FirebaseMessage
    FirebaseMessaging
    FirebaseNotification
    MessageReceivedEventArgs
    MessagingOptions
    TokenReceivedEventArgs
- Firebase.RemoteConfig
  - 概览
  - Classes
    ConfigInfo
    FirebaseRemoteConfig
  - Structs
    ConfigSettings
    ConfigValue
- Firebase.Storage
  - 概览
  - Classes
    DownloadState
    FirebaseStorage
    MetadataChange
    StorageException
    StorageMetadata
    StorageProgress< T >
    StorageReference
    UploadState
- System.Threading.Tasks
  - 概览
  - Classes
    Task
    Task< T >
- Namespaces
  - System
  - System.Threading
Cloud Functions
- 概览
- functions
- functions.config
- functions.function-configuration
- functions.analytics
- functions.auth
- functions.firestore
- functions.database
- functions.https
- functions.logger
  - 概览
  - LogEntry
- functions.pubsub
- functions.remoteconfig
- functions.storage
- functions.testLab
- functions.handler
  - 概览
  - HandlerBuilder
Admin SDK