Method: contactGroups.batchGet

Especifica una lista de nombres de recursos de grupos de contactos para obtener una lista de los grupos de contactos que pertenecen al usuario autenticado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
resourceNames[]

string

Obligatorio. Los nombres de recursos de los grupos de contactos que se obtendrán.

Hay un máximo de 200 nombres de recursos.
maxMembers

integer

Opcional. Especifica la cantidad máxima de miembros que se mostrarán para cada grupo. El valor predeterminado es 0 si no está configurado, lo que mostrará cero miembros.
groupFields

string (FieldMask format)

Opcional. Una máscara de campo para restringir los campos del grupo que se muestran. El valor predeterminado es metadata, groupType, memberCount y name si no se establece o si está vacío. Los campos válidos son los siguientes:

  • clientData
  • groupType
  • memberCount
  • metadatos
  • nombre

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta a una solicitud de obtención de grupos de contactos por lotes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Campos
responses[]

object (ContactGroupResponse)

La lista de respuestas para cada recurso solicitado del grupo de contactos.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

ContactGroupResponse

La respuesta para un grupo de contactos específico.

Representación JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Campos
requestedResourceName

string

El nombre del recurso solicitado original.
status

object (Status)

El estado de la respuesta.
contactGroup

object (ContactGroup)

Indica el grupo de contactos.