Views (Profiles): list

अनुमति की ज़रूरत है

उन व्यू (प्रोफ़ाइलों) की सूची बनाता है जिनका ऐक्सेस उपयोगकर्ता के पास होता है. इसे अभी आज़माएं या उदाहरण देखें.

स्टैंडर्ड पैरामीटर के अलावा, यह तरीका पैरामीटर टेबल में दिए गए पैरामीटर के साथ काम करता है.

अनुरोध

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

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles

पैरामीटर

पैरामीटर का नाम वैल्यू ब्यौरा
पाथ पैरामीटर
accountId string फिर से पाने के लिए व्यू (प्रोफ़ाइल) के लिए खाता आईडी. यह कोई खास खाता आईडी या '~सभी' हो सकता है, जो उन सभी खातों के बारे में बताता है जिनका ऐक्सेस उपयोगकर्ता के पास है.
webPropertyId string व्यू (प्रोफ़ाइल) के लिए वेब प्रॉपर्टी आईडी, ताकि उसे फिर से हासिल किया जा सके. यह कोई खास वेब प्रॉपर्टी आईडी या '~सभी' हो सकता है, जो उन सभी वेब प्रॉपर्टी के बारे में बताता है जिनका ऐक्सेस उपयोगकर्ता के पास है.
वैकल्पिक क्वेरी पैरामीटर
max-results integer इस प्रतिक्रिया में शामिल किए जाने के लिए दृश्यों (प्रोफ़ाइल) की अधिकतम संख्या.
start-index integer फिर से हासिल की जाने वाली पहली इकाई का इंडेक्स. इस पैरामीटर का इस्तेमाल, max-results पैरामीटर के साथ, पेज पर नंबर डालने के तरीके के तौर पर करें.

अनुमति

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).

स्कोप
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

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

इस तरीके का इस्तेमाल करके, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अनुरोध की गई हर प्रोफ़ाइल के लिए, जवाब में एक प्रोफ़ाइल संसाधन शामिल है

{
  "kind": "analytics#profiles",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.profiles Resource
  ]
}
प्रॉपर्टी का नाम वैल्यू ब्यौरा ज़रूरी जानकारी
kind string कलेक्शन का टाइप.वैल्यू "analytics#Profile" है.
username string पुष्टि किए गए उपयोगकर्ता का ईमेल आईडी
totalResults integer क्वेरी के नतीजों की कुल संख्या, चाहे जवाब में कितने भी नतीजे मिले.
startIndex integer रिसॉर्स का शुरुआती इंडेक्स, जो डिफ़ॉल्ट रूप से 1 होता है या स्टार्ट-इंडेक्स क्वेरी पैरामीटर से तय होता है.
itemsPerPage integer रिस्पॉन्स में शामिल किए जा सकने वाले संसाधनों की ज़्यादा से ज़्यादा संख्या. इससे फ़र्क़ नहीं पड़ता कि रिस्पॉन्स में कितने संसाधन वापस किए गए हैं. इसकी वैल्यू, डिफ़ॉल्ट रूप से 1,000 वैल्यू के साथ 1 से 1,000 तक की रेंज में हो सकती है. इसके अलावा, इसकी वैल्यू 'सबसे ज़्यादा नतीजे वाले क्वेरी' पैरामीटर से भी तय की जा सकती है.
items[] list व्यू की सूची (प्रोफ़ाइल).

उदाहरण

ध्यान दें: इस तरीके के लिए दिए गए कोड के उदाहरणों में इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं नहीं दिखाई गई हैं (इसके साथ काम करने वाली भाषाओं की सूची के लिए क्लाइंट लाइब्रेरी वाला पेज देखें).

Java

