درحال پُرسمان «مجموعه‌های سنجه»

پس‌از اینکه همه چیز را راه‌اندازی کردید، می‌توانید درخواست‌هایی به Google Play Developer Reporting API ارسال کنید تا فراداده‌های مربوط به مجموعه‌های سنجه را بازیابی کنید و سنجه‌های آن‌ها را پُرسمان کنید.

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

درحال بازیابی فراداده مجموعه سنجه

مثال زیر فراداده را برای مجموعه سنجه نرخ خرابی برای یک برنامه فرضی، com.example.app، بازیابی می‌کند.

درخواست ساده:

این درخواست HTTP GET پارامتر نام برنامه را مشخص می‌کند و منبع سنجه کامل مرتبط با برنامه‌تان را برمی‌گرداند. 

GET https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/crashRateMetricSet

پاسخ اطلاعات سنجه:

پاسخ شامل فیلدهای زیر مربوط به مجموعه سنجه است: 

{
  "freshness_info": {
    "freshness": [
      "aggregation_period": "DAILY"
      "latest_end_time": { year: "2021" month: "7" day: "22" time_zone: "America/Los_Angeles" }
    ]
  }
}

استفاده کردن از ویژگی پُرسمان

درخواست اچ‌تی‌تی‌پی POST زیر برای همین منبع از نقطه پایانی query برای بازیابی داده‌های خاص از درون مجموعه سنجه استفاده می‌کند. 

POST https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/crashRateMetricSet:query

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

{
  "timeline_spec": {
    "aggregation_period": "DAILY"
    "start_time": { year: "2021" month: "7" day: "1" time_zone: "America/Los_Angeles" }
    "end_time": { year: "2021" month: "7" day: "3" time_zone: "America/Los_Angeles" }
   }
  "dimensions": ["apiLevel"]
  "metrics": ["errorReportCount", "distinctUsers"]
  "page_size": "10"
}

در اینجا چند نمونه در سطح مجموعه آورده شده است:

فیلدها
timelineSpec

object (TimelineSpec)

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

dimensions[]

string

ابعادی که سنجه‌ها براساس آن‌ها تقسیم می‌شوند. لطفاً برای مشاهده فهرست ابعاد پشتیبانی‌شده، اسناد هر مجموعه سنجه را بررسی کنید.
metrics[]

string

سنجه‌هایی که باید تجمیع شوند.
pageSize

integer

حداکثر اندازه داده‌های برگردانده‌شده.

اگر مشخص نشده باشد، حداکثر ۱۰۰۰ ردیف برگردانده خواهد شد. حداکثر مقدار ۱۰٬۰۰۰ است؛ مقادیر بالاتر از ۱۰٬۰۰۰ به ۱۰٬۰۰۰ تبدیل خواهد شد.

درحال رسیدگی به پاسخ‌ها

پس‌از اینکه سرور درخواست معتبری را که شامل فیلدهای معتبر است پردازش کرد، رمز وضعیت اچ‌تی‌تی‌پی 200 OK را به‌همراه داده‌های درخواست‌شده برمی‌گرداند. اگر پارامتر پُرسمان fields خطا داشته باشد یا به‌نحوی نامعتبر باشد، سرور کد وضعیت HTTP 400 Bad Request را به‌همراه پیام خطایی برمی‌گرداند که به کاربر می‌گوید مشکل انتخاب فیلدها چه بوده است (برای مثال، "Invalid field timeline_spec").

در اینجا نمونه پاسخ نشان‌داده‌شده در بخش مقدماتی بالا آورده شده است. 

POST https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/crashRateMetricSet:query

پاسخ به‌این‌صورت است:

200 OK
 
{
  rows: [
    {
      aggregation_period: "DAILY"
      start_time: { year: "2021" month: "7" day: "1" time_zone: "America/Los_Angeles" }
      dimensions: [{dimension: "apiLevel" int64_value: "20"}]
      metrics: [
        {metric: "errorReportCount" decimal_value: "100"},
        {metric: "distinctUsers" decimal_value: "57"},
      ]
    }, {
      aggregation_period: "DAILY"
      start_time: { year: "2021" month: "7" day: "1" time_zone: "America/Los_Angeles" }
      dimensions: [{dimension: "apiLevel" int64_value: "21"}]
      metrics: [
        {metric: "errorReportCount" decimal_value: "123"},
        {metric: "distinctUsers" decimal_value: "65"},
      ]
    },
    ...
  ]
  next_page_token: "eW91IGhhdmUgdG9vIG11Y2ggZnJlZSB0aW1l"
}

توجه: برای میاناهای برنامه‌سازی کاربردی که از پارامترهای پُرسمان برای صفحه‌بندی داده‌ها پشتیبانی می‌کنند (برای مثال، maxResults و nextPageToken)، از آن پارامترها برای کاهش نتایج هر پُرسمان به اندازه قابل‌مدیریت استفاده کنید.