Method: contactGroups.batchGet

Recupera un elenco dei gruppi di contatti di proprietà dell'utente autenticato specificando un elenco di nomi delle risorse dei gruppi di contatti.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
resourceNames[]

string

Obbligatorio. I nomi delle risorse dei gruppi di contatti da recuperare.

È consentito un massimo di 200 nomi di risorse.

maxMembers

integer

(Facoltativo) Specifica il numero massimo di membri da restituire per ogni gruppo. Se non è impostato, il valore predefinito è 0, che restituirà zero membri.

groupFields

string (FieldMask format)

(Facoltativo) Una maschera del campo per limitare i campi restituiti del gruppo. Se il criterio 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 originale della risorsa richiesto.

status

object (Status)

Lo stato della risposta.

contactGroup

object (ContactGroup)

Il gruppo di contatti.