נדרשת הרשאה
בתיבת הדו-שיח הזו מפורטים נכסים שיש למשתמש גישה אליהם. אפשר לנסות עכשיו או לראות דוגמה.
בנוסף לפרמטרים הרגילים, השיטה הזו תומכת בפרמטרים המפורטים בטבלת הפרמטרים.
בקשה
בקשת HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties
פרמטרים
שם הפרמטר | תמורה לכסף | תיאור |
---|---|---|
פרמטרים של נתיב | ||
accountId |
string |
מספר חשבון שעבורו יש לאחזר נכסי אינטרנט. יכול להיות מספר חשבון ספציפי או הערך '~all ', שמתייחס לכל החשבונות שלמשתמש יש גישה אליהם.
|
פרמטרים אופציונליים של שאילתות | ||
max-results |
integer |
המספר המקסימלי של נכסי אינטרנט שיש לכלול בתשובה הזו. |
start-index |
integer |
אינדקס של הישות הראשונה שיש לאחזר. צריך להשתמש בפרמטר הזה כמנגנון עימוד יחד עם הפרמטר max-results .
|
אישור
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/analytics |
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
גוף הבקשה
אל תספקו גוף הבקשה בשיטה הזו.
תשובה
התשובה מכילה משאב Webproperty אחד לכל נכס אינטרנט בקשה ב-Analytics.
{ "kind": "analytics#webproperties", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webproperties Resource ] }
שם הנכס | תמורה לכסף | תיאור | הערות |
---|---|---|---|
kind |
string |
סוג האוסף. הערך הוא 'analytics#webProperties '. |
|
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. * See the Web Property Developer Guide for details. */ /** * Example #1: * Requests a list of all properties for the authorized user. */ try { Webproperties properties = analytics.management. webproperties.list("12345").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * Example #2: * Retrieves all properties for the user's account, using a * wildcard '~all' as the accountId. */ Webproperties properties = analytics.management. webproperties.list("~all").execute(); /** * Example #3: * The results of the list method are stored in the properties object. * The following code shows how to iterate through them. */ for (Webproperty property : properties.getItems()) { System.out.println("Account ID: " + property.getAccountId()); System.out.println("Property ID: " + property.getId()); System.out.println("Property Name: " + property.getName()); System.out.println("Property Profile Count: " + property.getProfileCount()); System.out.println("Property Industry Vertical: " + property.getIndustryVertical()); System.out.println("Property Internal Id: " + property.getInternalWebPropertyId()); System.out.println("Property Level: " + property.getLevel(); if (property.getWebsiteUrl() != null) { System.out.println("Property URL: " + property.getWebsiteUrl()); } System.out.println("Property Created: " + property.getCreated()); System.out.println("Property Updated: " + property.getUpdated()); }
PHP
משתמש בספריית הלקוח של PHP.
/** * Note: This code assumes you have an authorized Analytics service object. * See the Web Property Developer Guide for details. */ /** * Example #1: * Requests a list of all properties for the authorized user. */ try { $properties = $analytics->management_webproperties ->listManagementWebproperties('123456'); } catch (apiServiceException $e) { print 'There was an Analytics API service error ' . $e->getCode() . ':' . $e->getMessage(); } catch (apiException $e) { print 'There was a general API error ' . $e->getCode() . ':' . $e->getMessage(); } /** * Example #2: * Retrieves all properties for the user's account, using a * wildcard ~all as the accountId. */ $properties = $analytics->management_webproperties ->listManagementWebproperties('~all'); /** * Example #3: * The results of the list method are stored in the properties object. * The following code shows how to iterate through them. */ foreach ($properties->getItems() as $property) { $html = <<<HTML <pre> Account id = {$property->getAccountId()} Property id = {$property->getId()} Property name = {$property->getName()} Property URL = {$property->getWebsiteUrl()} Created = {$property->getCreated()} Updated = {$property->getUpdated()} </pre> HTML; print $html; }
Python
משתמש בספריית הלקוח של Python.
# Note: This code assumes you have an authorized Analytics service object. # See the Web Property Developer Guide for details. # Example #1: # Requests a list of all properties for the authorized user. try: properties = analytics.management().webproperties().list( accountId='12345').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)) # Example #2: # Retrieves all properties for the user's account, using a # wildcard ~all as the accountId. properties = service.management().webproperties().list( accountId='~all').execute() # Example #3: # The results of the list method are stored in the webproperties object. # The following code shows how to iterate through them. for property in properties.get('items', []): print 'Account ID = %s' % property.get('accountId') print 'Property ID = %s' % property.get('id') print 'Property Name = %s' % property.get('name') print 'Property Profile Count = %s' % property.get('profileCount') print 'Property Industry Vertical = %s' % property.get('industryVertical') print 'Property Internal Id = %s' % property.get( 'internalWebPropertyId') print 'Property Level = %s' % property.get('level') if property.get('websiteUrl'): print 'Property URL = %s' % property.get('websiteUrl') print 'Created = %s' % property.get('created') print 'Updated = %s' % property.get('updated')
JavaScript
נעשה שימוש בספריית הלקוח של JavaScript.
/* * Note: This code assumes you have an authorized Analytics client object. * See the Web Property Developer Guide for details. */ /* * Example 1: * Requests a list of all properties for the authorized user. */ function listProperties() { var request = gapi.client.analytics.management.webproperties.list({ 'accountId': '123456' }); request.execute(printProperties); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printProperties(results) { if (results && !results.error) { var properties = results.items; for (var i = 0, property; property = properties[i]; i++) { console.log('Account Id: ' + property.accountId); console.log('Property Id: ' + property.id); console.log('Property Name: ' + property.name); console.log('Property Profile Count: ' + property.profileCount); console.log('Property Industry Vertical: ' + property.industryVertical); console.log('Property Internal Id: ' + property.internalWebPropertyId); console.log('Property Level: ' + property.level); if (property.websiteUrl) { console.log('Property URL: ' + property.websiteUrl); } console.log('Created: ' + property.created); console.log('Updated: ' + property.updated); } } }
רוצה לנסות?
צריך להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר לנסות את ה-Explorer העצמאי.