Web Properties: list

अनुमति देना ज़रूरी है

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

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

अनुरोध करें

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

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

पैरामीटर

पैरामीटर का नाम वैल्यू जानकारी
पाथ पैरामीटर
accountId string वह खाता आईडी जिससे वेब प्रॉपर्टी को वापस पाना है. यह एक खास खाता आईडी या '~all' हो सकता है. इसमें ऐसे सभी खातों के बारे में बताया जाता है जिनका ऐक्सेस उपयोगकर्ताओं के पास होता है.
क्वेरी के वैकल्पिक पैरामीटर
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

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

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

जवाब

रिस्पॉन्स में, अनुरोध की गई हर Analytics वेब प्रॉपर्टी के लिए एक वेबप्रॉपर्टी रिसॉर्स शामिल होता है.

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

उदाहरण

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

Java

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

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Web Property Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  Webproperties properties = analytics.management.
      webproperties.list("12345").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * Example #2:
 * Retrieves all properties for the user's account, using a
 * wildcard '~all' as the accountId.
 */
Webproperties properties = analytics.management.
    webproperties.list("~all").execute();


/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
for (Webproperty property : properties.getItems()) {
  System.out.println("Account ID: " + property.getAccountId());
  System.out.println("Property ID: " + property.getId());
  System.out.println("Property Name: " + property.getName());
  System.out.println("Property Profile Count: " + property.getProfileCount());
  System.out.println("Property Industry Vertical: "
      + property.getIndustryVertical());
  System.out.println("Property Internal Id: "
      + property.getInternalWebPropertyId());
  System.out.println("Property Level: " + property.getLevel();
  if (property.getWebsiteUrl() != null) {
    System.out.println("Property URL: " + property.getWebsiteUrl());
  }
  System.out.println("Property Created: " + property.getCreated());
  System.out.println("Property Updated: " + property.getUpdated());
}

PHP

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

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Web Property Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  $properties = $analytics->management_webproperties
      ->listManagementWebproperties('123456');

} 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 all properties for the user's account, using a
 * wildcard ~all as the accountId.
 */
$properties = $analytics->management_webproperties
    ->listManagementWebproperties('~all');


/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
foreach ($properties->getItems() as $property) {

  $html = <<<HTML
<pre>
Account id    = {$property->getAccountId()}
Property id   = {$property->getId()}
Property name = {$property->getName()}
Property URL  = {$property->getWebsiteUrl()}
Created       = {$property->getCreated()}
Updated       = {$property->getUpdated()}
</pre>

HTML;
  print $html;
}

Python

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

# Note: This code assumes you have an authorized Analytics service object.
# See the Web Property Developer Guide for details.


# Example #1:
# Requests a list of all properties for the authorized user.
try:
  properties = analytics.management().webproperties().list(
      accountId='12345').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 all properties for the user's account, using a
# wildcard ~all as the accountId.
properties = service.management().webproperties().list(
    accountId='~all').execute()


# Example #3:
# The results of the list method are stored in the webproperties object.
# The following code shows how to iterate through them.
for property in properties.get('items', []):
  print 'Account ID         = %s' % property.get('accountId')
  print 'Property ID    = %s' % property.get('id')
  print 'Property Name  = %s' % property.get('name')
  print 'Property Profile Count = %s' % property.get('profileCount')
  print 'Property Industry Vertical = %s' % property.get('industryVertical')
  print 'Property Internal Id = %s' % property.get(
      'internalWebPropertyId')
  print 'Property Level = %s' % property.get('level')
  if property.get('websiteUrl'):
    print 'Property URL        = %s' % property.get('websiteUrl')
  print 'Created            = %s' % property.get('created')
  print 'Updated            = %s' % property.get('updated')

JavaScript

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

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Web Property Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all properties for the authorized user.
 */
function listProperties() {
  var request = gapi.client.analytics.management.webproperties.list({
    'accountId': '123456'
  });
  request.execute(printProperties);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printProperties(results) {
  if (results && !results.error) {
    var properties = results.items;
    for (var i = 0, property; property = properties[i]; i++) {
      console.log('Account Id: ' + property.accountId);
      console.log('Property Id: ' + property.id);
      console.log('Property Name: ' + property.name);
      console.log('Property Profile Count: ' + property.profileCount);
      console.log('Property Industry Vertical: ' + property.industryVertical);
      console.log('Property Internal Id: ' + property.internalWebPropertyId);
      console.log('Property Level: ' + property.level);
      if (property.websiteUrl) {
        console.log('Property URL: ' + property.websiteUrl);
      }

      console.log('Created: ' + property.created);
      console.log('Updated: ' + property.updated);
    }
  }
}

इसे आज़माएं!

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