Sync docs from Google internal (#17425)

kevinthecheung · web-flow · commit d2b660ce0d4b · 2025-06-16T10:22:46.000-07:00
diff --git a/docs/app-check/custom-resource.md b/docs/app-check/custom-resource.md
@@ -1,12 +1,16 @@
-Project: /docs/_project.yaml
+Project: /docs/app-check/_project.yaml
 Book: /docs/_book.yaml
 
+{% include "docs/app-check/_local_variables.html" %}
+{% include "_shared/firebase/_snippet_include_comment.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
-# Protect non-Firebase resources with App Check
+# Protect custom backend resources with {{app_check}} in Flutter projects
 
-You can protect your app's non-Firebase resources, such as self-hosted backends,
-with App Check. To do so, you will need to do both of the following:
+You can use {{app_check}} to protect non-Google custom backend resources for
+your app, like your own self-hosted backend. To do so, you'll need to do both of
+the following:
 
 - Modify your app client to send an App Check token along with each request
   to your backend, as described on this page.
diff --git a/docs/app-check/default-providers.md b/docs/app-check/default-providers.md
@@ -142,5 +142,5 @@ App Check debug provider instead of a real attestation provider.
 
 See [Use App Check with the debug provider in Flutter apps](/docs/app-check/flutter/debug-provider).
 
-Note: For certain Android devices, you need to enable "Meets basic device integrity" in the 
-Google Play console.
+Note: For certain Android devices, you need to enable "Meets basic device
+integrity" in the Google Play console.
diff --git a/docs/auth/email-link-auth.md b/docs/auth/email-link-auth.md
@@ -50,15 +50,29 @@ To initiate the authentication flow, present an interface that prompts the user
 
 1.  Construct the ActionCodeSettings object, which provides Firebase with instructions on how to construct the email link. Set the following fields:
 
-    * `url`: The deep link to embed and any additional state to be passed along. The link's domain has to be whitelisted in the Firebase Console list of authorized domains, which can be found by going to the Settings tab (Authentication -> Settings -> Authorized Domains). The link will redirect the user to this URL if the app is not installed on their device and the app was not able to be installed.
+    * `url`: The deep link to embed and any additional state to be passed along.
+      The link's domain has to be present in the Firebase Console list of
+      authorized domains, which can be found by going to the Settings tab
+      (Authentication -> Settings -> Authorized Domains). The link will redirect
+      the user to this URL if the app is not installed on their device and the
+      app was not able to be installed.
 
     * `androidPackageName` and `IOSBundleId`: The apps to use when the sign-in link is opened on an Android or iOS device. Learn more on how to configure Firebase Dynamic Links to open email action links via mobile apps.
 
     * `handleCodeInApp`: Set to `true`. The sign-in operation has to always be completed in the app unlike other out of band email actions (password reset and email verifications). This is because, at the end of the flow, the user is expected to be signed in and their Auth state persisted within the app.
 
-    * `dynamicLinkDomain`: (Deprecated, use `linkDomain`) When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). Otherwise the first domain is automatically selected.
+    * `dynamicLinkDomain`: (Deprecated, use `linkDomain`) When multiple
+      custom dynamic link domains are defined for a project, specify which one
+      to use when the link is to be opened using a specified mobile app (for
+      example, `example.page.link`). Otherwise the first domain is
+      automatically selected.
 
-    * `linkDomain`: The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).  This replaces the deprecated `dynamicLinkDomain` setting.
+    * `linkDomain`: The optional custom Firebase Hosting domain to use
+      when the link is to be opened using a specified mobile app. The domain
+      must be configured in Firebase Hosting and owned by the project.
+      This cannot be a default Hosting domain (`web.app` or
+      `firebaseapp.com`). This replaces the deprecated `dynamicLinkDomain`
+      setting.
 
     ```dart
     var acs = ActionCodeSettings(
@@ -120,7 +134,7 @@ potentially intercepted by intermediary servers.
 
 Firebase Dynamic Links is deprecated; Firebase Hosting is now used to send a sign-in link. Follow the guides for platform specific configuration:
 
-- [Android](https://firebase.google.com/docs/auth/android/email-link-auth#complete-android-signin) and
+- [Android](https://firebase.google.com/docs/auth/android/email-link-auth#complete-android-signin)
 - [iOS](https://firebase.google.com/docs/auth/ios/email-link-auth#complete-apple-signin)
 - [Web](https://firebase.google.com/docs/auth/web/email-link-auth#completing_sign-in_in_a_web_page)
 
diff --git a/docs/auth/multi-factor.md b/docs/auth/multi-factor.md
@@ -6,7 +6,8 @@ Book: /docs/_book.yaml
 # Add multi-factor authentication to your Flutter app
 
 If you've upgraded to Firebase Authentication with Identity Platform,
- you can add SMS multi-factor authentication to your Flutter app.
+you can add SMS multi-factor authentication to your Flutter app.
+
 Note: Avoid the use of SMS-based MFA. SMS is an insecure technology that is easy to compromise or spoof with
 no authentication mechanism or eavesdropping protection.
 
diff --git a/docs/crashlytics/_customize-crash-reports.md b/docs/crashlytics/_customize-crash-reports.md
@@ -258,10 +258,12 @@ which includes the data that populates breadcrumb logs.
 
 ## Enable opt-in reporting {: #enable-reporting}
 
+<<../_includes/customize-crash-reports/_enable-opt-in_impact-awareness-note.md>>
+
 By default, {{crashlytics}} automatically collects crash reports for all your
 app's users. To give users more control over the data they send, you can enable
 opt-in reporting by disabling automatic reporting and only sending data to
-{{crashlytics}} when you choose to in your code:
+{{crashlytics}} when you choose to in your code.
 
 1.  Turn off automatic collection natively:
 
@@ -284,18 +286,19 @@ opt-in reporting by disabling automatic reporting and only sending data to
     ```
 
 1.  Enable collection for select users by calling the {{crashlytics}} data
