Method: users.list

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

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

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

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

GET https://displayvideo.googleapis.com/v2/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)

उदाहरण:

  • displayName वाला उपयोगकर्ता जिसमें "foo" है: 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 पर या इसके बाद लॉग इन किया था (ISO 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 की खास जानकारी देखें.