Google.Cloud.Firestore.Admin.V1 is a.NET client library for the Firestore Admin API.
Note:
This documentation is for version 2.4.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.Firestore.Admin.V1 package from NuGet. Add it to
your project in the normal way (for example by right-clicking on the
project in Visual Studio and choosing "Manage NuGet Packages...").
Authentication
When running on Google Cloud Platform, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
download a service account JSON file then set the GOOGLE_APPLICATION_CREDENTIALS environment variable to refer to it.
The credentials will automatically be used to authenticate. See the Getting Started With
Authentication guide for more details.
Create a client instance by calling the static Create or CreateAsync methods. Alternatively,
use the builder class associated with each client class (e.g. FirestoreAdminClientBuilder for FirestoreAdminClient)
as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,
and we recommend using a single instance across your entire application unless you have a particular need
to configure multiple client objects separately.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page documents version 2.4.0 of the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e .NET client library, which is designed for interacting with the Firestore Admin API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e library is 3.12.0, and there are multiple previous versions, starting at 3.11.0 down to 2.2.0 that can also be accessed, depending on project requirements.\u003c/p\u003e\n"],["\u003cp\u003eInstallation is done via the NuGet package manager, and the library handles authentication automatically when running on Google Cloud Platform.\u003c/p\u003e\n"],["\u003cp\u003eTo authenticate outside of the Google Cloud Platform, users can set the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable to the path of a service account JSON file, or by referencing the \u003ca href=\"https://cloud.google.com/docs/authentication/getting-started\"\u003eGetting Started With Authentication guide\u003c/a\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAll operations are managed via the \u003ccode\u003eFirestoreAdminClient\u003c/code\u003e class, which can be created using the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods and is thread-safe for use throughout the application.\u003c/p\u003e\n"]]],[],null,[]]