-    collection override at runtime.
-
-    The override value persists across launches of your app so {{crashlytics}}
-    can automatically collect reports. To opt out of automatic crash reporting,
-    pass `false` as the override value. When set to `false`, the new value does
-    not apply until the next run of the app.
+    collection override at runtime. The override value persists across all
+    subsequent launches of your app so {{crashlytics}} can automatically collect
+    reports for that user.
 
     ```dart
     FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
     ```
 
-Note: When data collection is disabled, {{crashlytics}} will store crash
-information locally on the device. If data collection is subsequently enabled,
-any crash information stored on the device will be sent to {{crashlytics}} for
-processing.
+    If the user later opts-out of data collection, you can pass `false` as the
+    override value, which will apply the next time the user launches the app and
+    will persist across all subsequent launches for that user.
+
+Note: When data collection is disabled for a user, {{crashlytics}} will
+store crash information locally on the device. If data collection is
+subsequently enabled, any crash information stored on the device will be
+sent to {{crashlytics}} for processing.
diff --git a/docs/setup/_setup_main.md b/docs/setup/_setup_main.md
@@ -130,9 +130,11 @@ flutterfire configure
     `DefaultFirebaseOptions` object exported by the configuration file:
 
     ```dart
+    WidgetsFlutterBinding.ensureInitialized();
     await Firebase.initializeApp(
       options: DefaultFirebaseOptions.currentPlatform,
     );
+    runApp(const MyApp());
     ```
 
 1.  Rebuild your Flutter application:
@@ -193,7 +195,8 @@ You're all set! Your Flutter apps are registered and configured to use Firebase.
 {% setvar YES %}<div class="center compare-yes"></div>{% endsetvar %}
 
 Product                                          | Plugin name                    | iOS     | Android | Web     | Other Apple<br>(macOS, etc.) | Windows
--------------------------------------------------|--------------------------------|---------|---------|---------|--------------------------|--------
+-------------------------------------------------|--------------------------------|---------|---------|---------|:--------------------------:|:-------:
+[{{firebase_vertexai}}][vertex ai docs]  <sup>1</sup> | `firebase_ai`             | {{YES}} | {{YES}} | {{YES}} | beta |
 [{{analytics}}][analytics docs]                  | `firebase_analytics`           | {{YES}} | {{YES}} | {{YES}} | beta |
 [{{app_check}}][app check docs]                  | `firebase_app_check`           | {{YES}} | {{YES}} | {{YES}} | beta |
 [{{auth}}][auth docs]                            | `firebase_auth`                | {{YES}} | {{YES}} | {{YES}} | beta | beta
@@ -202,6 +205,7 @@ Product                                          | Plugin name
 [{{messaging_longer}}][fcm docs]                 | `firebase_messaging`           | {{YES}} | {{YES}} | {{YES}} | beta |
 [{{storage}}][storage docs]                      | `firebase_storage`             | {{YES}} | {{YES}} | {{YES}} | beta | beta
 [{{crashlytics}}][crashlytics docs]              | `firebase_crashlytics`         | {{YES}} | {{YES}} |         | beta |
