Method: people.batchUpdateContacts

Zaktualizuj grupę kontaktów i zwróć mapę nazw zasobów do PersonResponses w przypadku zaktualizowanych kontaktów.

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

Żą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))

To pole jest wymagane. Mapa nazw zasobów na dane osoby do zaktualizowania. Pozwala na wysłanie do 200 kontaktów w jednym żądaniu.

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

string (FieldMask format)

To pole jest wymagane. Maska pola określająca, które pola na osobie mają być aktualizowane. Można określić wiele pól, rozdzielając je przecinkami. Wszystkie określone pola zostaną zastąpione lub wyczyszczone, jeśli pozostaną puste w przypadku każdej osoby. Prawidłowe wartości to:

  • adresy
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • locales
  • lokalizacje
  • kanału
  • miscKeywords
  • names
  • pseudonimy
  • zawody
  • organizations
  • phoneNumbers
  • relacje
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

To pole jest wymagane. Maska pola określająca, które pola każdej osoby mają być zwracane. Można określić wiele pól, rozdzielając je przecinkami. Jeśli maska odczytu jest pusta, metoda post-mutate-get jest pomijana i w odpowiedzi nie są zwracane żadne dane. Prawidłowe wartości to:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • locales
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • names
  • pseudonimy
  • zawody
  • organizations
  • phoneNumbers
  • fotografie
  • relacje
  • sipAddresses
  • umiejętności
  • urls
  • 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

Jeśli operacja się nie powiodła, funkcja zwraca BatchUpdateContactsErrorDetails, czyli 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 po autoryzacji.