Custom Dimensions: list

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

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

अनुरोध

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

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

पैरामीटर

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

अनुमति

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

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

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

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

जवाब

अगर यह तरीका काम करता है, तो यह इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:

{
  "kind": "analytics#customDimensions",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customDimensions Resource
  ]
}
प्रॉपर्टी का नाम वैल्यू ब्यौरा ज़रूरी जानकारी
kind string कलेक्शन का टाइप.
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.
 */

/**
 * This request lists all custom dimensions for the authorized user.
 */
try {
  CustomDimensions dimensions = analytics.management.customDimensions
      .list("12345", "UA-12345-1").execute();

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


/**
 * The results of the list method are stored in the dimensions object.
 * The following code shows how to iterate through them.
 */
for (CustomDimension dimension : dimensions.getItems()) {
  System.out.println("Dimension Kind: " + dimension.getKind());
  System.out.println("Dimension Id: " + dimension.getId());
  System.out.println("Account ID: " + dimension.getAccountId());
  System.out.println("Property ID: " + dimension.getWebPropertyId());
  System.out.println("Dimension Name: " + dimension.getName());
  System.out.println("Dimension Index: " + dimension.getIndex());
  System.out.println("Dimension Scope: " + dimension.getScope());
  System.out.println("Dimension Active: " + dimension.getActive());
  System.out.println("Dimension Created: " + dimension.getCreated());
  System.out.println("Dimension Updated: " + dimension.getUpdated());
}

Python

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

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom dimensions for the authorized user.
try:
  dimensions = analytics.management().customDimensions().list(
      accountId='123456',
      webPropertyId='UA-123456-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))


# The results of the list method are stored in the dimensions object.
# The following code shows how to iterate through them.
for dimension in dimensions.get('items', []):
  print 'Dimension Kind = %s' % dimension.get('kind')
  print 'Dimension Id = %s' % dimension.get('id')
  print 'Account ID = %s' % dimension.get('accountId')
  print 'Property ID = %s' % dimension.get('webPropertyId')
  print 'Dimension Name = %s' % dimension.get('name')
  print 'Dimension Index = %s' % dimension.get('index')
  print 'Dimension Scope = %s' % dimension.get('scope')
  print 'Dimension Active = %s' % dimension.get('active')
  print 'Dimension Created = %s' % dimension.get('created')
  print 'Dimension Updated = %s' % dimension.get('updated')

इसे आज़माएं!

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