नमस्ते Analytics API: सेवा खातों के लिए, Python क्विकस्टार्ट

यह ट्यूटोरियल, Google Analytics खाते को ऐक्सेस करने, Analytics एपीआई से जुड़ी क्वेरी करने, एपीआई के जवाबों को मैनेज करने, और नतीजों का आउटपुट देने के लिए ज़रूरी तरीके बताता है. इस ट्यूटोरियल में, मुख्य रिपोर्टिंग एपीआई v3.0, मैनेजमेंट एपीआई v3.0, और OAuth2.0 का इस्तेमाल किया जाता है.

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

पहला कदम: Analytics API चालू करना

Google Analytics API का इस्तेमाल शुरू करने से पहले, सेट अप टूल इस्तेमाल करना ज़रूरी है. इससे आपको Google API (एपीआई) कंसोल में प्रोजेक्ट बनाने, एपीआई की सुविधा चालू करने, और क्रेडेंशियल बनाने की जानकारी मिलती है.

क्लाइंट आईडी बनाएं

1. सेवा खाते का पेज खोलें. पूछे जाने पर, प्रोजेक्ट चुनें.
2. सेवा खाता बनाएं पर क्लिक करें, सेवा खाते का नाम और जानकारी डालें. आप डिफ़ॉल्ट सेवा खाता आईडी इस्तेमाल करें या फिर कोई दूसरा, अलग खाता आईडी चुनें. काम पूरा हो जाने पर, बनाएं पर क्लिक करें.
3. इसके बाद आने वाले सेवा खाते की अनुमतियां (ज़रूरी नहीं) सेक्शन की ज़रूरत नहीं है. जारी रखें पर क्लिक करें.
4. उपयोगकर्ताओं को इस खाते का ऐक्सेस दें स्क्रीन पर, नीचे कुंजी बनाएं सेक्शन तक स्क्रोल करें. कुंजी बनाएं पर क्लिक करें.
5. इसके बाद, जो साइड पैनल दिखेगा उसमें अपनी कुंजी का फ़ॉर्मैट चुनें: JSON का सुझाव दिया जाता है.
6. बनाएं पर क्लिक करें. आपकी नई सार्वजनिक/निजी कुंजी की जोड़ी जनरेट करके आपकी मशीन पर डाउनलोड की जाती है. यह इस कुंजी की अकेली कॉपी की तरह काम करती है. इसे सुरक्षित तौर पर कैसे सेव किया जाए, इसकी जानकारी के लिए, सेवा खाता कुंजियां मैनेज करें देखें.
7. आपके कंप्यूटर पर सेव की गई निजी कुंजी डायलॉग पर, बंद करें पर क्लिक करें. इसके बाद, अपने सेवा खातों की टेबल पर वापस लौटने के लिए, हो गया पर क्लिक करें.

कुंजी के टाइप के लिए पूछे जाने पर, JSON चुनें और जनरेट की गई कुंजी को client_secrets.json के तौर पर सेव करें. आपको ट्यूटोरियल में इसकी ज़रूरत बाद में पड़ेगी.

Google Analytics खाते में सेवा खाता जोड़ें

नए बनाए गए सेवा खाते में एक ईमेल पता होगा, <projectId>-<uniqueId>@developer.gserviceaccount.com; इस ईमेल पते का इस्तेमाल उपयोगकर्ता को Google के उस Analytics खाते में जोड़ने के लिए करें जिसे एपीआई से ऐक्सेस करना है. सिर्फ़ इस ट्यूटोरियल के लिए, पढ़ें और विश्लेषण करें देखें.

चरण 2: Google क्लाइंट लाइब्रेरी इंस्टॉल करना

पैकेज मैनेजर का इस्तेमाल करें या Python क्लाइंट लाइब्रेरी को मैन्युअल तरीके से डाउनलोड और इंस्टॉल करें:

पीआईपी

Python पैकेज इंस्टॉल करने के लिए, सुझाए गए पीआईपी टूल का इस्तेमाल करें:

sudo pip install --upgrade google-api-python-client

सेट अप टूल

Setuptools पैकेज में शामिल easy_ install टूल का इस्तेमाल करें:

sudo easy_install --upgrade google-api-python-client

मैन्युअल तरीके से इंस्टॉल करना

Python लाइब्रेरी का नया क्लाइंट लाइब्रेरी डाउनलोड करें और कोड को अनपैक करें और चलाएं:

sudo python setup.py install

सिस्टम Python इंस्टॉल करने के लिए, आपको सुपर उपयोगकर्ता (sudo) के खास अधिकार के साथ निर्देश का इस्तेमाल करना पड़ सकता है.

तीसरा चरण: सैंपल सेट अप करना

आपको HelloAnalytics.py नाम की एक फ़ाइल बनानी होगी. इसमें, दिया गया सैंपल कोड शामिल होगा.

1. नीचे दिए गए सोर्स कोड को HelloAnalytics.py पर कॉपी करें या डाउनलोड करें.
2. पहले से डाउनलोड किए गए client_secrets.json को सैंपल कोड वाली डायरेक्ट्री में ले जाएं.
3. key_file_location के मानों को डेवलपर कंसोल के उचित मानों से बदलें.

