Method: contactGroups.batchGet

Para obtener una lista de los grupos de contactos que pertenecen al usuario autenticado, especifica una lista de nombres de recursos de grupos de contactos.

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 se establece, lo que no mostrará ningún miembro.
groupFields

string (FieldMask format)

Opcional. Una máscara de campo que restringe los campos que se muestran en el grupo. La configuración predeterminada es metadata, groupType, memberCount y name si no se configura o se establece como vacía. Los campos válidos son los siguientes:

  • datosdelcliente
  • TipoDeGrupo
  • miembro miembro
  • metadata
  • name

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

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

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

object (ContactGroupResponse)

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

Alcances de la autorización

Se necesita uno de los siguientes alcances 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.

Respuesta del grupo de contactos

Es 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)

El grupo de contactos.