Method: people.batchCreateContacts

יצירת אצווה של אנשי קשר חדשים והחזרת PersonResponses עבור אנשי הקשר החדשים

בקשות לשינוי עבור אותו משתמש צריכות להישלח ברצף כדי למנוע זמן אחזור ארוך יותר וכשלים.

בקשת HTTP

POST https://people.googleapis.com/v1/people:batchCreateContacts

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

גוף הבקשה

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

ייצוג JSON
{
  "contacts": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
שדות
contacts[]

object (ContactToCreate)

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

readMask

string (FieldMask format)

חובה. אנונימיזציה של שדות כדי להגביל את השדות של כל אדם שיוחזרו בתגובה. אפשר לציין כמה שדות על ידי הפרדה בפסיקים. אם מסכת הקריאה נותרת ריקה, המערכת תדלג על ה-Post-mutate-get ולא יוחזרו נתונים בתגובה. הערכים החוקיים כוללים:

  • כתובות
  • ageRanges
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • locales
  • locations
  • מינויים
  • מטא נתונים
  • miscKeywords
  • names
  • כינויים
  • מקצועות
  • organizations
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • יחסים
  • sipAddresses
  • מיומנויות
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר בקריאת השינוי לאחר השינוי. אם המדיניות לא מוגדרת, ברירת המחדל היא READ_SOURCE_TYPE_CONTACT ו-READ_SOURCE_TYPE_PROFILE.

גוף התשובה

אם הפעולה לא בוצעה בהצלחה, מוחזר BatchCreateContactsErrorDetails שמכיל רשימת שגיאות לכל איש קשר לא חוקי.

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

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

ייצוג JSON
{
  "createdPeople": [
    {
      object (PersonResponse)
    }
  ]
}
שדות
createdPeople[]

object (PersonResponse)

אנשי הקשר שנוצרו, אלא אם הבקשה readMask ריקה.

היקפי הרשאות

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

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

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

ContactToCreate

wrapper שמכיל את נתוני המשתמש לאכלוס מקור חדש שנוצר.

ייצוג JSON
{
  "contactPerson": {
    object (Person)
  }
}
שדות
contactPerson

object (Person)

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