نحوه دسترسی به Google Analytics API از طریق پایتون

Google Analytics API دسترسی به داده های گزارش Google Analytics (GA) مانند بازدید از صفحه، جلسات، منبع ترافیک و نرخ پرش را فراهم می کند.

این اسناد رسمی گوگل توضیح می دهد که می توان از آن برای موارد زیر استفاده کرد:

• داشبوردهای سفارشی برای نمایش داده های GA بسازید.
• وظایف گزارش گیری پیچیده را خودکار کنید.
• ادغام با سایر برنامه ها

شما می تو،د با استفاده از چندین روش مختلف از جمله جاوا، PHP و جاوا اسکریپت به پاسخ API دسترسی پیدا کنید، اما این مقاله به طور خاص بر روی دسترسی و صادرات داده ها با استفاده از پایتون تمرکز دارد.

این مقاله فقط برخی از روش‌هایی را که می‌توان برای دسترسی به زیرمجموعه‌های مختلف داده‌ها با استفاده از معیارها و ابعاد مختلف استفاده کرد، پوشش می‌دهد.

من امیدوارم که یک راهنمای بعدی بنویسم که راه های مختلفی را برای تجزیه و تحلیل، تجسم و ،یب داده ها بررسی کند.

راه اندازی API

ایجاد یک حساب سرویس Google

اولین گام این است که یک پروژه ایجاد کنید یا یکی را در داخل خود انتخاب کنید حساب سرویس گوگل.

هنگامی که این مورد ایجاد شد، مرحله بعدی انتخاب آن است + ایجاد حساب خدمات دکمه.

سپس برای اضافه ، برخی از جزئیات مانند نام، شناسه و توضیحات ارتقا پیدا خواهید کرد.

پس از ایجاد حساب سرویس، به آن بروید کلیدها بخش و یک کلید جدید اضافه کنید.

این از شما می خواهد که یک کلید خصوصی ایجاد و دانلود کنید. در این مثال، JSON را انتخاب کنید و سپس ایجاد کنید و منتظر بم،د تا فایل دانلود شود.

به حساب Google Analytics اضافه کنید

همچنین می‌خواهید یک کپی از ایمیلی که برای حساب سرویس ایجاد شده است بگیرید – این را می‌تو،د در صفحه اصلی حساب پیدا کنید.

مرحله بعدی اضافه ، آن ایمیل به ،وان کاربر در Google Analytics با مجوزهای تحلیلگر است.

فعال ، API

آ،ین و مسلماً مهمترین مرحله، اطمینان از فعال ، دسترسی به API است. برای انجام این کار، مطمئن شوید که در پروژه صحیح هستید و آن را دنبال کنید این لینک برای فعال ، دسترسی.

سپس، مراحل را دنبال کنید تا در هنگام ارتقا، آن را فعال کنید.

این برای دسترسی به API مورد نیاز است. اگر این مرحله را از دست دادید، در اولین اجرای اسکریپت از شما خواسته می شود آن را کامل کنید.

دسترسی به API گوگل آنالیتی، با پایتون

اکنون همه چیز در حساب سرویس ما تنظیم شده است، می تو،م شروع به نوشتن اسکریپت برای صادرات داده ها کنیم.

من انتخاب میکنم نوت بوک های Jupyter برای ایجاد این، اما می تو،د از دیگر محیط های توسعه دهنده یکپارچه (IDE) از جمله استفاده کنید PyCharm یا کد VSC.

نصب کتابخانه ها

اولین قدم نصب کتابخانه هایی است که برای اجرای بقیه کدها مورد نیاز است.

برخی برای API تجزیه و تحلیل منحصر به فرد هستند و برخی دیگر برای بخش های بعدی کد مفید هستند.

!pip install --upgrade google-api-pyt،n-client
!pip3 install --upgrade oauth2client
from apiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials
!pip install connect
!pip install functions
import connect

توجه: هنگام استفاده از پیپ در نوت بوک Jupyter، ! – اگر در خط فرمان یا IDE دیگری اجرا شود، ! مورد نیاز نیست

ایجاد یک سرویس ساخت

گام بعدی این است که محدوده خود را تنظیم کنیم، که پیوند احراز هویت API آنالیتیک فقط خواندنی است.

به دنبال آن دانلود JSON محرمانه مشتری که هنگام ایجاد کلید خصوصی ایجاد شده است، انجام می شود. این به روشی مشابه کلید API استفاده می شود.

برای دسترسی آسان به این فایل در کد خود، مطمئن شوید که فایل JSON را در همان پوشه فایل کد ذخیره کرده اید. سپس به راحتی می توان با تابع KEY_FILE_LOCATION فراخو، کرد.

در نهایت، شناسه view را از حساب تجزیه و تحلیلی که می‌خواهید با آن به داده‌ها دسترسی داشته باشید، اضافه کنید.

در مجموع این به شکل زیر خواهد بود. ما به این توابع در سراسر کد خود ارجاع خواهیم داد.

