Method: projects.databases.collectionGroups.fields.list

Elenca la configurazione dei campi e i metadati per questo database.

Attualmente, FirestoreAdmin.ListFields supporta solo i campi dell'elenco di cui è stato eseguito l'override esplicito. Per eseguire questa query, chiama FirestoreAdmin.ListFields con il filtro impostato su indexConfig.usesAncestorConfig:false.

Richiesta HTTP

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Un nome principale del modulo projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parametri di ricerca

Parametri
filter

string

Il filtro da applicare ai risultati dell'elenco. Attualmente, FirestoreAdmin.ListFields supporta solo i campi dell'elenco di cui è stato eseguito l'override esplicito. Per eseguire questa query, chiama FirestoreAdmin.ListFields con il filtro impostato su indexConfig.usesAncestorConfig:false.
pageSize

integer

Il numero di risultati da restituire.
pageToken

string

Un token di pagina, restituito da una precedente chiamata a FirestoreAdmin.ListFields, che può essere utilizzato per ricevere la pagina dei risultati successiva.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta per FirestoreAdmin.ListFields.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Campi
fields[]

object (Field)

I campi richiesti.
nextPageToken

string

Un token di pagina che può essere utilizzato per richiedere un'altra pagina di risultati. Se vuota, si tratta dell'ultima pagina.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.