- בקשת HTTP
- פרמטרים של הנתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התגובה
- היקפי הרשאות
- TimeSpec
- תאריך
- MetricRow
- MetricValue
- כדאי לנסות!
שליחת שאילתה לגבי המדדים של פריט.
בקשת HTTP
GET https://chromewebstore.googleapis.com/v2/{name=publishers/*/items/*}:queryMetrics
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של הנתיב
| פרמטרים | |
|---|---|
name |
חובה. שם הפריט שרוצים לשלוח שאילתה לגבי המדדים שלו. פורמט: publishers/{publisher}/items/{item} |
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
timeSpec |
חובה. מפרט הזמן שלגביו רוצים לשלוח שאילתה על קבוצת המדדים. |
metrics[] |
חובה. המדדים שרוצים לשלוח לגביהם שאילתה לקבוצת המדדים. מדדים נתמכים:
|
dimensions[] |
אופציונלי. מאפיינים שמשמשים לפילוח המדדים. אפשר לציין מאפיין אחד לכל היותר. מידות נתמכות:
|
pageSize |
אופציונלי. מספר השורות המקסימלי שיוחזרו. אם לא מציינים ערך, יוחזרו עד 100 שורות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000. |
pageToken |
אופציונלי. טוקן של דף שהתקבל מקריאה קודמת. צריך להזין את הטוקן כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו לבקשה חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף. |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
הודעת תגובה ל-items.queryMetrics.
אם הפעולה מצליחה, גוף התשובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{
"metricRows": [
{
object ( |
| שדות | |
|---|---|
metricRows[] |
שורות המדדים. |
nextPageToken |
טוקן שאפשר לשלוח כ- |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/chromewebstorehttps://www.googleapis.com/auth/chromewebstore.readonly
TimeSpec
טווח תאריכים לשאילתות על מדדים.
| ייצוג ב-JSON |
|---|
{ "firstDate": { object ( |
| שדות | |
|---|---|
firstDate |
אופציונלי. התאריך הראשון (כולל) של מפרט הזמן. אם לא מוגדר, לא יחול גבול תחתון. |
lastDate |
אופציונלי. התאריך האחרון (כולל) של מפרט הזמן. אם לא מוגדר, לא יחול גבול עליון. |
תאריך
מייצג תאריך מלא או חלקי בלוח השנה, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שהם לא משמעותיים. התאריך הוא לפי הלוח הגרגוריאני. הערך הזה יכול לייצג את אחד מהמצבים הבאים:
- תאריך מלא, עם ערכי שנה, חודש ויום שאינם אפס.
- חודש ויום, עם שנה אפס (לדוגמה, יום נישואין).
- שנה בלבד, עם אפס בחודש ואפס ביום.
- שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגה של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDaygoogle.type.DateTimegoogle.protobuf.Timestamp
| ייצוג ב-JSON |
|---|
{ "year": integer, "month": integer, "day": integer } |
| שדות | |
|---|---|
year |
השנה של התאריך. הערך חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך בלי שנה. |
month |
חודש בשנה. הערך חייב להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
יום בחודש. הערך חייב להיות בין 1 ל-31, ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי. |
MetricRow
שורה אחת של ערכי מדדים ומאפיינים.
| ייצוג ב-JSON |
|---|
{ "date": { object ( |
| שדות | |
|---|---|
date |
תאריך הרשומה. |
dimensionValues[] |
עמודות של ערכי מאפיינים בשורה. |
metricValues[] |
עמודות של מדדים בשורה. |
MetricValue
מייצג את הערך של מדד יחיד
| ייצוג ב-JSON |
|---|
{ "metric": string, "value": string, "uniqueUserCount": string } |
| שדות | |
|---|---|
metric |
שם המדד |
value |
הערך של המדד. |
uniqueUserCount |
מספר המשתמשים הייחודיים שמשויכים למדד (אם רלוונטי). |