- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- ردیف
- گروه مقادیر متریک
- امتحانش کن!
ردیفهای نتیجه را از یک گزارش تکمیلشده برمیگرداند. فراخوانیکننده باید قبلاً RunReport فراخوانی کرده و منتظر تکمیل آن عملیات باشد. ردیفها طبق ترتیبی که توسط عضو sorts در تعریف گزارش مشخص شده است، برگردانده میشوند.
درخواست HTTP
GET https://curationpartners.googleapis.com/v1/{name=curators/*/reports/*/results/*}:fetchRows
این URL از سینتکس Transcoding در gRPC استفاده میکند.
پارامترهای مسیر
| پارامترها | |
|---|---|
name | نتیجه گزارش در حال واکشی است. قالب: |
پارامترهای پرس و جو
| پارامترها | |
|---|---|
pageSize | اختیاری. حداکثر تعداد ردیفهایی که باید برگردانده شوند. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰۰ ردیف برگردانده میشود. حداکثر مقدار ۱۰۰۰۰ است؛ مقادیر بزرگتر از ۱۰۰۰۰ به ۱۰۰۰۰ کاهش مییابند. |
pageToken | اختیاری. یک توکن صفحه، که از فراخوانی قبلی |
درخواست بدنه
بدنه درخواست باید خالی باشد.
بدنه پاسخ
پیام پاسخ برای نقطه پایانی ردیفهای نتیجه گزارش واکشی.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "rows": [ { object ( |
| فیلدها | |
|---|---|
rows[] | ردیفهای دادههای گزارش تا |
runTime | زمانی که قرار بود گزارش در آن اجرا شود. برای گزارشهای برنامهریزی نشده، این زمانی است که درخواست شده گزارش در آن اجرا شود. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
dateRanges[] | محدوده تاریخ ثابت محاسبهشدهای که این گزارش شامل آن میشود. فقط با صفحه اول نتایج بازگردانده میشود (زمانی که pageToken در درخواست گنجانده نشده باشد). |
totalRowCount | تعداد کل ردیفهای موجود از این گزارش. برای صفحهبندی مفید است. فقط با صفحه اول نتایج برگردانده میشود (وقتی pageToken در درخواست لحاظ نشده باشد). |
nextPageToken | یک توکن که میتواند به عنوان |
دامنههای مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/curation-partners
ردیف
ردیفی از دادههای گزارش.
| نمایش JSON |
|---|
{ "dimensionValues": [ { object ( |
| فیلدها | |
|---|---|
dimensionValues[] | ترتیب مقادیر ابعاد، همان ترتیب ابعاد مشخص شده در درخواست است. |
metricValueGroups[] | طول فیلد metricValueGroups برابر با طول فیلد dateRanges در پاسخ واکشی خواهد بود. فیلد metricValueGroups به گونهای مرتب شده است که هر شاخص با dateRange در همان شاخص مطابقت داشته باشد. به عنوان مثال، با توجه به dateRanges [x, y]، metricValueGroups طولی برابر با دو خواهد داشت. اولین ورودی در metricValueGroups نشان دهنده معیارهای تاریخ x و دومین ورودی در metricValueGroups نشان دهنده معیارهای تاریخ y است. |
گروه مقادیر متریک
شامل تمام مقادیر معیار درخواست شده برای یک محدوده تاریخ واحد و مجموعهای از مقادیر ابعاد ستون (که در فیلد ستونهای پاسخ برگردانده میشوند) است. ترتیب معیارها در هر فیلد مطابق با ترتیب معیارهای مشخص شده در درخواست است.
| نمایش JSON |
|---|
{
"primaryValues": [
{
object ( |
| فیلدها | |
|---|---|
primaryValues[] | دادهها برای نوع معیار اولیه (PRIMARY MetricValueType). |