Webproperty User Links: list

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

مطلوب تفويض

يسرد روابط webProperty-user لموقع ويب معيّن. جرِّب ذلك الآن أو اطّلِع على مثال.

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

طلب

طلب HTTP

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

المَعلمات

اسم المعلَمة	القيمة	الوصف
معلّمات المسار
accountId	string	رقم تعريف الحساب الذي ينتمي إليه الموقع الإلكتروني.
webPropertyId	string	معرّف الموقع الإلكتروني لروابط webProperty-user لاسترداده. يمكن أن يكون معرّف موقع إلكتروني معيّن أو '~all'، والذي يشير إلى جميع مواقع الويب التي يمكن للمستخدم الوصول إليها.
معلَمات طلب البحث الاختيارية
max-results	integer	الحد الأقصى لعدد روابط webProperty-user التي سيتم تضمينها في هذه الاستجابة.
start-index	integer	فهرس لرابط WebProperty-user الأول لاسترداده. استخدِم هذه المعلّمة كآلية للتقسيم على صفحات إلى جانب المعلّمة 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	فهرس البداية للإدخالات، ويكون واحدًا تلقائيًا أو محدَّدًا حسب معلَمة طلب البحث لفهرس البدء.
itemsPerPage	integer	الحد الأقصى لعدد الإدخالات التي يمكن أن تحتوي عليها الاستجابة، بغض النظر عن العدد الفعلي للإدخالات التي تم عرضها. وتتراوح قيمتها بين 1 و1000 مع قيمة 1000 تلقائيًا، أو كما هو محدّد من خلال مَعلمة طلب البحث لتحقيق الحد الأقصى من النتائج.
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);
    }
  }
}

جرِّب هذه الميزة الآن.

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