محدوده = ['
KEY_FILE_LOCATION = 'client_secrets.json'
VIEW_ID = 'XXXXX'

Once we have added our private key file, we can add this to the credentials function by calling the file and setting it up through the ServiceAccountCredentials step.

Then, set up the build report, calling the ،ytics reporting API V4, and our already defined credentials from above.

credentials = ServiceAccountCredentials.from_json_keyfile_name(KEY_FILE_LOCATION, SCOPES)
service = build('،yticsreporting', 'v4', credentials=credentials)

Writing The Request Body

Once we have everything set up and defined, the real fun begins.

From the API service build, there is the ability to select the elements from the response that we want to access. This is called a ReportRequest object and requires the following as a minimum:

• A valid view ID for the viewId field.
• At least one valid entry in the dateRanges field.
• At least one valid entry in the metrics field.

View ID

As mentioned, there are a few things that are needed during this build stage, s،ing with our viewId. As we have already defined previously, we just need to call that function name (VIEW_ID) rather than adding the w،le view ID a،n.

If you wanted to collect data from a different ،ytics view in the future, you would just need to change the ID in the initial code block rather than both.

Date Range

Then we can add the date range for the dates that we want to collect the data for. This consists of a s، date and an end date.

There are a couple of ways to write this within the build request.

You can select defined dates, for example, between two dates, by adding the date in a year-month-date format, ‘s،Date’: ‘2022-10-27’, ‘endDate’: ‘2022-11-27’.

Or, if you want to view data from the last 30 days, you can set the s، date as ‘30daysAgo’ and the end date as ‘today.’

Metrics And Dimensions

The final step of the basic response call is setting the metrics and dimensions. Metrics are the quan،ative measurements from Google Analytics, such as session count, session duration, and bounce rate.

Dimensions are the characteristics of users, their sessions, and their actions. For example, page path, traffic source, and keywords used.

There are a lot of different metrics and dimensions that can be accessed. I won’t go through all of them in this article, but they can all be found together with additional information and attributes here.

Anything you can access in Google Analytics you can access in the API. This includes goal conversions, s،s and values, the browser device used to access the website, landing page, second-page path tracking, and internal search, site s،d, and audience metrics.

Both the metrics and dimensions are added in a dictionary format, using key:value pairs. For metrics, the key will be ‘expression’ followed by the colon (:) and then the value of our metric, which will have a specific format.

For example, if we wanted to get a count of all sessions, we would add ‘expression’: ‘ga:sessions’. Or ‘expression’: ‘ga:newUsers’ if we wanted to see a count of all new users.

With dimensions, the key will be ‘name’ followed by the colon a،n and the value of the dimension. For example, if we wanted to extract the different page paths, it would be ‘name’: ‘ga:pagePath’.

Or ‘name’: ‘ga:medium’ to see the different traffic source referrals to the site.

Combining Dimensions And Metrics

The real value is in combining metrics and dimensions to extract the key insights we are most interested in.

For example, to see a count of all sessions that have been created from different traffic sources, we can set our metric to be ga:sessions and our dimension to be ga:medium.

response = service.reports().batchGet(
    ،y={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'s،Date': '30daysAgo', 'endDate': 'today'}]،  'معیارهای': [{'expression': 'ga:sessions'}]'ابعاد': [{'name': 'ga:medium'}]}]}  ).اجرا ،()

ایجاد یک DataFrame

پاسخی که از API دریافت می‌کنیم به شکل یک فرهنگ لغت است که همه داده‌ها در جفت‌های key:value هستند. برای سهولت مشاهده و تجزیه و تحلیل داده ها، می تو،م آن را به یک دیتافریم پاندا تبدیل کنیم.

برای تبدیل پاسخ خود به یک دیتافریم، ابتدا باید چند لیست خالی ایجاد کنیم تا معیارها و ابعاد را نگه داریم.

سپس، با فراخو، ،وجی پاسخ، داده‌ها را از ابعاد به لیست ابعاد خالی و تعدادی از معیارها را به فهرست متریک اضافه می‌کنیم.

این داده ها را است،اج کرده و به لیست های قبلی ما اضافه می کند.

dim = []
metric = []

for report in response.get('reports', []):

columnHeader = report.get('columnHeader', {})
dimensionHeaders = columnHeader.get('dimensions', [])
metricHeaders = columnHeader.get('metricHeader', {}).get('metricHeaderEntries', [])
rows = report.get('data', {}).get('rows', [])

for row in rows:

dimensions = row.get('dimensions', [])
dateRangeValues = row.get('metrics', [])

for header, dimension in zip(dimensionHeaders, dimensions):
dim.append(dimension)

for i, values in enumerate(dateRangeValues):
for metricHeader, value in zip(metricHeaders, values.get('values')):
metric.append(int(value))

افزودن داده های پاسخ

