Google.Cloud.Firestore.Admin.V1 is a.NET client library for the Firestore Admin API.
Note:
This documentation is for version 3.11.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, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
set up Application Default Credentials.
The credentials will automatically be used to authenticate. See
Set up Application Default Credentials 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.
Using the REST (HTTP/1.1) transport
This library defaults to performing RPCs using gRPC using the binary Protocol Buffer wire format.
However, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy
or other network issue.) To create a client using HTTP/1.1, specify a RestGrpcAdapter reference for the GrpcAdapter property in the client builder.
Sample code:
var client = new FirestoreAdminClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["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 webpage provides documentation for version 3.11.0 of the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e .NET client library, which is used for interacting with the Firestore Admin API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the library is 3.12.0, and links to documentation for other previous versions, ranging from 2.2.0 to 3.10.0, are also provided for different version support.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done via NuGet, and authentication is automatic when running on Google Cloud, but requires setting up Application Default Credentials otherwise.\u003c/p\u003e\n"],["\u003cp\u003eAll API operations are done through the \u003ccode\u003eFirestoreAdminClient\u003c/code\u003e, which can be created using either \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, and the library supports gRPC and HTTP/1.1 for transport.\u003c/p\u003e\n"],["\u003cp\u003eThe library can have its tranport selected, between gRPC and HTTP/1.1/JSON, to be used for communication with the API, with HTTP/1.1/JSON being used as fallback if gRPC cannot be used.\u003c/p\u003e\n"]]],[],null,[]]
