Method: properties.runAccessReport

डेटा ऐक्सेस रिकॉर्ड की कस्टमाइज़ की गई रिपोर्ट दिखाता है. इस रिपोर्ट में, किसी उपयोगकर्ता के Google Analytics का रिपोर्टिंग डेटा हर बार पढ़े जाने का रिकॉर्ड मिलता है. ऐक्सेस के रिकॉर्ड दो साल तक सेव रखे जाते हैं.

किसी प्रॉपर्टी के लिए, डेटा ऐक्सेस रिपोर्ट का अनुरोध किया जा सकता है. रिपोर्ट का अनुरोध किसी भी प्रॉपर्टी के लिए किया जा सकता है. हालांकि, जो डाइमेंशन कोटा से जुड़े नहीं हैं उनका अनुरोध सिर्फ़ Google Analytics 360 प्रॉपर्टी पर किया जा सकता है. यह तरीका सिर्फ़ एडमिन के लिए उपलब्ध है.

इन डेटा ऐक्सेस रिकॉर्ड में GA यूज़र इंटरफ़ेस (यूआई) रिपोर्टिंग, GA यूज़र इंटरफ़ेस (यूआई) एक्सप्लोरेशन, GA Data API, Firebase और AdMob, जो लिंकेज के ज़रिए Google Analytics से डेटा हासिल कर सकता है. इन रिकॉर्ड में, प्रॉपर्टी कॉन्फ़िगरेशन में किए गए बदलाव शामिल नहीं होते. जैसे, स्ट्रीम जोड़ना या प्रॉपर्टी का टाइम ज़ोन बदलना. कॉन्फ़िगरेशन में बदलाव का इतिहास देखने के लिए, searchChangeHistoryEvents देखें.

इस एपीआई के बारे में सुझाव/राय देने या शिकायत करने के लिए, Google Analytics ऐक्सेस रिपोर्ट के बारे में सुझाव, शिकायत या राय वाला फ़ॉर्म भरें.

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

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
entity

string

डेटा ऐक्सेस रिपोर्ट की मदद से, प्रॉपर्टी या खाता लेवल पर अनुरोध किया जा सकता है. अगर खाता लेवल पर अनुरोध किया जाता है, तो डेटा ऐक्सेस रिपोर्ट में उस खाते की सभी प्रॉपर्टी के सभी ऐक्सेस शामिल होते हैं.

प्रॉपर्टी लेवल पर अनुरोध करने के लिए, इकाई का उदाहरण 'property/123' होना चाहिए अगर "123" आपकी Google Analytics प्रॉपर्टी आईडी है. खाते के लेवल पर अनुरोध करने के लिए, इकाई का नाम 'accounts/1234' होना चाहिए अगर "1234" है, तो आपके Google Analytics खाते का आईडी है.

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
फ़ील्ड
dimensions[]

object (AccessDimension)

अनुरोध किए गए डाइमेंशन और जवाब में दिखाए गए. ज़्यादा से ज़्यादा नौ डाइमेंशन के अनुरोध किए जा सकते हैं.

metrics[]

object (AccessMetric)

वे मेट्रिक जिनका अनुरोध किया गया और जवाब में दिखाई गईं. ज़्यादा से ज़्यादा 10 मेट्रिक के अनुरोध किए जा सकते हैं.

dateRanges[]

object (AccessDateRange)

पढ़ने के लिए, ऐक्सेस रिकॉर्ड की तारीख की सीमाएं. अगर तारीख की कई सीमाओं का अनुरोध किया जाता है, तो जवाब वाली हर लाइन में शून्य पर आधारित तारीख की सीमा का इंडेक्स होगा. अगर तारीख की दो सीमाएं ओवरलैप होती हैं, तो ओवरलैप होने वाले दिनों के ऐक्सेस रिकॉर्ड, दोनों तारीख की सीमाओं की जवाब वाली लाइनों में शामिल कर दिए जाते हैं. तारीख की ज़्यादा से ज़्यादा दो सीमाओं के अनुरोध किए जा सकते हैं.

dimensionFilter

object (AccessFilterExpression)

डाइमेंशन फ़िल्टर की मदद से, फ़िल्टर से मैच करने वाली खास डाइमेंशन वैल्यू के लिए ही रिपोर्ट रिस्पॉन्स देखा जा सकता है. उदाहरण के लिए, किसी एक उपयोगकर्ता के ऐक्सेस रिकॉर्ड को फ़िल्टर करना. ज़्यादा जानने के लिए, उदाहरणों के लिए डाइमेंशन फ़िल्टर की बुनियादी बातें देखें. इस फ़िल्टर में मीट्रिक का उपयोग नहीं किया जा सकता.

metricFilter

