- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- SortOrder
- इसे आज़माएं!
पुष्टि किए गए उपयोगकर्ता के संपर्कों की सूची देता है.
सिंक होने के सात दिन बाद, सिंक टोकन की समयसीमा खत्म हो जाती है. जिस सिंक टोकन की समयसीमा खत्म हो चुकी है उसे अनुरोध करने पर google.rpc.ErrorInfo में गड़बड़ी मिलेगी. साथ ही, इसकी वजह "EXPIRED_SYNC_TOKEN" होगी. ऐसी स्थिति में, क्लाइंट को
के बिना, सिंक करने का पूरा अनुरोध करना चाहिए.syncToken
सिंक करने के पूरे अनुरोध के पहले पेज का कोटा अतिरिक्त होता है. अगर कोटा ज़्यादा हो जाता है, तो 429 वाली गड़बड़ी दिखेगी. यह कोटा तय है और इसे बढ़ाया नहीं जा सकता.
के बारे में बताने पर, पिछले सिंक के बाद से मिटाए गए संसाधन, उस व्यक्ति के तौर पर दिखाए जाएंगे जिसका syncToken
'सही' पर सेट है.PersonMetadata.deleted
या pageToken
के बारे में बताने पर, दूसरे सभी अनुरोध पैरामीटर, पहली कॉल से मेल खाने चाहिए.syncToken
सिंक के अनुरोधों को लागू होने में कुछ मिनट लग सकते हैं. इंक्रीमेंटल सिंक, 'लिखने के बाद पढ़ने' वाले इस्तेमाल के उदाहरणों के लिए नहीं बनाए गए हैं.
बदलाव किए गए उपयोगकर्ताओं के संपर्कों की सूची बनाएं पर जाकर, इस्तेमाल के उदाहरण देखें.
एचटीटीपी अनुरोध
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
resourceName |
ज़रूरी है. कनेक्शन देने के लिए संसाधन का नाम. सिर्फ़ |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
pageToken |
ज़रूरी नहीं. पिछले जवाब पेजों को क्रम में लगाते समय, |
pageSize |
ज़रूरी नहीं. जवाब में शामिल किए जाने वाले कनेक्शन की संख्या. मान्य वैल्यू 1 से 1, 000 के बीच की होनी चाहिए. इसमें दोनों शामिल हैं. अगर यह वैल्यू सेट नहीं है या 0 पर सेट है, तो डिफ़ॉल्ट वैल्यू 100 होती है. |
sortOrder |
ज़रूरी नहीं. वह क्रम जिसमें कनेक्शन क्रम से लगाए जाने चाहिए. डिफ़ॉल्ट वैल्यू |
requestSyncToken |
ज़रूरी नहीं. नतीजों के आखिरी पेज पर, जवाब के तौर पर सिंक के व्यवहार के बारे में ज़्यादा जानकारी |
syncToken |
ज़रूरी नहीं. पिछले जवाब से मिला सिंक टोकन सिंक करते समय, सिंक के व्यवहार के बारे में ज़्यादा जानकारी |
requestMask |
ज़रूरी नहीं. रोक दी गई (कृपया इसके बजाय व्यक्ति फ़ील्ड के सबसेट के नतीजों को सीमित करने के लिए मास्क. |
personFields |
ज़रूरी है. फ़ील्ड मास्क, ताकि यह तय किया जा सके कि हर व्यक्ति को किन फ़ील्ड को लौटाया जा सकता है. एक से ज़्यादा फ़ील्ड को कॉमा लगाकर अलग करके, उन्हें तय किया जा सकता है. मान्य मान हैं:
|
sources[] |
ज़रूरी नहीं. इस बात का मास्क कि किस तरह के सोर्स को दिखाया जाए. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट वैल्यू |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
पुष्टि किए गए उपयोगकर्ता के कनेक्शन के अनुरोध का जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"connections": [
{
object ( |
फ़ील्ड | |
---|---|
connections[] |
उन लोगों की सूची जिनसे अनुरोध करने वाला व्यक्ति जुड़ा है. |
nextPageToken |
एक टोकन, जिसे अगला पेज वापस पाने के लिए |
nextSyncToken |
ऐसा टोकन जिसे पिछले अनुरोध के बाद किए गए बदलावों को वापस पाने के लिए, |
totalPeople |
रोक दी गई (कृपया कुल आइटम का इस्तेमाल करें) सूची में बिना पेज नंबर वाले लोगों की कुल संख्या. |
totalItems |
पेज पर नंबर न डाले बिना, सूची में मौजूद आइटम की कुल संख्या. |
अनुमति के दायरे
इनमें से किसी एक 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 |
लोगों को उपनाम के मुताबिक क्रम से लगाएं. |