Cloud Firestore API

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

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 istekleri yaparken aşağıdaki bilgileri kullanın.

Keşif dokümanı

Keşif Belgesi, REST API'lerini açıklamak ve kullanmak için makine tarafından okunabilir bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leriyle etkileşimde bulunan başka araçlar oluşturmak için kullanılır. Bir hizmet, birden fazla keşif dokümanı sağlayabilir. Bu hizmet aşağıdaki keşif belgelerini sağlar:

Hizmet uç noktası

Hizmet uç noktası, bir API hizmetinin ağ adresini belirten 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öre belirlenir:

  • https://firestore.googleapis.com

REST Kaynağı: v1beta2.projects.databases

Yöntemler
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Belgelerin tümünün veya bir alt kümesinin Google Cloud Firestore'daki kopyasını 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 Alan için meta verileri ve yapılandırmayı alır.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Bu veritabanı için alan yapılandırmasını ve meta verileri listeler.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
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/*}
Bir 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
Belgelerin tümünün veya bir alt kümesinin Google Cloud Firestore'daki kopyasını 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 çok dokümanı alır.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Bir yazma işlemi grubunu toplu olarak 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şlem gerçekleştirir.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Yeni bir doküman oluşturur.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Dokümanı siler.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Tek bir belgeyi alır.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Dokümanları listeler.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Belgenin altındaki tüm koleksiyon kimliklerini listeler.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Dokümanları 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/*/**}
Dokümanı günceller veya ekler.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
İşlemi geri alır.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Toplama sorgusu çalıştırır.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
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 dizin 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
Veritabanı oluşturun.
delete DELETE /v1/{name=projects/*/databases/*}
Veritabanını siler.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Belgelerin tümünün veya bir alt kümesinin Google Cloud Firestore'daki kopyasını 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ı üzerinde yedekleme planı oluşturur.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Yedekleme planını siler.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Yedekleme programıyla ilgili bilgileri alır.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Yedekleme programlarını listeleyin.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Yedekleme planını günceller.

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

Yöntemler
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Bir Alan için meta verileri ve yapılandırmayı alır.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
Bu veritabanı için alan yapılandırmasını ve meta verileri listeler.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
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/*}
Bir 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 çok dokümanı alır.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Bir yazma işlemi grubunu toplu olarak 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şlem gerçekleştirir.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Yeni bir doküman oluşturur.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Dokümanı siler.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Tek bir belgeyi alır.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Dokümanları listeler.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Belgenin altındaki tüm koleksiyon kimliklerini listeler.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Dokümanları 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/*/**}
Dokümanı günceller veya ekler.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
İşlemi geri alır.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Toplama sorgusu çalıştırır.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
Sorgu çalıştırır.

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

Yöntemler
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Uzun süreli bir işlemde eşzamansız iptali başlatır.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
Uzun süren bir işlemi siler.
get GET /v1/{name=projects/*/databases/*/operations/*}
Uzun süreli 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ındaki bilgileri 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 yedeği siler.
get GET /v1/{name=projects/*/locations/*/backups/*}
Bir yedeklemeyle ilgili bilgileri alır.
list GET /v1/{parent=projects/*/locations/*}/backups
Tüm yedekleri listeler.