Google.Cloud.Firestore.Admin.V1 is a.NET client library for the Firestore Admin API.
Note:
This documentation is for version 3.2.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.
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 documents version 3.2.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 library is 3.12.0, and other versions are available, ranging from 3.11.0 down to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library can be done using the Nuget Package Manager, where the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e package should be added to your project.\u003c/p\u003e\n"],["\u003cp\u003eThe library supports authentication on Google Cloud Platform without needing any additional steps, and outside of GCP it can authenticate using a downloaded service account JSON file with the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e variable set.\u003c/p\u003e\n"],["\u003cp\u003eThe library defaults to using gRPC for API calls but can be configured to use HTTP/1.1 with JSON by specifying \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e in the \u003ccode\u003eGrpcAdapter\u003c/code\u003e property of the client builder.\u003c/p\u003e\n"]]],[],null,[]]
