Google.Cloud.Firestore.Admin.V1is a.NET client library for theFirestore Admin API.
Note:
This documentation is for version3.1.0of the library.
Some samples may not work with other versions.
Installation
Install theGoogle.Cloud.Firestore.Admin.V1package 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 theGOOGLE_APPLICATION_CREDENTIALSenvironment variable to refer to it.
The credentials will automatically be used to authenticate. See theGetting Started With
Authenticationguide for more details.
Create a client instance by calling the staticCreateorCreateAsyncmethods. 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 usinggRPCusing the binaryProtocol Bufferwire 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 aRestGrpcAdapterreference for theGrpcAdapterproperty 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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e library is a .NET client for interacting with the Firestore Admin API, and the current documentation covers version 3.1.0.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done through NuGet, by adding the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e package to your project.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication when running on Google Cloud Platform is automatic, and for other environments, setting the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable to a service account JSON file is recommended.\u003c/p\u003e\n"],["\u003cp\u003eAll operations are managed through the \u003ccode\u003eFirestoreAdminClient\u003c/code\u003e, which can be created via the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, and it's also recommended to create one instance across the application.\u003c/p\u003e\n"],["\u003cp\u003eThe library defaults to gRPC, but also supports HTTP/1.1 and JSON, and using the client builder with a \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e reference can enable this support.\u003c/p\u003e\n"]]],[],null,[]]
