Method: properties.runAccessReport

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

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

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
entity

string

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

प्रॉपर्टी लेवल पर अनुरोध करने के लिए, इकाई को 'properties/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)

मेट्रिक फ़िल्टर की मदद से, रिपोर्ट के जवाब को फ़िल्टर से मैच करने वाली खास मेट्रिक वैल्यू तक सीमित किया जा सकता है. मेट्रिक फ़िल्टर, रिपोर्ट की पंक्तियों को एग्रीगेट करने के बाद लागू किए जाते हैं. यह SQL having-clause की तरह ही होता है. इस फ़िल्टर में डाइमेंशन का इस्तेमाल नहीं किया जा सकता.
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

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

boolean

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

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

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

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

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

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