Method: contactGroups.batchGet

Ricevi un elenco dei gruppi di contatti di proprietà dell'utente autenticato specificando un elenco di nomi di risorse per i gruppi di contatti.

Richiesta HTTP

GET https://people.googleapis.com/v1/contactGroups:batchGet

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
resourceNames[]

string

obbligatorio. I nomi delle risorse dei gruppi di contatti da ottenere.

Sono consentiti al massimo 200 nomi di risorse.

maxMembers

integer

Campo facoltativo. Specifica il numero massimo di membri da restituire per ogni gruppo. Se non viene configurato, il valore predefinito è 0, che restituirà zero membri.

groupFields

string (FieldMask format)

Campo facoltativo. Una maschera dei campi per limitare i campi del gruppo che vengono restituiti. Se non viene configurato o se viene lasciato vuoto, il valore predefinito è metadata, groupType, memberCount e name. I campi validi sono:

  • clientData
  • groupType
  • memberCount
  • metadati
  • nome

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta a una richiesta di recupero dei gruppi di contatti in batch.

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

Rappresentazione JSON
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Campi
responses[]

object (ContactGroupResponse)

L'elenco di risposte per ogni risorsa del gruppo di contatti richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

Per ulteriori informazioni, consulta la guida all'autorizzazione.

ContactGroupResponse

La risposta per un gruppo di contatti specifico.

Rappresentazione JSON
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Campi
requestedResourceName

string

Il nome della risorsa originale richiesto.

status

object (Status)

Lo stato della risposta.

contactGroup

object (ContactGroup)

Il gruppo di contatti.