Method: contactGroups.members.modify

שינוי החברים בקבוצת אנשי קשר שבבעלות המשתמש המאומת.

הקבוצות היחידות של אנשי קשר במערכת שאפשר להוסיף להן חברים הן contactGroups/myContacts ו-contactGroups/starred. קבוצות אחרות של אנשי קשר של המערכת הוצאו משימוש וניתן להסיר רק אנשי קשר.

בקשת HTTP

POST https://people.googleapis.com/v1/{resourceName=contactGroups/*}/members:modify

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
resourceName

string

חובה. שם המשאב של קבוצת אנשי הקשר שרוצים לשנות.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "resourceNamesToAdd": [
    string
  ],
  "resourceNamesToRemove": [
    string
  ]
}
שדות
resourceNamesToAdd[]

string

זה שינוי אופציונלי. שמות המשאבים של אנשי הקשר להוספה בפורמט people/{person_id}. המספר הכולל של שמות המשאבים ב-resourceNamesToAdd וב-resourceNamesToRemove חייב להיות שווה ל-1,000 או קטן ממנו.
resourceNamesToRemove[]

string

זה שינוי אופציונלי. שמות המשאבים של אנשי הקשר שרוצים להסיר, שמופיעים בפורמט people/{person_id}. המספר הכולל של שמות המשאבים ב-resourceNamesToAdd וב-resourceNamesToRemove חייב להיות שווה ל-1,000 או קטן ממנו.

גוף התשובה

התגובה לבקשה לשינוי חברי הקבוצה ליצירת קשר.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "notFoundResourceNames": [
    string
  ],
  "canNotRemoveLastContactGroupResourceNames": [
    string
  ]
}
שדות
notFoundResourceNames[]

string

שמות המשאבים של אנשי הקשר שלא נמצאו.
canNotRemoveLastContactGroupResourceNames[]

string

שמות המשאבים של אנשי הקשר שאי אפשר להסיר מהקבוצה האחרונה של אנשי הקשר.

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

מידע נוסף זמין במדריך להרשאות.