Method: accounts.runAccessReport

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

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

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
entity

string

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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 के तौर पर की जाती है. अगर ऑफ़सेट तय नहीं किया गया है, तो इसे 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) से मिली स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया हो; उदाहरण के लिए, "America/New_York" या "Asia/Tokyo".

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