Webproperty User Links: list

إذا كانت الحسابات أو المواقع أو الملفات الشخصية على "إحصاءات Google" تنتمي إلى مؤسسة، يمكن لمالكي تلك المؤسسة تعديل المستخدمين في تلك الحسابات. أمّا واجهة Management API، فلا تُدرِج سوى الأعضاء الفاضحين في "الحسابات" أو "المواقع الإلكترونية" أو "الملفات الشخصية"، وليس في المؤسسة أو مالكيها.

يجب تقديم تفويض.

يسرد روابط مستخدمي موقع الويب لموقع إلكتروني معيّن. جرِّبه الآن أو اطّلِع على مثال.

وبالإضافة إلى المَعلمات العادية، تتيح هذه الطريقة استخدام المَعلمات المدرَجة في جدول المَعلمات.

الطلب

طلب HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityUserLinks

المَعلمات

اسم المعلَمة	القيمة	الوصف
مَعلمات المسار
accountId	string	رقم تعريف الحساب الذي ينتمي إليه الموقع الإلكتروني المحدّد.
webPropertyId	string	رقم تعريف الموقع الإلكتروني لروابط مستخدم موقع الويب المطلوب استردادها. يمكن أن يكون معرّف موقع إلكتروني محدّد أو "الكل تقريبًا"، ما يشير إلى جميع المواقع الإلكترونية التي يمكن للمستخدِم الوصول إليها.
مَعلمات طلب البحث الاختيارية
max-results	integer	الحد الأقصى لعدد روابط مستخدمي موقع الويب المطلوب تضمينها في هذا الرد.
start-index	integer	فهرس لرابط مستخدم موقع الويب الأول المطلوب استرداده. يمكنك استخدام هذه المَعلمة كآلية تقسيم على صفحات إلى جانب المَعلمة 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
  ]
}

اسم الموقع	القيمة	الوصف	Notes
kind	string	نوع المجموعة
totalResults	integer	إجمالي عدد النتائج لطلب البحث، بغض النظر عن عدد النتائج في الرد.
startIndex	integer	فهرس البداية للإدخالات، وهو 1 تلقائيًا أو يتم تحديده من خلال مَعلمة طلب البحث الخاصة بفهرس Start-index.
itemsPerPage	integer	الحد الأقصى لعدد الإدخالات التي يمكن أن يحتوي عليها الرد، بغض النظر عن العدد الفعلي للإدخالات التي تم عرضها. تتراوح قيمتها من 1 إلى 1000 مع قيمة تبلغ 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);
    }
  }
}

تجربة

استخدِم مستكشف واجهات برمجة التطبيقات أدناه لطلب هذه الطريقة على البيانات المباشرة والاطّلاع على الردّ. ويمكنك بدلاً من ذلك تجربة المستكشف المستقل.