Method: users.list

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

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

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

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

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

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. किसी फ़ील्ड के घटते क्रम में तय करने के लिए फ़ील्ड के नाम में "ब्यौरा" सफ़िक्स जोड़ना चाहिए. उदाहरण के लिए, 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 में इनपुट)

उदाहरण:

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

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 की खास जानकारी देखें.