Method: users.list

यह उन उपयोगकर्ताओं की सूची बनाता है जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है. अगर दो उपयोगकर्ताओं के पास एक ही पार्टनर या विज्ञापन देने वाले व्यक्ति या कंपनी के लिए उपयोगकर्ता की भूमिकाएं हैं, तो वे एक-दूसरे के खाते को ऐक्सेस कर सकते हैं.

इस तरीके से पुष्टि करने के लिए, कुछ खास ज़रूरी शर्तें पूरी करनी होती हैं. इस तरीके का इस्तेमाल करने से पहले, उपयोगकर्ताओं को मैनेज करने से जुड़ी गाइड में दी गई ज़रूरी शर्तें पढ़ें.

"इस तरीके को आज़माएं" सुविधा, इस तरीके के लिए काम नहीं करती.

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

GET https://displayvideo.googleapis.com/v3/users

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

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

पैरामीटर
pageSize

integer

अनुरोध किया गया पेज साइज़. 1 और 200 के बीच होना चाहिए. अगर इसे तय नहीं किया गया है, तो डिफ़ॉल्ट रूप से 100 लागू हो जाएगा.
pageToken

string

यह एक टोकन है. इससे नतीजों के उस पेज की पहचान होती है जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह nextPageToken की वह वैल्यू होती है जो users.list तरीके को पिछली बार कॉल करने पर मिली थी. अगर इसे तय नहीं किया जाता है, तो नतीजों का पहला पेज दिखेगा.
orderBy

string

वह फ़ील्ड जिसके हिसाब से सूची को क्रम से लगाना है. इन वैल्यू का इस्तेमाल किया जा सकता है:

  • displayName (डिफ़ॉल्ट)

डिफ़ॉल्ट रूप से, क्रम बढ़ते हुए क्रम में होता है. किसी फ़ील्ड के लिए घटते क्रम को तय करने के लिए, फ़ील्ड के नाम में "desc" प्रत्यय जोड़ना चाहिए. उदाहरण के लिए, displayName desc.
filter

string

यह कुकी, उपयोगकर्ता के फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देती है.

इस्तेमाल किया जा सकने वाला सिंटैक्स:

  • फ़िल्टर एक्सप्रेशन, एक या उससे ज़्यादा पाबंदियों से मिलकर बने होते हैं.
  • पाबंदियों को लॉजिकल ऑपरेटर AND के साथ जोड़ा जा सकता है.
  • पाबंदी {field} {operator} {value} के फ़ॉर्म में होती है.
  • displayName और email फ़ील्ड में, HAS (:) ऑपरेटर का इस्तेमाल किया जाना चाहिए.
  • lastLoginTime फ़ील्ड में, LESS THAN OR EQUAL TO (<=) या GREATER THAN OR EQUAL TO (>=) ऑपरेटर का इस्तेमाल किया जाना चाहिए.
  • अन्य सभी फ़ील्ड में EQUALS (=) ऑपरेटर का इस्तेमाल किया जाना चाहिए.

इन फ़ील्ड के लिए यह सुविधा उपलब्ध है:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: यह AssignedUserRole का सिंथेटिक फ़ील्ड है. इसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. इससे उस इकाई के टाइप की पहचान होती है जिसे उपयोगकर्ता की भूमिका असाइन की गई है. मान्य वैल्यू Partner और Advertiser हैं.
  • assignedUserRole.parentPartnerId: यह AssignedUserRole का सिंथेटिक फ़ील्ड है. इसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. इससे उस इकाई के पैरंट पार्टनर की पहचान होती है जिसे उपयोगकर्ता की भूमिका असाइन की गई है.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 फ़ॉर्मैट में इनपुट या YYYY-MM-DDTHH:MM:SSZ)

उदाहरण:

  • "foo" वाला displayName इस्तेमाल करने वाला उपयोगकर्ता: displayName:"foo"
  • "बार" वाला email रखने वाला उपयोगकर्ता: email:"bar"
  • स्टैंडर्ड यूज़र रोल वाले सभी उपयोगकर्ता: assignedUserRole.userRole="STANDARD"
  • पार्टनर 123 के लिए, उपयोगकर्ता की भूमिकाएं रखने वाले सभी उपयोगकर्ता: assignedUserRole.partnerId="123"
  • विज्ञापन देने वाले व्यक्ति या कंपनी 123 के लिए, उपयोगकर्ता भूमिकाएं रखने वाले सभी उपयोगकर्ता: assignedUserRole.advertiserId="123"
  • पार्टनर लेवल की उपयोगकर्ता भूमिकाओं वाले सभी उपयोगकर्ता: entityType="PARTNER"
  • पार्टनर 123 और पार्टनर 123 के विज्ञापन देने वाले लोगों या कंपनियों के लिए, उपयोगकर्ता भूमिकाएं रखने वाले सभी लोग: parentPartnerId="123"
  • ऐसे सभी उपयोगकर्ता जिन्होंने 2023-01-01T00:00:00Z (आईएसओ 8601 फ़ॉर्मैट) को या इसके बाद आखिरी बार लॉग इन किया था: lastLoginTime>="2023-01-01T00:00:00Z"

इस फ़ील्ड में 500 से ज़्यादा वर्ण नहीं होने चाहिए.

ज़्यादा जानकारी के लिए, फ़िल्टर LIST करने के अनुरोध से जुड़ी हमारी गाइड देखें.

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

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

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

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

JSON के काेड में दिखाना 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
users[]

object (User)

उपयोगकर्ताओं की सूची.

अगर यह सूची खाली होगी, तो यह मौजूद नहीं होगी.
nextPageToken

string

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

अनुमति के स्कोप

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/display-video-user-management

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.