"""A simple example of how to access the Google Analytics API."""

from apiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials


def get_service(api_name, api_version, scopes, key_file_location):
    """Get a service that communicates to a Google API.

    Args:
        api_name: The name of the api to connect to.
        api_version: The api version to connect to.
        scopes: A list auth scopes to authorize for the application.
        key_file_location: The path to a valid service account JSON key file.

    Returns:
        A service that is connected to the specified API.
    """

    credentials = ServiceAccountCredentials.from_json_keyfile_name(
            key_file_location, scopes=scopes)

    # Build the service object.
    service = build(api_name, api_version, credentials=credentials)

    return service


def get_first_profile_id(service):
    # Use the Analytics service object to get the first profile id.

    # Get a list of all Google Analytics accounts for this user
    accounts = service.management().accounts().list().execute()

    if accounts.get('items'):
        # Get the first Google Analytics account.
        account = accounts.get('items')[0].get('id')

        # Get a list of all the properties for the first account.
        properties = service.management().webproperties().list(
                accountId=account).execute()

        if properties.get('items'):
            # Get the first property id.
            property = properties.get('items')[0].get('id')

            # Get a list of all views (profiles) for the first property.
            profiles = service.management().profiles().list(
                    accountId=account,
                    webPropertyId=property).execute()

            if profiles.get('items'):
                # return the first view (profile) id.
                return profiles.get('items')[0].get('id')

    return None


def get_results(service, profile_id):
    # Use the Analytics Service Object to query the Core Reporting API
    # for the number of sessions within the past seven days.
    return service.data().ga().get(
            ids='ga:' + profile_id,
            start_date='7daysAgo',
            end_date='today',
            metrics='ga:sessions').execute()


def print_results(results):
    # Print data nicely for the user.
    if results:
        print 'View (Profile):', results.get('profileInfo').get('profileName')
        print 'Total Sessions:', results.get('rows')[0][0]

    else:
        print 'No results found'


def main():
    # Define the auth scopes to request.
    scope = 'https://www.googleapis.com/auth/analytics.readonly'
    key_file_location = '<REPLACE_WITH_JSON_FILE>'

    # Authenticate and construct service.
    service = get_service(
            api_name='analytics',
            api_version='v3',
            scopes=[scope],
            key_file_location=key_file_location)

    profile_id = get_first_profile_id(service)
    print_results(get_results(service, profile_id))


if __name__ == '__main__':
    main()

चौथा चरण: सैंपल चलाना

Analytics API चालू करने के बाद, Python के लिए Google API क्लाइंट लाइब्रेरी इंस्टॉल करें. साथ ही, सैंपल सोर्स कोड सेट अप करें, ताकि सैंपल चलाया जा सके.

इसका इस्तेमाल करके नमूना चलाएं:

python HelloAnalytics.py

इन चरणों को पूरा करने के बाद, नमूने के तौर पर उपयोगकर्ता का नाम, Google Analytics के पहले व्यू (प्रोफ़ाइल) का नाम, और पिछले सात दिनों के सेशन की संख्या का पता चलता है.

ध्यान दें: यह सैंपल दिखाने के लिए, आपके पास कम से कम एक Google Analytics प्रॉपर्टी और व्यू (प्रोफ़ाइल) होनी चाहिए.

अब अनुमति वाले Analytics सेवा ऑब्जेक्ट से, मैनेज करने वाले एपीआई के संदर्भ वाले दस्तावेज़ में मिलने वाले किसी भी कोड सैंपल को चलाया जा सकता है. उदाहरण के लिए, आप कोड को बदलकर, accountSummeries.list तरीके का इस्तेमाल कर सकते हैं.

समस्याएं हल करना

एट्रिब्यूट की गड़बड़ी: 'module_six_moves_urllib_parse' ऑब्जेक्ट में कोई विशेषता नहीं है और#39;urlparse'

यह गड़बड़ी Mac OSX में हो सकती है, जहां &tot;six" मॉड्यूल (इस लाइब्रेरी की डिपेंडेंसी) का डिफ़ॉल्ट इंस्टॉलेशन, पीआईपी इंस्टॉल करने से पहले लोड होता है. इस समस्या को ठीक करने के लिए, PYTHONPATH सिस्टम एनवायरमेंट वैरिएबल में पीआईपी's के इंस्टॉल की जगह जोड़ें:

1. इस निर्देश की मदद से, पीआईपी की इंस्टॉल की जगह तय करें:

   pip show six | grep "Location:" | cut -d " " -f2
   

2. ऊपर दी गई वैल्यू के साथ <pip_install_path> को बदलकर, अपनी ~/.bashrc फ़ाइल में यह लाइन जोड़ें:

   export PYTHONPATH=$PYTHONPATH:<pip_install_path>
   

3. नीचे दिए गए निर्देश का इस्तेमाल करके, किसी भी खुली टर्मिनल विंडो में अपनी ~/.bashrc फ़ाइल को फिर से लोड करें:

   source ~/.bashrc