Method: contactGroups.update

Kimliği doğrulanmış kullanıcıya ait mevcut bir kişi grubunun adını güncelleyin.

Güncellenen kişi grubu adları, kullanıcının kişi gruplarına özgü olmalıdır. Yinelenen ada sahip bir grup oluşturma girişiminde HTTP 409 hatası döndürülür.

Gecikmenin ve hataların artmasını önlemek için aynı kullanıcıya yönelik değişiklik istekleri sırayla gönderilmelidir.

HTTP isteği

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
contactGroup.resourceName

string

Kişi grubu için sunucu tarafından atanan kaynak adı. contactGroups/{contactGroupId} biçiminde bir ASCII dizesi.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Alanlar
contactGroup.etag

string

Kaynağın HTTP varlık etiketi. Web önbelleği doğrulaması için kullanılır.

contactGroup.metadata

object (ContactGroupMetadata)

Yalnızca çıkış. Kişi grubuyla ilgili meta veriler.

contactGroup.groupType

enum (GroupType)

Yalnızca çıkış. Kişi grubunun türü.

contactGroup.name

string

Grup sahibi tarafından belirlenen kişi grubu adı veya sistem grupları için sistem tarafından sağlanan bir ad.

contactGroups.create veya contactGroups.update için ad, kullanıcının kişi gruplarına özgü olmalıdır. Yinelenen ada sahip bir grup oluşturma girişiminde HTTP 409 hatası döndürülür.

contactGroup.formattedName

string

Yalnızca çıkış. Görüntüleyen kullanıcının hesap yerel ayarında veya sistem grubu adları için Accept-Language HTTP üstbilgisi yerel ayarında çevrilen ve biçimlendirilen ad. Grup sahibi tarafından belirlenen grup adları, adla aynı.

contactGroup.memberResourceNames[]

string

Yalnızca çıkış. Kişi grubunun üyesi olan ilgili kişi kaynak adlarının listesi. Bu alan yalnızca GET istekleri için doldurulur ve yalnızca get isteğindeki maxMembers üye sayısına kadar döndürülür.

contactGroup.memberCount

integer

Yalnızca çıkış. İstekte belirtilen maksimum üye sayısından bağımsız olarak gruptaki toplam kişi sayısı.

contactGroup.clientData[]

object (GroupClientData)

Grubun istemci verileri.

updateGroupFields

string (FieldMask format)

İsteğe bağlı. Grupta hangi alanların güncelleneceğini kısıtlamak için kullanılan bir alan maskesi. Virgülle ayırarak birden çok alan belirtilebilir. Ayarlanmazsa veya boş olarak ayarlanırsa varsayılan olarak name değerine ayarlanır. Güncellenen alanlar değiştirilir. Geçerli değerler şunlardır:

  • clientData
  • ad
readGroupFields

string (FieldMask format)

İsteğe bağlı. Grupta hangi alanların döndürüleceğini kısıtlamak için kullanılan bir alan maskesi. Ayarlanmazsa veya boş olarak ayarlanırsa varsayılan olarak metadata, groupType ve name değerine ayarlanır. Geçerli alanlar şunlardır:

  • clientData
  • groupType
  • memberCount
  • meta veri
  • ad

Yanıt gövdesi

Başarılıysa yanıt metni, ContactGroup öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.