Method: people.batchUpdateContacts

Aktualizuj grupę kontaktów i zwracaj mapę nazw zasobów dla zaktualizowanych kontaktów w odpowiedzi PersonResponses.

Żądania mutacji dotyczące tego samego użytkownika powinny być wysyłane po kolei, aby uniknąć wydłużenia czasu oczekiwania i błędów.

Żądanie HTTP

POST https://people.googleapis.com/v1/people:batchUpdateContacts

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Pola
contacts

map (key: string, value: object (Person))

Wymagane. Mapa nazw zasobów na dane osób, które mają zostać zaktualizowane. Zezwala na przesłanie do 200 kontaktów w jednej prośbie.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

Wymagane. Maska pola ograniczająca, które pola na osobie są aktualizowane. Można określić wiele pól, rozdzielając je przecinkami. Wszystkie określone pola zostaną zastąpione lub wyczyszczone, jeśli pozostawisz puste pola dla każdej osoby. Prawidłowe wartości to:

  • adresy
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • języki
  • lokalizacje
  • kanału
  • miscKeywords
  • nazwy
  • pseudonimy
  • zawody
  • organizacje
  • phoneNumbers
  • relacje
  • sipAddresses
  • adresy
  • userDefined
readMask

string (FieldMask format)

Wymagane. Maska pola ograniczająca, które pola każdej osoby są zwracane. Można określić wiele pól, rozdzielając je przecinkami. Jeśli maska odczytu pozostanie pusta, po mutacji po pobraniu nie zostaną zwrócone żadne dane, a odpowiedź nie zwróci żadnych danych. Prawidłowe wartości to:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • języki
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • nazwy
  • pseudonimy
  • zawody
  • organizacje
  • phoneNumbers
  • zdjęcia
  • relacje
  • sipAddresses
  • umiejętności
  • adresy
  • userDefined
sources[]

enum (ReadSourceType)

Opcjonalnie: Maska typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślna wartość to READ_SOURCE_TYPE_CONTACT i READ_SOURCE_TYPE_PROFILE.

Treść odpowiedzi

W przypadku niepowodzenia zwraca BatchUpdateContactsErrorDetails, listę błędów odpowiadających poszczególnym kontaktom.

Odpowiedź na żądanie aktualizacji grupy kontaktów.

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

Zapis JSON 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Pola
updateResult

map (key: string, value: object (PersonResponse))

Mapa nazw zasobów na zaktualizowane kontakty, chyba że żądanie readMask jest puste.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.