Google.Cloud.Firestore.Admin.V1 is a.NET client library for the Firestore Admin API.
Note:
This documentation is for version 3.8.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 page documents version 3.8.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 library supports multiple versions, with the latest being 3.12.0, and the documentation includes links to the documentation for each of the previous versions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e package can be installed from NuGet, and authentication is seamless when running on Google Cloud or can be set up using Application Default Credentials.\u003c/p\u003e\n"],["\u003cp\u003eAll operations are performed through the \u003ccode\u003eFirestoreAdminClient\u003c/code\u003e, which can be created using the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods or via the \u003ccode\u003eFirestoreAdminClientBuilder\u003c/code\u003e for custom configurations.\u003c/p\u003e\n"],["\u003cp\u003eWhile the library primarily uses gRPC, it also supports HTTP/1.1 and JSON by specifying a \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e in the client builder for environments where gRPC is not suitable.\u003c/p\u003e\n"]]],[],null,[]]