object (AccessFilterExpression)

मेट्रिक फ़िल्टर की मदद से, फ़िल्टर से मैच करने वाली चुनिंदा मेट्रिक वैल्यू के लिए ही रिपोर्ट का रिस्पॉन्स दिया जा सकता है. मेट्रिक फ़िल्टर, रिपोर्ट की लाइनों को एग्रीगेट करने के बाद लागू किए जाते हैं. यह एसक्यूएल मेंशन-क्लॉज़ की तरह ही होता है. इस फ़िल्टर में आयाम का उपयोग नहीं किया जा सकता है.

offset

string (int64 format)

शुरुआती पंक्ति की पंक्तियों की संख्या. पहली लाइन को शून्य के तौर पर गिना जाता है. अगर ऑफ़सेट की जानकारी नहीं है, तो इसे 0 माना जाता है. अगर ऑफ़सेट शून्य है, तो यह तरीका limit एंट्री के साथ नतीजों का पहला पेज दिखाएगा.

पेज पर नंबर डालने के इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना लेख पढ़ें.

limit

string (int64 format)

दिखाई जाने वाली पंक्तियों की संख्या. अगर जानकारी नहीं दी गई है, तो 10,000 लाइनें दिखती हैं. एपीआई हर अनुरोध के लिए ज़्यादा से ज़्यादा 1,00,000 लाइनें दिखाता है, चाहे आप कितनी भी क्वेरी क्यों न करें. limit, पॉज़िटिव होना चाहिए.

अगर limit जितनी पंक्तियां नहीं बची हैं, तो एपीआई अनुरोध किए गए limit के मुकाबले कम पंक्तियां दिखा सकता है. उदाहरण के लिए, country डाइमेंशन की 300 से कम संभावित वैल्यू होती हैं. इसलिए, सिर्फ़ country पर रिपोर्टिंग करते समय, आपको 300 से ज़्यादा लाइनें नहीं मिल सकतीं. भले ही, आपने limit की वैल्यू ज़्यादा पर सेट की हो.

पेज पर नंबर डालने के इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना लेख पढ़ें.

timeZone

string

अगर बताया गया है, तो इस अनुरोध का समय क्षेत्र. अगर यह जानकारी नहीं दी गई है, तो प्रॉपर्टी के टाइम ज़ोन का इस्तेमाल किया जाता है. अनुरोध के समय क्षेत्र का उपयोग प्रारंभ और रिपोर्ट की समाप्ति तारीखें होती हैं.

आईएएनए टाइम ज़ोन डेटाबेस (https://www.iana.org/time-zones) से स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया; उदाहरण के लिए "अमेरिका/New_York" या "एशिया/टोक्यो" में साइन इन करने का विकल्प चुना है.

orderBys[]

object (AccessOrderBy)

इससे पता चलता है कि रिस्पॉन्स में पंक्तियों को किस तरह क्रम से लगाया जाता है.

returnEntityQuota

boolean

यह टॉगल करता है कि इस Analytics प्रॉपर्टी के कोटा की मौजूदा स्थिति को लौटाना है या नहीं. कोटा, AccessQuota की जानकारी में शामिल होता है. खाता-लेवल के अनुरोधों के लिए, यह फ़ील्ड गलत होनी चाहिए.

includeAllUsers

boolean

ज़रूरी नहीं. इससे यह तय होता है कि उन उपयोगकर्ताओं को शामिल करना है या नहीं जिन्होंने रिस्पॉन्स में कभी एपीआई कॉल नहीं किया. अगर सही है, तो किसी खास प्रॉपर्टी या खाते का ऐक्सेस रखने वाले सभी उपयोगकर्ताओं को रिस्पॉन्स में शामिल किया जाता है. इससे कोई फ़र्क़ नहीं पड़ता कि उन्होंने एपीआई कॉल किया है या नहीं. गलत होने पर, सिर्फ़ एपीआई कॉल करने वाले उपयोगकर्ताओं को ही शामिल किया जाएगा.

expandGroups

boolean

ज़रूरी नहीं. तय करता है कि उपयोगकर्ता ग्रुप में उपयोगकर्ताओं को लौटाना है या नहीं. यह फ़ील्ड सिर्फ़ तब काम करता है, जब includeAllUsers को 'सही है' पर सेट किया गया हो. अगर सही है, तो यह किसी प्रॉपर्टी या खाते के ऐक्सेस वाले सभी उपयोगकर्ताओं को दिखाएगा. अगर यह गलत है, तो सिर्फ़ उन लोगों को दिखाया जाएगा जिनके पास इसका सीधा ऐक्सेस है.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में RunAccessReportResponse का एक इंस्टेंस शामिल किया जाता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit