Method: contactGroups.update

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

Güncellenen kişi grubu adları kullanıcıların kişi gruplarına özgü olmalıdır. Yinelenen adla bir grup oluşturulmaya çalışıldığında HTTP 409 hatası döndürülür.

Aynı kullanıcıya yönelik değişiklik istekleri, gecikme ve hata sayısında artış olmaması için 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

İsteğin gövdesi, aşağıdaki yapıya sahip veriler 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 grubu türü.

contactGroup.name

string

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

contactGroups.create veya contactGroups.update için ad, kullanıcıların kişi gruplarına özgü olmalıdır. Yinelenen adla bir grup oluşturulmaya çalışıldığında HTTP 409 hatası döndürülür.

contactGroup.formattedName

string

Yalnızca çıkış. Görüntüleyenin hesap yerel ayarında veya sistem grubu adları için Accept-Language HTTP üst bilgisi yerel ayarında çevrilmiş ve biçimlendirilmiş ad. Grup sahibi tarafından belirlenen grup adları ad ile aynıdır.

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ğinde maxMembers kadar üye döndürü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 güncellenecek alanları kısıtlayan bir alan maskesi. Virgülle ayırarak birden çok alan belirtilebilir. Ayarlanmazsa veya boş olarak ayarlanırsa varsayılan olarak name olur. Güncellenen alanlar değiştirildi. Valid values are:

  • clientData
  • ad
readGroupFields

string (FieldMask format)

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

  • clientData
  • groupType
  • memberCount
  • metadata
  • 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ılavuzu'na bakın.