+[{{data_connect_short}}][dataconnect docs]       | `firebase_data_connect`        | {{YES}} | {{YES}} | {{YES}} | |
 [{{ddls}}][ddls docs]                            | `firebase_dynamic_links`       | {{YES}} | {{YES}} |         | |
 [{{inappmessaging}}][fiam docs]                  | `firebase_in_app_messaging`    | {{YES}} | {{YES}} |         | |
 [{{firebase_installations}}][installations docs] | `firebase_app_installations`   | {{YES}} | {{YES}} | {{YES}} | beta |
@@ -210,6 +214,12 @@ Product                                          | Plugin name
 [{{database}}][rtdb docs]                        | `firebase_database`            | {{YES}} | {{YES}} | {{YES}} | beta |
 [{{remote_config}}][remote config docs]          | `firebase_remote_config`       | {{YES}} | {{YES}} | {{YES}} | beta |
 
+<sup>
+  <b>1</b> <em>{{firebase_vertexai}} was formerly called
+  "{{vertex_ai_in_firebase}}" with the plugin
+  <code>firebase_vertexai</code>.</em>
+</sup>
+
 Caution: Firebase on Windows is not intended for production use cases, only local development workflows.
 
 ## Try out an example app with {{analytics}} {: #try-analytics-example-app}
@@ -322,10 +332,12 @@ By default, the Firebase Flutter SDK auto-injects the Firebase JavaScript SDK wh
 [fcm docs]: /docs/cloud-messaging/flutter/client
 [storage docs]: /docs/storage/flutter/start
 [crashlytics docs]: /docs/crashlytics/get-started?platform=flutter
+[dataconnect docs]: /docs/data-connect/flutter-sdk
 [ddls docs]: /docs/dynamic-links/flutter/create
 [fiam docs]: /docs/in-app-messaging/get-started?platform=flutter
 [installations docs]: /docs/projects/manage-installations
 [ml docs]: /docs/ml/flutter/use-custom-models
 [perfmon docs]: /docs/perf-mon/flutter/get-started
 [rtdb docs]: /docs/database/flutter/start
 [remote config docs]: /docs/remote-config/get-started?platform=flutter
+[vertex ai docs]: /docs/ai-logic/get-started
diff --git a/docs/storage/create-reference.md b/docs/storage/create-reference.md
@@ -2,6 +2,11 @@ Project: /docs/storage/_project.yaml
 Book: /docs/_book.yaml
 page_type: guide
 
