Method: contactGroups.batchGet

Pobierz listę grup kontaktów należących do uwierzytelnionego użytkownika przez określenie listy nazw zasobów grup kontaktów.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
resourceNames[]

string

To pole jest wymagane. Nazwy zasobów grup kontaktów, które chcesz uzyskać.

Maksymalna liczba nazw zasobów to 200.
maxMembers

integer

Opcjonalnie. Określa maksymalną liczbę członków do zwrócenia w przypadku każdej grupy. Jeśli nie zostanie ustawiona, domyślna wartość to 0, co zwraca 0 użytkowników.
groupFields

string (FieldMask format)

Opcjonalnie. Maska pola określająca, które pola w grupie mają być zwracane. Jeśli nie jest ustawiony lub jest pusty, domyślna wartość to metadata, groupType, memberCount i name. Prawidłowe pola to:

  • clientData
  • groupType
  • memberCount
  • metadane
  • nazwa

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie zbiorcze dotyczące grupy kontaktów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Pola
responses[]

object (ContactGroupResponse)

Lista odpowiedzi dla każdego żądanego zasobu grupy kontaktów.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

ContactGroupResponse

Odpowiedź dotycząca określonej grupy kontaktów.

Zapis JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Pola
requestedResourceName

string

Pierwotnie żądana nazwa zasobu.
status

object (Status)

Stan odpowiedzi.
contactGroup

object (ContactGroup)

Grupa kontaktów.