Java क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the View (Profile) Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  Profiles profiles = analytics.management.profiles.list("12345",
      "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * Example #2:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
Profiles profiles = analytics.management.profiles.list("12345",
    "~all").execute();


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
for (Profile profile : profiles.getItems()) {
  System.out.println("Account ID: " + profile.getAccountId());
  System.out.println("Property ID: " + profile.getWebPropertyId());
  System.out.println("Property Internal ID: "
      + profile.getInternalWebPropertyId());
  System.out.println("View (Profile) ID: " + profile.getId());
  System.out.println("View (Profile) Name: " + profile.getName());
  System.out.println("View (Profile) defaultPage: " + profile.getDefaultPage());
  System.out.println("View (Profile) Exclude Query Parameters: "
      + profile.getExcludeQueryParameters());
  System.out.println("View (Profile) Site Search Query Parameters: "
      + profile.getSiteSearchQueryParameters());
  System.out.println("View (Profile) Site Search Category Parameters: "
      + profile.getSiteSearchCategoryParameters());
  System.out.println("View (Profile) Currency: " + profile.getCurrency());
  System.out.println("View (Profile) Timezone: " + profile.getTimezone());
  System.out.println("View (Profile) Created: " + profile.getCreated());
  System.out.println("View (Profile) Updated: " + profile.getUpdated());
  System.out.println("View (Profile) eCommerce Tracking: "
      + profile.getECommerceTracking());
  System.out.println("View (Profile) Enhanced eCommerce Tracking: "
      + profile.getEnhancedECommerceTracking());
}

PHP

PHP क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the View (Profile) Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  $profiles = $analytics->management_profiles
      ->listManagementProfiles('123456', 'UA-123456-1');

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


/**
 * Example #2:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
$profiles = $analytics->management_profiles
    ->listManagementProfiles('123456', '~all');


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
foreach ($profiles->getItems() as $profile) {
  $html = <<<HTML
<pre>
Account id                      = {$profile->getAccountId()}
Property id                     = {$profile->getWebPropertyId()}
View (Profile) id               = {$profile->getId()}
View (Profile) name             = {$profile->getName()}
View (Profile) type             = {$profile->getType()}
Default page                    = {$profile->getDefaultPage()}
Exclude query parameters        = {$profile->getExcludeQueryParameters()}
Site search category parameters = {$profile->getSiteSearchCategoryParameters()}
Currency                        = {$profile->getCurrency()}
Timezone                        = {$profile->getTimezone()}
Created                         = {$profile->getCreated()}
Updated                         = {$profile->getUpdated()}
eCommerce tracking              = {$profile->getECommerceTracking()}
Enhanced eCommerce Tracking     = {$profile->getEnhancedECommerceTracking()}
</pre>
HTML;
  print $html;
}

Python

Python क्लाइंट लाइब्रेरी का इस्तेमाल करता हो.

# Note: This code assumes you have an authorized Analytics service object.
# See the View (Profile) Developer Guide for details.

# Example #1:
# Requests a list of views (profiles) for the authorized user.
try:
  profiles = analytics.management().profiles().list(
      accountId='12345',
      webPropertyId='UA-12345-1').execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# Example #2:
# Retrieves views (profiles) for all properties of the user's account,
# using a wildcard '~all' as the webpropertyId.
profiles = analytics.management().profiles().list(accountId='12345',
                                                  webPropertyId='~all'
                                                 ).execute()

# Example #3:
# The results of the list method are stored in the profiles object.
# The following code shows how to iterate through them.
for profile in profiles.get('items', []):
  print 'Account ID                = %s' % profile.get('accountId')
  print 'Property ID           = %s' % profile.get('webPropertyId')
  print 'Internal Property ID  = %s' % profile.get('internalWebPropertyId')
  print 'View (Profile ID)         = %s' % profile.get('id')
  print 'View (Profile) Name       = %s' % profile.get('name')

  print 'Default Page = %s' %  profile.get('defaultPage')
  print 'Exclude Query Parameters        = %s' % profile.get(
      'excludeQueryParameters')
  print 'Site Search Category Parameters = %s' % profile.get(
      'siteSearchCategoryParameters')
  print 'Site Search Query Parameters    = %s' % profile.get(
      'siteSearchQueryParameters')

  print 'Currency = %s' % profile.get('currency')
  print 'Timezone = %s' % profile.get('timezone')
  print 'Created  = %s' % profile.get('created')
  print 'Updated  = %s' % profile.get('updated')
  print 'eCommerce Tracking = %s' % profile.get('eCommerceTracking')
  print 'Enhanced eCommerce Tracking = %s' % profile.get(
      'enhancedECommerceTracking')

JavaScript

JavaScript क्लाइंट लाइब्रेरी का इस्तेमाल करता हो.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the View (Profiles) Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all View (Profiles) for the authorized user.
 */
function listViews() {
  var request = gapi.client.analytics.management.profiles.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1'
  });
  request.execute(printViews);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printViews(results) {
  if (results && !results.error) {
    var profiles = results.items;
    for (var i = 0, profile; profile = profiles[i]; i++) {
      console.log('Account Id: ' + profile.accountId);
      console.log('Property Id: ' + profile.webPropertyId);
      console.log('Internal Property Id: ' + profile.internalWebPropertyId);
      console.log('View (Profile) Id: ' + profile.id);
      console.log('View (Profile) Name: ' + profile.name);

      console.log('Default Page: ' + profile.defaultPage);
      console.log('Exclude Query Parameters: '
          + profile.excludeQueryParameters);
      console.log('Site Search Category Parameters'
          + profile.siteSearchCategoryParameters);
      console.log('Site Search Query Parameters: '
          + profile.siteSearchQueryParameters);

      console.log('Currency: ' + profile.currency);
      console.log('Timezone: ' + profile.timezone);
      console.log('Created: ' + profile.created);
      console.log('Updated: ' + profile.updated);
    }
  }
}

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिया गया एपीआई एक्सप्लोरर इस्तेमाल करें. इसके अलावा, Standalone Explorer का इस्तेमाल भी किया जा सकता है.