+{# The following is at site root, /third_party/devsite/firebase/en/ #}
+{% include "_local_variables.html" %}
+
+{% include "docs/storage/_local_variables.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
 # Create a Cloud Storage reference on Flutter
diff --git a/docs/storage/delete-files.md b/docs/storage/delete-files.md
@@ -2,20 +2,18 @@ Project: /docs/storage/_project.yaml
 Book: /docs/_book.yaml
 page_type: guide
 
+{# The following is at site root, /third_party/devsite/firebase/en/ #}
+{% include "_local_variables.html" %}
+
+{% include "docs/storage/_local_variables.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
 # Delete files with Cloud Storage on Flutter
 
 After uploading files to Cloud Storage, you can also delete them.
 
-Note: By default, a Cloud Storage bucket requires Firebase Authentication to
-perform any action on the bucket's data or files. You can
-[change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
-to allow unauthenticated access. Since Firebase and your project's default
-App Engine app share this bucket, configuring public access may make newly
-uploaded App Engine files publicly accessible, as well. Be sure to restrict
-access to your Cloud Storage bucket again when you set up Authentication.
-
+<<../_includes/_restrict_access_to_bucket_note.md>>
 
 ## Delete a File
 
diff --git a/docs/storage/download-files.md b/docs/storage/download-files.md
@@ -2,6 +2,11 @@ Project: /docs/storage/_project.yaml
 Book: /docs/_book.yaml
 page_type: guide
 
+{# The following is at site root, /third_party/devsite/firebase/en/ #}
+{% include "_local_variables.html" %}
+
+{% include "docs/storage/_local_variables.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
 # Download files with Cloud Storage on Flutter
@@ -10,15 +15,7 @@ Cloud Storage for Firebase allows you to quickly and easily download
 files from a [Cloud Storage](//cloud.google.com/storage)
 bucket provided and managed by Firebase.
 
-Note: By default, a Cloud Storage bucket requires Firebase Authentication to
-perform any action on the bucket's data or files. You can
-[change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
-to allow unauthenticated access. Since Firebase and your project's default
-App Engine app share this bucket, configuring public access may make newly
-uploaded App Engine files publicly accessible, as well. Be sure to restrict
-access to your Cloud Storage bucket again when you set up Authentication.
-
-
+<<../_includes/_restrict_access_to_bucket_note.md>>
 
 ## Create a Reference
 
@@ -50,7 +47,7 @@ final httpsReference = FirebaseStorage.instance.refFromURL(
 ## Download Files
 
 Once you have a reference, you can download files from Cloud Storage
-by calling the `getData()` function. If you prefer to download the file
+by calling the `getData()`. If you prefer to download the file
 with another library, you can get a download URL with `getDownloadUrl()`.
 
 ### Download in memory
diff --git a/docs/storage/file-metadata.md b/docs/storage/file-metadata.md
@@ -2,6 +2,11 @@ Project: /docs/storage/_project.yaml
 Book: /docs/_book.yaml
 page_type: guide
 
+{# The following is at site root, /third_party/devsite/firebase/en/ #}
+{% include "_local_variables.html" %}
+
+{% include "docs/storage/_local_variables.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
 # Use file metadata with Cloud Storage on Flutter
@@ -10,15 +15,7 @@ After uploading a file to Cloud Storage reference, you can also get
 and update the file metadata, for example to view or update the content type.
 Files can also store custom key/value pairs with additional file metadata.
 
-Note: By default, a Cloud Storage bucket requires Firebase Authentication to
-perform any action on the bucket's data or files. You can
-[change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
-to allow unauthenticated access. Since Firebase and your project's default
-App Engine app share this bucket, configuring public access may make newly
-uploaded App Engine files publicly accessible, as well. Be sure to restrict
-access to your Cloud Storage bucket again when you set up Authentication.
-
-
+<<../_includes/_restrict_access_to_bucket_note.md>>
 
 ## Get File Metadata
 
diff --git a/docs/storage/handle-errors.md b/docs/storage/handle-errors.md
@@ -2,6 +2,11 @@ Project: /docs/storage/_project.yaml
 Book: /docs/_book.yaml
 page_type: guide
 
+{# The following is at site root, /third_party/devsite/firebase/en/ #}
+{% include "_local_variables.html" %}
+
+{% include "docs/storage/_local_variables.html" %}
+
 <link rel="stylesheet" type="text/css" href="/styles/docs.css" />
 
 # Handle errors for Cloud Storage on Flutter
@@ -22,14 +27,7 @@ try {
 }
 ```
 
-Note: By default, a Cloud Storage bucket requires Firebase Authentication to
-perform any action on the bucket's data or files. You can
-[change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
-to allow unauthenticated access. Since Firebase and your project's default
-App Engine app share this bucket, configuring public access may make newly
-uploaded App Engine files publicly accessible, as well. Be sure to restrict
-access to your Cloud Storage bucket again when you set up Authentication.
-
+<<../_includes/_restrict_access_to_bucket_note.md>>
 
 ## Handle Error Messages
 
@@ -46,7 +44,7 @@ Code                             | Description
 `storage/object-not-found`       | No object exists at the desired reference.
 `storage/bucket-not-found`       | No bucket is configured for Cloud Storage
 `storage/project-not-found`      | No project is configured for Cloud Storage
-`storage/quota-exceeded`         | Quota on your Cloud Storage bucket has been exceeded. If you're on the no-cost tier, upgrade to a paid plan. If you're on a paid plan, reach out to Firebase support.
+`storage/quota-exceeded`         | Quota on your {{firebase_storage}} bucket has been exceeded. If you're on the {{spark_plan_no_link_short}}, consider upgrading to the {{blaze_plan_with_link}}. If you're already on the {{blaze_plan_no_link_short}}, reach out to Firebase Support.<br><br>**Important**: Starting {{date_require_blaze_maintain_access_to_storage}}, the [{{blaze_plan_no_link_short}} will be _required_ to use {{firebase_storage}}](/docs/storage/faqs-storage-changes-announced-sept-2024), even default buckets.
 `storage/unauthenticated`        | User is unauthenticated, please authenticate and try again.
 `storage/unauthorized`           | User is not authorized to perform the desired action, check your security rules to ensure they are correct.
 `storage/retry-limit-exceeded`   | The maximum time limit on an operation (upload, download, delete, etc.) has been excceded. Try uploading again.
diff --git a/docs/storage/start.md b/docs/storage/start.md
diff --git a/docs/storage/upload-files.md b/docs/storage/upload-files.md