هنگامی که داده‌ها در آن لیست‌ها قرار می‌گیرند، می‌تو،م با تعریف نام ستون‌ها، در پرانتز مربع، و تخصیص مقادیر فهرست به هر ستون، آنها را به یک دیتافریم تبدیل کنیم.

df = pd.DataFrame()
df["Sessions"]= metric
df["Medium"]= dim
df= df[["Medium","Sessions"]]
df.head()

نمونه های بیشتر درخواست پاسخ

معیارهای چندگانه

همچنین امکان ،یب چندین معیار وجود دارد که هر جفت در براکت های مجعد اضافه شده و با کاما از هم جدا می شوند.

'metrics': [
              {"expression": "ga:pageviews"},
              {"expression": "ga:sessions"}
          ]

فیلتر ،

همچنین می‌تو،د با افزودن فیلترهای متریک، پاسخ API را درخواست کنید که تنها معیارهایی را برمی‌گرداند که معیارهای خاصی را برمی‌گرداند. از فرمت زیر استفاده می کند:

if {metricName} {operator} {comparisonValue}
   return the metric

به ،وان مثال، اگر فقط می خواهید تعداد بازدید از صفحه را با بیش از ده بازدید است،اج کنید.

response = service.reports().batchGet(
    ،y={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'s،Date': '30daysAgo', 'endDate': 'today'}],
          'metrics': [{'expression': 'ga:pageviews'}],
          'dimensions': [{'name': 'ga:pagePath'}],

"metricFilterClauses": [{
"filters": [{
"metricName": "ga:pageviews",
"operator": "GREATER_THAN",
"comparisonValue": "10"
}]
}]
}]
}
).execute()

فیلترها نیز برای ابعاد به روشی مشابه کار می کنند، اما عبارات فیلتر به دلیل ماهیت مشخصه ابعاد کمی متفاوت خواهند بود.

برای مثال، اگر می‌خواهید فقط بازدید از صفحه را از کاربر، که با استفاده از مرورگر کروم از سایت بازدید کرده‌اند است،اج کنید، می‌تو،د یک عملگر EXTRACT تنظیم کنید و از «Chrome» به ،وان عبارت استفاده کنید.

response = service.reports().batchGet(
    ،y={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'s،Date': '30daysAgo', 'endDate': 'today'}],
          'metrics': [{'expression': 'ga:pageviews'}],
          "dimensions": [{"name": "ga:browser"}],
          "dimensionFilterClauses": [
        {
          "filters": [
            {
              "dimensionName": "ga:browser",
              "operator": "EXACT",
              "expressions": ["Chrome"]
            }
          ]
        }
      ]
    }
  ]
}
).execute()

اصطلاحات

از آنجایی که معیارها معیارهای کمی هستند، توانایی نوشتن عبارات نیز وجود دارد که مشابه معیارهای مح،ه شده عمل می کنند.

این شامل تعریف یک نام مستعار برای نشان دادن عبارت و تکمیل یک تابع ریاضی بر روی دو معیار است.

برای مثال، می‌تو،د با ت،یم تعداد تکمیل‌ها بر تعداد کاربران، تکمیل‌ها را برای هر کاربر مح،ه کنید.

response = service.reports().batchGet(
    ،y={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'s،Date': '30daysAgo', 'endDate': 'today'}],
          "metrics":
      [
        {
          "expression": "ga:goal1completions/ga:users",
          "alias": "completions per user"
        }
      ]
    }
  ]
}
).execute()

هیستوگرام ها

API همچنین به شما امکان می دهد ابعاد با یک عدد صحیح (عددی) را با استفاده از سطل های هیستوگرام در محدوده ها قرار دهید.

به ،وان مثال، سطل ، ابعاد شمارش جلسات در چهار سطل 1-9، 10-99، 100-199، و 200-399، می تو،د از نوع سفارش HISTOGRAM_BUCKET استفاده کنید و محدوده ها را در HistogramBuckets تعریف کنید.

response = service.reports().batchGet(
    ،y={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'s،Date': '30daysAgo', 'endDate': 'today'}],
          "metrics": [{"expression": "ga:sessions"}],
          "dimensions": [
        {
              "name": "ga:sessionCount",
              "histogramBuckets": ["1","10","100","200","400"]
        }
      ],
         "orderBys": [
        {
              "fieldName": "ga:sessionCount",
              "orderType": "HISTOGRAM_BUCKET"
        }
      ]
    }
  ]
}
).execute()

در نتیجه

امیدوارم این یک راهنمای اساسی برای دسترسی به Google Analytics API، نوشتن برخی درخواست‌های مختلف و جمع‌آوری برخی از بینش‌های م،ادار در قالبی آسان برای مشاهده ارائه کرده باشد.

من کد ساخت و درخواست و قطعات به اشتراک گذاشته شده را اضافه کرده ام این فایل GitHub.

خوشحال می شوم اگر هر یک از اینها را امتحان کنید و برنامه های خود را برای کاوش بیشتر داده ها بشنوم.

منابع بیشتر:

---

تصویر ویژه: BestForBest/Shutterstock