Google Analytics मैनेजमेंट एपीआई, उपयोगकर्ता की अनुमतियों का प्रोग्रामैटिक मैनेजमेंट करने की अनुमति देता है. यह खास तौर पर उन बड़ी कंपनियों के लिए मददगार है जो अपनी ऐक्सेस कंट्रोल लिस्ट (एसीएल) के लिए बार-बार अपडेट करती हैं.
इसके बारे में जानकारी
खाता, प्रॉपर्टी या व्यू (प्रोफ़ाइल) को ऐक्सेस करने के लिए, तीन मुख्य संसाधनों का इस्तेमाल किया जाता है:
उपयोगकर्ता की अनुमतियों में बदलाव करने से जुड़ी कार्रवाइयों के लिए, खास बैच की सुविधा भी उपलब्ध है.
उपयोगकर्ताओं की अनुमतियां
Google खाते से दिखाए गए उपयोगकर्ता को Google Analytics खाते, प्रॉपर्टी या व्यू (प्रोफ़ाइल) के ऐक्सेस के ये लेवल दिए जा सकते हैं:
MANAGE_USERS
- उपयोगकर्ता की अनुमति वाले एपीआई के लिए, लिखने का अनुरोध करने की ज़रूरत है.EDIT
- डेटा प्रबंधन संसाधनों में बदलाव करने की ज़रूरत है.COLLABORATE
READ_AND_ANALYZE
ऐक्सेस के हर लेवल के बारे में ज़्यादा जानकारी के लिए, उपयोगकर्ता की अनुमतियां सहायता केंद्र का लेख देखें.
अनुमतियां असाइन करना
एपीआई दो तरह की अनुमतियां दिखाता है: local
और effective
. दिए गए खाते, प्रॉपर्टी या व्यू (प्रोफ़ाइल) पर स्थानीय अनुमतियां लागू होती हैं. एपीआई को अनुमतियां देते समय, आपको permissions.local
प्रॉपर्टी का इस्तेमाल करना चाहिए. Effective
अनुमतियां ऐसी अनुमतियां दिखाती हैं जो पैरंट रिसॉर्स से इनहेरिट की जाती हैं.
अपने-आप मिलने वाली अनुमतियां
अगर किसी उपयोगकर्ता को किसी खाते की EDIT
अनुमति दी जाती है, तो उस खाते के तहत आने वाली सभी प्रोफ़ाइल और प्रॉपर्टी, इन अनुमतियों को इनहेरिट कर लेंगी; इसे permissions.effective प्रॉपर्टी से दिखाया जाएगा.
उपयोग के उदाहरण
मैनेजमेंट एपीआई में उपयोगकर्ता की अनुमतियों का इस्तेमाल, इन मामलों को हल करने के लिए किया जा सकता है:
- किसी खाते के सभी उपयोगकर्ताओं की सूची बनाना
- बड़ी संख्या में उपयोगकर्ताओं को अपडेट करना
- खाते की हैरारकी से किसी उपयोगकर्ता को मिटाना
- किसी एक उपयोगकर्ता को अपडेट करना
- एक उपयोगकर्ता को जोड़ना
किसी खाते के सभी उपयोगकर्ताओं की सूची बनाएं
किसी खाते के सभी उपयोगकर्ताओं को सूची में शामिल करने के लिए, खाते के किसी भी प्रॉपर्टी या व्यू (प्रोफ़ाइल) को अनुमति देने वाले सभी उपयोगकर्ताओं को शामिल करके, accountUserLinks संसाधन के list
तरीके का इस्तेमाल करें.
बहुत सारे उपयोगकर्ताओं को अपडेट करें
बहुत सारे उपयोगकर्ताओं के लिए अनुमतियों को अपडेट करने के लिए, हमारा सुझाव है कि आप बैच बनाने की सुविधा का इस्तेमाल करें. इससे न सिर्फ़ कोटा सेव होगा, बल्कि पहले से ज़्यादा बेहतर परफ़ॉर्म भी होगा -- पूरी जानकारी के लिए, नीचे बैचिंग सेक्शन देखें. किसी खाते में ऐसा करने के लिए, यह तरीका अपनाएं:
- खाते के लिए सभी उपयोगकर्ता लिंक पाएं:
list
सभीaccountUserLinks
.
- हर उपयोगकर्ता के लिए, ज़रूरी अनुमतियां होने पर अपडेट का अनुरोध करना:
- हर
accountUserLink
के बाद,update
.
- हर
- ऊपर बताए गए अपडेट के अनुरोधों वाले हर 300 उपयोगकर्ताओं के लिए, एक बैच का अनुरोध करें:
- हर 300 उपयोगकर्ताओं के लिए,
batch
पर कॉल करें.
- हर 300 उपयोगकर्ताओं के लिए,
खाते की हैरारकी से किसी उपयोगकर्ता को मिटाना
खाता हैरारकी (यानी खाता, प्रॉपर्टी, और व्यू (प्रोफ़ाइलें) से उपयोगकर्ता की सभी गतिविधियां हटाने के लिए). ऐसा करने के लिए, यह तरीका अपनाएं:
- हर इकाई लेवल के लिए, सभी उपयोगकर्ता लिंक पाएं. इस खाते के लिए
list
के तीन अनुरोध पूरे करें: - स्थानीय अनुमतियों वाले उपयोगकर्ताओं को ढूंढें और मिटाएं. पहले चरण में तीन सूचियों की कार्रवाइयों से मिले हर जवाब के लिए, हर
entityUserLink
में जवाब दें:- अगर
userRef
प्रॉपर्टी उपयोगकर्ता से मेल खाती हैं, और अगरlocal
अनुमतियां सेट की गई हैं, तो संसाधन परdelete
का इस्तेमाल करें
- अगर
खाते के उपयोगकर्ता लिंक, वेब प्रॉपर्टी उपयोगकर्ता लिंक, और व्यू (प्रोफ़ाइल) उपयोगकर्ता लिंक संसाधनों के delete
तरीके के बारे में ज़्यादा जानने के लिए एपीआई का संदर्भ देखें.
किसी एक उपयोगकर्ता की जानकारी अपडेट करना
मैनेजमेंट एपीआई का इस्तेमाल करके, उपयोगकर्ता की अनुमतियों को भी अपडेट किया जा सकता है. उदाहरण के लिए, अगर आपको व्यू (प्रोफ़ाइल) का नाम या आईडी नहीं पता है, तो आप READ_AND_ANALYZE
की EDIT
से अनुमतियों के लेवल को READ_AND_ANALYZE
में बदल सकते हैं. इसके लिए, यह तरीका अपनाएं:
हर इकाई लेवल के लिए, सभी उपयोगकर्ता लिंक पाएं खाते के लिए, तीन
list
अनुरोध लागू करें:स्थानीय अनुमतियों वाले उपयोगकर्ताओं को खोजें और अपडेट करें. चरण #1 में, तीन लिस्ट ऑपरेशंस से मिले हर जवाब के लिए, हर
entityUserLink
में दोहराएं:- अगर
userRef
प्रॉपर्टी, उपयोगकर्ता और उपयोगकर्ता के पासREAD_AND_ANALYZE
ऐक्सेस के साथlocal
अनुमतियां हैं, तो मेल खाती हैं फिर संसाधन परupdate
लागू करें.
- अगर
खाते के उपयोगकर्ता लिंक, वेब प्रॉपर्टी उपयोगकर्ता लिंक, और व्यू (प्रोफ़ाइल) उपयोगकर्ता लिंक संसाधनों के update
तरीके के बारे में ज़्यादा जानने के लिए एपीआई का संदर्भ देखें.
एक उपयोगकर्ता जोड़ें
खाते की हैरारकी में किसी उपयोगकर्ता को जोड़ने के लिए, जैसे कि व्यू (प्रोफ़ाइल) में, ये चरण ज़रूरी हैं:
- खाता, प्रॉपर्टी, और व्यू (प्रोफ़ाइल) के आईडी वापस पाने के लिए, मैनेजमेंट एपीआई या वेब इंटरफ़ेस का इस्तेमाल करें.
profileUserLinks
रिसॉर्स काinsert
तरीका लागू करके उपयोगकर्ता को जोड़ें.
बैच बनाना
जब बैचिंग एपीआई लिखने (मिटाने, शामिल करने, अपडेट करने) के अनुरोध किए जाते हैं, तो परफ़ॉर्मेंस पर फ़ायदे और कोटा के तौर पर मिलने वाले फ़ायदे मिलते हैं.
- उपयोगकर्ता की अनुमति के बैच वाले अनुरोधों को, बैक-एंड ऑप्टिमाइज़ेशन का फ़ायदा मिल सकता है. साथ ही, परफ़ॉर्मेंस में काफ़ी बढ़ोतरी हो सकती है.
- हर 30 बैच के उपयोगकर्ता अनुमति एपीआई अनुरोधों को सिर्फ़ एक एक राइट कार्रवाई के रूप में गिना जाता है.
- एक बार में 300 से ज़्यादा उपयोगकर्ता अनुमतियों के एपीआई अनुरोध किए जा सकते हैं. इससे, हर उपयोगकर्ता के लिए तय सीमा वाले क्यूपीएस का अनुरोध किया जा सकता है.
परफ़ॉर्मेंस से जुड़े फ़ायदों का ज़्यादा से ज़्यादा फ़ायदा पाने के लिए, आपको कुछ चीज़ें करनी चाहिए.
- एपीआई अनुरोध को ग्रुप के हिसाब से ग्रुप में बांटें.
- सिर्फ़ एक खाते के लिए, एक साथ कई अनुरोध किए जा सकते हैं. एक से ज़्यादा Google Analytics खातों के साथ बैच में उपयोगकर्ता की अनुमतियों के अनुरोधों की वजह से यह मैसेज नहीं दिखेगा:
All batched requests must be under the same account
.
गड़बड़ी ठीक करना
बैच में अनुरोध पाने की सभी अनुमतियों को एक ही लेन-देन माना जाता है. इसका मतलब है कि अगर कोई भी बदलाव गलत है, तो कोई बदलाव नहीं होगा. हम उन्हें सिंगल कॉल क्यों मानते हैं:
- किसी एक उपयोगकर्ता की अनुमतियों को एडजस्ट करने के लिए कई बदलाव करने की ज़रूरत पड़ सकती है. अगर किसी एक बदलाव में गड़बड़ी है, तो बैच का हिस्सा बनने पर, उपयोगकर्ता की अनुमतियों को अनचाहे तरीके से ऐक्सेस किया जा सकता है.
- बदलावों को एक ही लेन-देन के तौर पर मानकर, हम ट्रैफ़िक को ऑप्टिमाइज़ करते हैं. साथ ही, कॉल का कोटा कम कर सकते हैं.
बैच बनाने का उदाहरण - Python
नीचे, Python में एक आसान उदाहरण दिया गया है. इसमें एक से ज़्यादा व्यू (प्रोफ़ाइलों) के उपयोगकर्ताओं की सूची जोड़ने के अनुरोध शामिल किए गए हैं. यह उदाहरण, अनुमति वाले उपयोगकर्ता के खातों के ज़रिए लूप में चलता है और हर खाते के लिए एक ही बैच अनुरोध बनाता है. यह हर बैच में, किसी उपयोगकर्ता के सभी बदलावों के ग्रुप का अनुरोध करता है.
"""A simple example of Google Analytics batched user permissions.""" import json from googleapiclient.errors import HttpError from googleapiclient.http import BatchHttpRequest def call_back(request_id, response, exception): """Handle batched request responses.""" print request_id if exception is not None: if isinstance(exception, HttpError): message = json.loads(exception.content)['error']['message'] print ('Request %s returned API error : %s : %s ' % (request_id, exception.resp.status, message)) else: print response def add_users(users, permissions): """Adds users to every view (profile) with the given permissions. Args: users: A list of user email addresses. permissions: A list of user permissions. Note: this code assumes you have MANAGE_USERS level permissions to each profile and an authorized Google Analytics service object. """ # Get the a full set of account summaries. account_summaries = analytics.management().accountSummaries().list().execute() # Loop through each account. for account in account_summaries.get('items', []): account_id = account.get('id') # Loop through each user. for user in users: # Create the BatchHttpRequest object. batch = BatchHttpRequest(callback=call_back) # Loop through each property. for property_summary in account.get('webProperties', []): property_id = property_summary.get('id') # Loop through each view (profile). for view in property_summary.get('profiles', []): view_id = view.get('id') # Construct the Profile User Link. link = analytics.management().profileUserLinks().insert( accountId=account_id, webPropertyId=property_id, profileId=view_id, body={ 'permissions': { 'local': permissions }, 'userRef': { 'email': user } } ) batch.add(link) # Execute the batch request for each user. batch.execute() if __name__ == '__main__': # Construct a list of users. emails = ['ona@gmail.com', 'emi@gmail.com', 'sue@gmail.com', 'liz@gmail.com'] # call the add_users function with the list of desired permissions. add_users(emails, ['READ_AND_ANALYZE'])
अगले चरण
इसके बाद, हम अलग-अलग डेटा रिसॉर्स को कॉन्फ़िगर करने के लिए, Google Analytics मैनेजमेंट एपीआई के इस्तेमाल का तरीका बताएंगे.