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
  • रुचियां
  • स्थान-भाषाएं
  • जगहें
  • की पैसे चुकाकर ली जाने वाली सदस्यताएं
  • मेटाडेटा
  • miscKeywords
  • नाम
  • निकनेम
  • पेशे
  • संगठन
  • phoneNumbers
  • फ़ोटोज
  • संबंध
  • sipAddresses
  • कौशल
  • यूआरएल
  • userDefined
sources[]

enum (ReadSourceType)

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

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "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 का इस्तेमाल करें) पेजेशन के बिना, सूची में मौजूद लोगों की कुल संख्या.
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 लोगों को उपनाम के हिसाब से क्रम में लगाएं.