Google.Cloud.Firestore.Admin.V1 is a.NET client library for the Firestore Admin API.
Note:
This documentation is for version 3.12.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"]],[["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-04-02 UTC."],[[["The `Google.Cloud.Firestore.Admin.V1` library is a .NET client for the Firestore Admin API, with the latest version being 3.12.0, and provides access to the Firestore database management features."],["Installation of the library is done through NuGet, and it can be easily added to your project via Visual Studio's \"Manage NuGet Packages...\" feature, allowing easy integration into your .NET projects."],["Authentication when using this library on Google Cloud is automatic, while for other environments, Application Default Credentials can be configured to authenticate API calls, and is the simplest method."],["All interactions with the API are managed through the `FirestoreAdminClient` class, which can be instantiated using `Create` or `CreateAsync`, or configured with specific settings via the `FirestoreAdminClientBuilder`."],["The library defaults to gRPC and Protocol Buffer for communication, but also offers an option to use HTTP/1.1 and JSON by setting the `GrpcAdapter` to `RestGrpcAdapter.Default` in the client builder for environments where gRPC is unsuitable."]]],[]]
