נדרשת הרשאה
בתיבת הדו-שיח הזו מפורטים מדדים מותאמים אישית שלמשתמש יש גישה אליהם. אפשר לנסות עכשיו או לראות דוגמה.
בקשה
בקשת HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customMetrics
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים של נתיב | ||
accountId |
string |
מספר החשבון של המדדים המותאמים אישית שרוצים לאחזר. |
webPropertyId |
string |
מזהה נכס אינטרנט עבור המדדים המותאמים אישית שיש לאחזר. |
פרמטרים אופציונליים של שאילתות | ||
max-results |
integer |
המספר המקסימלי של מדדים מותאמים אישית שיש לכלול בתשובה הזו. |
start-index |
integer |
אינדקס של הישות הראשונה שיש לאחזר. משתמשים בפרמטר הזה כמנגנון עימוד יחד עם הפרמטר max-results. |
אישור
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/analytics.readonly |
https://www.googleapis.com/auth/analytics |
גוף הבקשה
אל תספקו גוף הבקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{ "kind": "analytics#customMetrics", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customMetrics Resource ] }
שם הנכס | ערך | תיאור | הערות |
---|---|---|---|
kind |
string |
סוג האוסף. | |
username |
string |
מזהה אימייל של המשתמש המאומת | |
totalResults |
integer |
המספר הכולל של התוצאות לשאילתה, ללא קשר למספר התוצאות בתגובה. | |
startIndex |
integer |
אינדקס ההתחלה של המשאבים, שהוא 1 כברירת מחדל או שצוין אחרת על ידי פרמטר השאילתה start-index. | |
itemsPerPage |
integer |
המספר המקסימלי של משאבים שהתגובה יכולה להכיל, ללא קשר למספר המשאבים שהוחזרו בפועל. הערך שלו נע בין 1 ל-1,000 עם ערך של 1000 כברירת מחדל, או צוין אחרת על ידי פרמטר השאילתה max-results. | |
previousLink |
string |
קישור לדף הקודם של אוסף המדדים המותאמים אישית. | |
nextLink |
string |
קישור לדף הבא עבור האוסף הזה של מדדים מותאמים אישית. | |
items[] |
list |
אוסף של מדדים מותאמים אישית. |
דוגמאות
הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).
Java
משתמש בספריית הלקוח של Java.
/** * Note: This code assumes you have an authorized Analytics service object. */ /** * This request lists all custom metrics for the authorized user. */ try { CustomMetrics metrics = analytics.management.customMetrics .list("12345", "UA-12345-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * The results of the list method are stored in the metrics object. * The following code shows how to iterate through them. */ for (CustomMetric metric : metrics.getItems()) { System.out.println("Metric Kind: " + metric.getKind()); System.out.println("Metric Id: " + metric.getId()); System.out.println("Account ID: " + metric.getAccountId()); System.out.println("Property ID: " + metric.getWebPropertyId()); System.out.println("Metric Name: " + metric.getName()); System.out.println("Metric Index: " + metric.getIndex()); System.out.println("Metric Scope: " + metric.getScope()); System.out.println("Metric Active: " + metric.getActive()); System.out.println("Metric Type: " + metric.getType()); System.out.println("Metric Created: " + metric.getCreated()); System.out.println("Metric Updated: " + metric.getUpdated()); }
Python
משתמש בספריית הלקוח של Python.
# Note: This code assumes you have an authorized Analytics service object. # This request lists all custom metrics for the authorized user. try: metrics = analytics.management().customMetrics().list( accountId='123456', webPropertyId='UA-123456-1', ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason)) # The results of the list method are stored in the metrics object. # The following code shows how to iterate through them. for metric in metrics.get('items', []): print 'Metric Kind = %s' % metric.get('kind') print 'Metric Id = %s' % metric.get('id') print 'Account ID = %s' % metric.get('accountId') print 'Property ID = %s' % metric.get('webPropertyId') print 'Metric Name = %s' % metric.get('name') print 'Metric Index = %s' % metric.get('index') print 'Metric Scope = %s' % metric.get('scope') print 'Metric Active = %s' % metric.get('active') print 'Metric Type = %s' % metric.get('type') print 'Metric Created = %s' % metric.get('created') print 'Metric Updated = %s' % metric.get('updated')
רוצה לנסות?
צריך להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר לנסות את ה-Explorer העצמאי.