ต้องมีการให้สิทธิ์
แสดงรายการลิงก์ผู้ใช้ webProperty สำหรับเว็บพร็อพเพอร์ตี้ที่ระบุ ลองใช้เลยหรือดูตัวอย่าง
นอกเหนือจากพารามิเตอร์มาตรฐาน เมธอดนี้ยังรองรับพารามิเตอร์ที่แสดงในตารางพารามิเตอร์ด้วย
ส่งคำขอ
คำขอ 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 |
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์อย่างน้อย 1 ขอบเขตต่อไปนี้ (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
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 ] }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
kind |
string |
ประเภทคอลเล็กชัน | |
totalResults |
integer |
จำนวนผลลัพธ์ทั้งหมดสำหรับข้อความค้นหา โดยไม่คำนึงถึงจำนวนผลลัพธ์ในการตอบกลับ | |
startIndex |
integer |
ดัชนีเริ่มต้นของรายการ ซึ่งจะเป็น 1 โดยค่าเริ่มต้น หรือระบุโดยพารามิเตอร์การค้นหาของดัชนีเริ่มต้น | |
itemsPerPage |
integer |
จำนวนรายการสูงสุดที่การตอบกลับมีได้ โดยไม่คำนึงถึงจำนวนรายการจริงที่ส่งกลับมา ค่าอยู่ในช่วง 1 ถึง 1000 โดยมีค่า 1000 โดยค่าเริ่มต้น หรือมีการระบุโดยพารามิเตอร์การค้นหาผลลัพธ์สูงสุด | |
previousLink |
string |
ลิงก์ก่อนหน้าสำหรับคอลเล็กชันบัญชีนี้ | |
nextLink |
string |
ลิงก์ถัดไปสำหรับคอลเล็กชันบัญชีนี้ | |
items[] |
list |
รายการลิงก์ผู้ใช้ของเอนทิตี |
ตัวอย่าง
หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)
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
/** * 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
# 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); } } }
ลองใช้เลย
ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้ในข้อมูลสดและดูการตอบสนอง หรือลองใช้เครื่องมือสำรวจแบบสแตนด์อโลน