Method: people.connections.list

पुष्टि किए गए उपयोगकर्ता के संपर्कों की सूची देता है.

सिंक होने के सात दिन बाद, सिंक टोकन की समयसीमा खत्म हो जाती है. जिस सिंक टोकन की समयसीमा खत्म हो चुकी है उसे अनुरोध करने पर google.rpc.ErrorInfo में गड़बड़ी मिलेगी. साथ ही, इसकी वजह "EXPIRED_SYNC_TOKEN" होगी. ऐसी स्थिति में, क्लाइंट को syncToken के बिना, सिंक करने का पूरा अनुरोध करना चाहिए.

सिंक करने के पूरे अनुरोध के पहले पेज का कोटा अतिरिक्त होता है. अगर कोटा ज़्यादा हो जाता है, तो 429 वाली गड़बड़ी दिखेगी. यह कोटा तय है और इसे बढ़ाया नहीं जा सकता.

syncToken के बारे में बताने पर, पिछले सिंक के बाद से मिटाए गए संसाधन, उस व्यक्ति के तौर पर दिखाए जाएंगे जिसका PersonMetadata.deleted 'सही' पर सेट है.

pageToken या syncToken के बारे में बताने पर, दूसरे सभी अनुरोध पैरामीटर, पहली कॉल से मेल खाने चाहिए.

सिंक के अनुरोधों को लागू होने में कुछ मिनट लग सकते हैं. इंक्रीमेंटल सिंक, 'लिखने के बाद पढ़ने' वाले इस्तेमाल के उदाहरणों के लिए नहीं बनाए गए हैं.

बदलाव किए गए उपयोगकर्ताओं के संपर्कों की सूची बनाएं पर जाकर, इस्तेमाल के उदाहरण देखें.

एचटीटीपी अनुरोध

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
resourceName
(deprecated)

string

ज़रूरी है. कनेक्शन देने के लिए संसाधन का नाम. सिर्फ़ people/me मान्य है.

क्वेरी पैरामीटर

पैरामीटर
pageToken

string

ज़रूरी नहीं. पिछले जवाब nextPageToken से मिला पेज टोकन. बाद वाला पेज फिर से पाने के लिए यह विकल्प दें.

पेजों को क्रम में लगाते समय, people.connections.list को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले पहले कॉल से मेल खाने चाहिए.
pageSize

integer

ज़रूरी नहीं. जवाब में शामिल किए जाने वाले कनेक्शन की संख्या. मान्य वैल्यू 1 से 1, 000 के बीच की होनी चाहिए. इसमें दोनों शामिल हैं. अगर यह वैल्यू सेट नहीं है या 0 पर सेट है, तो डिफ़ॉल्ट वैल्यू 100 होती है.
sortOrder

enum (SortOrder)

ज़रूरी नहीं. वह क्रम जिसमें कनेक्शन क्रम से लगाए जाने चाहिए. डिफ़ॉल्ट वैल्यू LAST_MODIFIED_ASCENDING होती है.
requestSyncToken

boolean

ज़रूरी नहीं. नतीजों के आखिरी पेज पर, जवाब के तौर पर nextSyncToken दिखना चाहिए या नहीं. इसका इस्तेमाल पिछले अनुरोध के बाद, बढ़ोतरी के हिसाब से किए जाने वाले बदलावों को पाने के लिए किया जा सकता है. इसके लिए, इसे syncToken अनुरोध पर सेट करें.

सिंक के व्यवहार के बारे में ज़्यादा जानकारी people.connections.list पर उपलब्ध है.
syncToken

string

ज़रूरी नहीं. पिछले जवाब से मिला सिंक टोकन nextSyncToken सिर्फ़ पिछले अनुरोध के बाद बदले गए संसाधनों को वापस पाने के लिए इसे उपलब्ध कराएं.

सिंक करते समय, people.connections.list को दिए गए अन्य सभी पैरामीटर, सिंक टोकन देने वाले पहले कॉल से मेल खाने चाहिए.

सिंक के व्यवहार के बारे में ज़्यादा जानकारी people.connections.list पर उपलब्ध है.
requestMask
(deprecated)

object (RequestMask)

ज़रूरी नहीं. रोक दी गई (कृपया इसके बजाय personFields का इस्तेमाल करें)

व्यक्ति फ़ील्ड के सबसेट के नतीजों को सीमित करने के लिए मास्क.
personFields

string (FieldMask format)

ज़रूरी है. फ़ील्ड मास्क, ताकि यह तय किया जा सके कि हर व्यक्ति को किन फ़ील्ड को लौटाया जा सकता है. एक से ज़्यादा फ़ील्ड को कॉमा लगाकर अलग करके, उन्हें तय किया जा सकता है. मान्य मान हैं:

  • पते
  • ageRanges
  • जीवनियां
  • जन्मदिन
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • इवेंट
  • externalIds
  • लिंग
  • imClients
  • दिलचस्पियां
  • locales
  • जगहें
  • की पैसे चुकाकर ली जाने वाली सदस्यताएं
  • मेटाडेटा
  • miscKeywords
  • names
  • प्रचलित नाम
  • व्यवसाय
  • organizations
  • phoneNumbers
  • फ़ोटोज
  • संबंध
  • sipAddresses
  • कौशल
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

ज़रूरी नहीं. इस बात का मास्क कि किस तरह के सोर्स को दिखाया जाए. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट वैल्यू READ_SOURCE_TYPE_CONTACT और READ_SOURCE_TYPE_PROFILE होती है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

पुष्टि किए गए उपयोगकर्ता के कनेक्शन के अनुरोध का जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
फ़ील्ड
connections[]

object (Person)

उन लोगों की सूची जिनसे अनुरोध करने वाला व्यक्ति जुड़ा है.
nextPageToken

string

एक टोकन, जिसे अगला पेज वापस पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होगा.
nextSyncToken

string

ऐसा टोकन जिसे पिछले अनुरोध के बाद किए गए बदलावों को वापस पाने के लिए, syncToken के तौर पर भेजा जा सकता है. सिंक टोकन वापस करने के लिए, अनुरोध को requestSyncToken को सेट करना होगा. जवाब को पेजों में बांटने पर, सिर्फ़ आखिरी पेज में nextSyncToken दिखेगा.
totalPeople
(deprecated)

integer

रोक दी गई (कृपया कुल आइटम का इस्तेमाल करें) सूची में बिना पेज नंबर वाले लोगों की कुल संख्या.
totalItems

integer

पेज पर नंबर न डाले बिना, सूची में मौजूद आइटम की कुल संख्या.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

SortOrder

वह क्रम जिसमें कनेक्शन की सूची क्रम से लगाई जानी चाहिए. इसका इस्तेमाल सिर्फ़ तब किया जाता है, जब सिंक करने का अनुरोध नहीं किया गया हो.

Enums
LAST_MODIFIED_ASCENDING लोगों को उनके बदलने के समय के अनुसार क्रमबद्ध करें; पुरानी एंट्री पहले.
LAST_MODIFIED_DESCENDING लोगों को उनके बदलने के समय के अनुसार क्रम से लगाएं; नई एंट्री पहले.
FIRST_NAME_ASCENDING लोगों को उनके नाम के मुताबिक क्रम से लगाएं.
LAST_NAME_ASCENDING लोगों को उपनाम के मुताबिक क्रम से लगाएं.