Method: contactGroups.update

نام گروه تماس موجود متعلق به کاربر احراز هویت شده را به روز کنید.

نام گروه های مخاطب به روز شده باید منحصر به گروه های مخاطبین کاربران باشد. تلاش برای ایجاد یک گروه با نام تکراری، خطای HTTP 409 را برمی‌گرداند.

درخواست های جهش برای همان کاربر باید به صورت متوالی ارسال شوند تا از افزایش تاخیر و خرابی جلوگیری شود.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
contactGroup.resourceName

string

نام منبع برای گروه تماس، اختصاص داده شده توسط سرور. یک رشته ASCII، به شکل contactGroups/{contactGroupId} .

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "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
}
فیلدها
contactGroup.etag

string

تگ موجودیت HTTP منبع. برای اعتبار سنجی وب کش استفاده می شود.

contactGroup.metadata

object ( ContactGroupMetadata )

فقط خروجی فراداده درباره گروه تماس

contactGroup.groupType

enum ( GroupType )

فقط خروجی نوع گروه تماس

contactGroup.name

string

نام گروه مخاطب که توسط مالک گروه تنظیم شده است یا نامی که سیستم برای گروه های سیستم ارائه کرده است.

برای contactGroups.create یا contactGroups.update نام باید منحصر به گروه مخاطبین کاربر باشد. تلاش برای ایجاد یک گروه با نام تکراری، خطای HTTP 409 را برمی‌گرداند.

contactGroup.formattedName

string

فقط خروجی نام ترجمه و قالب‌بندی شده در محلی حساب بیننده یا Accept-Language هدر HTTP برای نام‌های گروه‌های سیستم. نام‌های گروهی که توسط مالک تعیین می‌شوند، همان نام هستند.

contactGroup.memberResourceNames[]

string

فقط خروجی فهرست نام منابع افراد مخاطب که اعضای گروه تماس هستند. این فیلد فقط برای درخواست‌های GET پر شده است و فقط به تعداد maxMembers در درخواست دریافت، اعضا را برمی‌گرداند.

contactGroup.memberCount

integer

فقط خروجی تعداد کل مخاطبین گروه بدون توجه به حداکثر اعضای مشخص شده در درخواست.

contactGroup.clientData[]

object ( GroupClientData )

داده های مشتری گروه

updateGroupFields

string ( FieldMask format)

اختیاری. یک فیلد ماسک برای محدود کردن اینکه کدام فیلدها در گروه به‌روزرسانی می‌شوند. چندین فیلد را می توان با جدا کردن آنها با کاما مشخص کرد. پیش‌فرض name در صورت تنظیم نشدن یا خالی بودن تنظیم شده است. فیلدهای به روز شده جایگزین می شوند. مقادیر معتبر عبارتند از:

  • کلاینت دیتا
  • نام
readGroupFields

string ( FieldMask format)

اختیاری. یک فیلد ماسک برای محدود کردن اینکه کدام فیلدها در گروه بازگردانده شوند. پیش‌فرض metadata ، groupType ، و name اگر تنظیم نشده باشد یا خالی باشد. فیلدهای معتبر عبارتند از:

  • کلاینت دیتا
  • نوع گروه
  • تعداد اعضا
  • فراداده
  • نام

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از ContactGroup است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.