Method: users.list

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

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

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

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

GET https://displayvideo.googleapis.com/v5/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 (आईएसओ 8601 फ़ॉर्मैट या YYYY-MM-DDTHH:MM:SSZ में इनपुट)

उदाहरण:

  • "foo" वाले displayName का उपयोगकर्ता: displayName:"foo"
  • email में "bar" शामिल करने वाला उपयोगकर्ता: 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 देखें.