נדרשת הרשאה
בתיבת הדו-שיח הזו מפורטים קישורים למשתמשים בנכס אינטרנט עבור נכס אינטרנט נתון. אפשר לנסות עכשיו או לראות דוגמה.
בנוסף לפרמטרים הרגילים, השיטה הזו תומכת בפרמטרים המפורטים בטבלת הפרמטרים.
בקשה
בקשת HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityUserLinks
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים של נתיב | ||
accountId |
string |
מזהה החשבון שאליו שייך נכס האינטרנט הנתון. |
webPropertyId |
string |
מזהה נכס אינטרנט לקישורים של משתמשי WebProperty לצורך אחזור. יכול להיות מזהה נכס אינטרנט ספציפי או הערך '~all', שמתייחס לכל נכסי האינטרנט שלמשתמש יש גישה אליהם. |
פרמטרים אופציונליים של שאילתות | ||
max-results |
integer |
המספר המקסימלי של קישורים למשתמש-WebProperty שיש לכלול בתשובה הזו. |
start-index |
integer |
אינדקס של הקישור הראשון למשתמש של WebProperty לצורך אחזור. משתמשים בפרמטר הזה כמנגנון עימוד יחד עם הפרמטר max-results. |
אישור
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/analytics.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.readonly |
גוף הבקשה
אל תספקו גוף הבקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{ "kind": "analytics#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webpropertyUserLinks Resource ] }
שם הנכס | ערך | תיאור | הערות |
---|---|---|---|
kind |
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 User Permissions Developer Guide for details. */ /* * Example #1: * This request lists all Property User Links for the authorized user. */ try { EntityUserLinks propertyLinks = analytics.management(). webPropertyUserLinks().list("123456", "UA-123456-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * Example #2: * The results of the list method are stored in the propertyLinks object. * The following code shows how to iterate through them. */ for (EntityUserLink propertyUserLink : propertyLinks.getItems()) { Entity entity = propertyUserLink.getEntity(); WebPropertyRef webPropertyRef = entity.getWebPropertyRef(); UserRef userRef = propertyUserLink.getUserRef(); Permissions permissions = propertyUserLink.getPermissions(); System.out.println("Property User Link Id: " + propertyUserLink.getId()); System.out.println("Property User Link kind: " + userRef.getKind()); System.out.println("User Email: " + userRef.getEmail()); System.out.println("Permissions effective: " + permissions.getEffective()); System.out.println("Permissions local: " + permissions.getLocal()); System.out.println("Property Id: " + webPropertyRef.getId()); System.out.println("Property Kind: " + webPropertyRef.getKind()); System.out.println("Property Name: " + webPropertyRef.getName()); }
PHP
משתמש בספריית הלקוח של PHP.
/** * Note: This code assumes you have an authorized Analytics service object. * See the User Permissions Developer Guide for details. */ /** * Example #1: * Requests a list of all property user links for the authorized user. */ try { $propertyUserlinks = $analytics->management_webpropertyUserLinks ->listManagementwebpropertyUserLinks('123456', 'UA-123456-1'); } 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: * The results of the list method are stored in the propertyUserlinks object. * The following code shows how to iterate through them. */ foreach ($propertyUserlinks->getItems() as $propertyUserLink) { $entity = $propertyUserLink->getEntity(); $propertyeRef = $entity->getWebPropertyRef(); $userRef = $propertyUserLink->getUserRef(); $permissions = $propertyUserLink->getPermissions(); $html = <<<HTML <pre> Property user link id = {$propertyUserLink->getId()} Property user link kind = {$propertyUserLink->getKind()} Property id = {$propertyeRef->getId()} Property name = {$propertyeRef->getName()} Property kind = {$propertyeRef->getKind()} Permissions local = {$permissions->getLocal()} Permissions effective = {$permissions->getEffective()} User id = {$userRef->getId()} User kind = {$userRef->getKind()} user email = {$userRef->getEmail()} </pre> HTML; print $html; }
Python
משתמש בספריית הלקוח של Python.
# Note: This code assumes you have an authorized Analytics service object. # See the User Permissions Developer Guide for details. # Example #1: # Requests a list of all property user links for the authorized user. try: property_links = analytics.management().webpropertyUserLinks().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)) # Example #2: # The results of the list method are stored in the property_links object. # The following code shows how to iterate through them. for propertyUserLink in property_links.get('items', []): entity = propertyUserLink.get('entity', {}) propertyRef = entity.get('webPropertyRef', {}) userRef = propertyUserLink.get('userRef', {}) permissions = propertyUserLink.get('permissions', {}) print 'Property User Link Id = %s' % propertyUserLink.get('id') print 'Property User Link Kind = %s' % propertyUserLink.get('kind') print 'User Email = %s' % userRef.get('email') print 'Permissions effective = %s' % permissions.get('effective') print 'Permissions local = %s' % permissions.get('local') print 'Property Id = %s' % propertyRef.get('id') print 'Property kind = %s' % propertyRef.get('kind') print 'Property Name = %s\n' % propertyRef.get('name')
JavaScript
נעשה שימוש בספריית הלקוח של JavaScript.
/* * Note: This code assumes you have an authorized Analytics client object. * See the User Permissions Developer Guide for details. */ /* * Example 1: * Requests a list of all Property User links for the authorized user. */ function listProfileUserLinks() { var request = gapi.client.analytics.management.webpropertyUserLinks.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printPropertyUserLinks); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printPropertyUserLinks(results) { if (results && !results.error) { var propertyLinks = results.items; for (var i = 0, userLink; userLink = propertyLinks[i]; i++) { var entity = userLink.entity; var propertyRef = entity.webPropertyRef; var userRef = userLink.userRef; var permissions = userLink.permissions; console.log('Property User Link Id: ' + userLink.id); console.log('Property User Link Kind: ' + userLink.kind); console.log('User Email: ' + userRef.email); console.log('Permissions effective: ' + permissions.effective); console.log('Permissions local: ' + permissions.local); console.log('Property Id: ' + propertyRef.id); console.log('Property Kind: ' + propertyRef.kind); console.log('Property Name: ' + propertyRef.name); } } }
רוצה לנסות?
צריך להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר לנסות את ה-Explorer העצמאי.