Method: users.list

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

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

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

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

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

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

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

string

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

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

  • फ़िल्टर एक्सप्रेशन में एक या ज़्यादा पाबंदियां होती हैं.
  • लॉजिकल ऑपरेटर AND की मदद से, पाबंदियों को जोड़ा जा सकता है.
  • पाबंदी {field} {operator} {value} के रूप में होती है.
  • budget.budget_segments.date_range.end_date फ़ील्ड को LESS THAN (<) ऑपरेटर का इस्तेमाल करना चाहिए.
  • displayName andईमेलfield must use theHAS (:)` ऑपरेटर.
  • अन्य सभी फ़ील्ड में EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType
  • यह AssignedUserRole का सिंथेटिक फ़ील्ड है. इसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. यह बताता है कि किस तरह की इकाई को उपयोगकर्ता की भूमिका असाइन की गई है. मान्य वैल्यू Partner और Advertiser हैं.
  • assignedUserRole.parentPartnerId
  • यह AssignedUserRole का सिंथेटिक फ़ील्ड है. इसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. इकाई के उस पैरंट पार्टनर की पहचान करता है जिसे उपयोगकर्ता की भूमिका असाइन की गई है.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email

उदाहरण:

  • 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"

इस फ़ील्ड में 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 की खास जानकारी देखें.