Cloud Firestore API

Otomatik ölçeklendirme, yüksek performans ve uygulama geliştirme kolaylığı için oluşturulmuş NoSQL belge veritabanına erişim sağlar.

Hizmet: firestore.googleapis.com

Bu hizmeti çağırmak için Google tarafından sağlanan istemci kitaplıklarını kullanmanızı öneririz. Uygulamanızın bu hizmeti çağırmak için kendi kitaplıklarınızı kullanması gerekiyorsa API isteklerini yaparken aşağıdaki bilgileri kullanın.

Keşif belgesi

Keşif Belgesi, REST API'lerini tanımlamak ve tüketmek için makine tarafından okunabilen bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leriyle etkileşime giren diğer araçları oluşturmak için kullanılır. Bir hizmet birden fazla keşif belgesi sağlayabilir. Bu hizmet aşağıdaki keşif belgelerini sağlar:

Hizmet uç noktası

Hizmet uç noktası, bir API hizmetinin ağ adresini belirten bir temel URL'dir. Bir hizmetin birden fazla hizmet uç noktası olabilir. Bu hizmet aşağıdaki hizmet uç noktasına sahiptir ve aşağıdaki tüm URI'ler bu hizmet uç noktasına göredir:

  • https://firestore.googleapis.com

REST Kaynağı: v1beta2.projects.databases

Yöntemler
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Dokümanların tümünün veya bir alt kümesinin bir kopyasını Google Cloud Firestore'dan Google Cloud Storage gibi başka bir depolama sistemine aktarır.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
Belgeleri Google Cloud Firestore'a aktarır.

REST Kaynağı: v1beta2.projects.databases.collectionGroups.fields

Yöntemler
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Bir Field için meta verileri ve yapılandırmayı alır.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Bu veritabanına ilişkin alan yapılandırmasını ve meta verileri listeler.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Bir alan yapılandırmasını günceller.

REST Kaynağı: v1beta2.projects.databases.collectionGroups.indexes

Yöntemler
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Bileşik bir dizin oluşturur.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Bileşik dizini siler.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Bileşik bir dizin alır.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Bileşik dizinleri listeler.

REST Kaynağı: v1beta1.projects.databases

Yöntemler
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Dokümanların tümünün veya bir alt kümesinin bir kopyasını Google Cloud Firestore'dan Google Cloud Storage gibi başka bir depolama sistemine aktarır.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
Belgeleri Google Cloud Firestore'a aktarır.

REST Kaynağı: v1beta1.projects.databases.documents

Yöntemler
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
Birden fazla belge alır.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Bir dizi yazma işlemi uygular.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
Yeni bir işlem başlatır.
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
İsteğe bağlı olarak belgeleri güncellerken bir işlemi gerçekleştirir.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Yeni bir belge oluşturur.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Bir belgeyi siler.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Tek bir belge alır.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Belgeleri listeler.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Bir belgenin altındaki tüm koleksiyon kimliklerini listeler.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Belgeleri listeler.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Sorguyu paralel olarak çalıştırmak için kullanılabilecek bölüm imleçlerini döndürerek sorguyu bölümlere ayırır.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
Bir belgeyi günceller veya ekler.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
Bir işlemi geri alır.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Bir toplama sorgusu çalıştırır.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
Bir sorgu çalıştırır.

REST Kaynağı: v1beta1.projects.databases.indexes

Yöntemler
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
Belirtilen dizini oluşturur.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
Bir dizini siler.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
Bir indeks alır.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
Belirtilen filtrelerle eşleşen dizinleri listeler.

REST Kaynağı: v1.projects.databases

Yöntemler
create POST /v1/{parent=projects/*}/databases
Bir veritabanı oluşturun.
delete DELETE /v1/{name=projects/*/databases/*}
Bir veritabanını siler.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Dokümanların tümünün veya bir alt kümesinin bir kopyasını Google Cloud Firestore'dan Google Cloud Storage gibi başka bir depolama sistemine aktarır.
get GET /v1/{name=projects/*/databases/*}
Bir veritabanı hakkında bilgi alır.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
Belgeleri Google Cloud Firestore'a aktarır.
list GET /v1/{parent=projects/*}/databases
Projedeki tüm veritabanlarını listeleyin.
patch PATCH /v1/{database.name=projects/*/databases/*}
Bir veritabanını günceller.
restore POST /v1/{parent=projects/*}/databases:restore
Mevcut bir yedekten geri yükleyerek yeni bir veritabanı oluşturur.

REST Kaynağı: v1.projects.databases.backupSchedules

Yöntemler
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Veritabanında bir yedekleme planı oluşturur.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Bir yedekleme zamanlamasını siler.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Yedekleme zamanlaması hakkında bilgi alır.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Yedekleme programlarını listeleyin.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Bir yedekleme zamanlamasını günceller.

REST Kaynağı: v1.projects.databases.collectionGroups.fields

Yöntemler
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Bir Field için meta verileri ve yapılandırmayı alır.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
Bu veritabanına ilişkin alan yapılandırmasını ve meta verileri listeler.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Bir alan yapılandırmasını günceller.

REST Kaynağı: v1.projects.databases.collectionGroups.indexes

Yöntemler
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Bileşik bir dizin oluşturur.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Bileşik dizini siler.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Bileşik bir dizin alır.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Bileşik dizinleri listeler.

REST Kaynağı: v1.projects.databases.documents

Yöntemler
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Birden fazla belge alır.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Bir dizi yazma işlemi uygular.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
Yeni bir işlem başlatır.
commit POST /v1/{database=projects/*/databases/*}/documents:commit
İsteğe bağlı olarak belgeleri güncellerken bir işlemi gerçekleştirir.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Yeni bir belge oluşturur.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Bir belgeyi siler.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Tek bir belge alır.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Belgeleri listeler.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Bir belgenin altındaki tüm koleksiyon kimliklerini listeler.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Belgeleri listeler.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Sorguyu paralel olarak çalıştırmak için kullanılabilecek bölüm imleçlerini döndürerek sorguyu bölümlere ayırır.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
Bir belgeyi günceller veya ekler.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
Bir işlemi geri alır.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Bir toplama sorgusu çalıştırır.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
Bir sorgu çalıştırır.

REST Kaynağı: v1.projects.databases.operations

Yöntemler
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Uzun süren bir işlemde eşzamansız iptali başlatır.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
Uzun süredir devam eden bir işlemi siler.
get GET /v1/{name=projects/*/databases/*/operations/*}
Uzun süren bir işlemin en son durumunu alır.
list GET /v1/{name=projects/*/databases/*}/operations
İstekte belirtilen filtreyle eşleşen işlemleri listeler.

REST Kaynağı: v1.projects.locations

Yöntemler
get GET /v1/{name=projects/*/locations/*}
Bir konum hakkında bilgi alır.
list GET /v1/{name=projects/*}/locations
Bu hizmet için desteklenen konumlarla ilgili bilgileri listeler.

REST Kaynağı: v1.projects.locations.backups

Yöntemler
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
Bir yedeklemeyi siler.
get GET /v1/{name=projects/*/locations/*/backups/*}
Yedekleme hakkında bilgi alır.
list GET /v1/{parent=projects/*/locations/*}/backups
Tüm yedeklemeleri listeler.