Method: organizations.list

यह उन संगठनों की सूची दिखाता है जिन्हें उपयोगकर्ता ऐक्सेस कर सकता है.

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

GET https://marketingplatformadmin.googleapis.com/v1alpha/organizations

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

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

पैरामीटर
pageSize

integer

ज़रूरी नहीं. एक कॉल में ज़्यादा से ज़्यादा कितनी संस्थाओं की जानकारी दिखानी है. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए.

अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 50 संगठन दिखाए जाएंगे. ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है. 1,000 से ज़्यादा वैल्यू को 1,000 में बदल दिया जाएगा.

pageToken

string

ज़रूरी नहीं. यह पेज टोकन है, जो organizations.list को किए गए पिछले कॉल से मिला है. अगला पेज पाने के लिए, यह जानकारी दें.

पेज नंबर के हिसाब से डेटा दिखाने के दौरान, organizations.list को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मेल खाने चाहिए.

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

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

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

संगठनों की सूची बनाने के लिए, RPC का जवाब देने वाला मैसेज.

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

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

object (Organization)

संगठन की वह संसाधन इकाई जिसका ऐक्सेस उपयोगकर्ता के पास है. इसमें संगठन का आईडी और डिसप्ले नेम शामिल होता है.

nextPageToken

string

यह एक टोकन है. इसका इस्तेमाल अगले पेज को वापस पाने के लिए, pageToken के तौर पर किया जा सकता है. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update