Views (Profiles): list

مطلوب تفويض

يعرض الملفات الشخصية (الملفات الشخصية) التي يمكن للمستخدم الدخول إليها. جرِّب ذلك الآن أو اطّلِع على مثال.

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

طلب

طلب HTTP

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

المَعلمات

اسم المعلَمة القيمة الوصف
معلّمات المسار
accountId string رقم تعريف الحساب للملف الشخصي المطلوب استرداده (الملفات الشخصية). يمكن أن يكون رقم تعريف حسابًا معيّنًا أو &#39؛~all&#39؛ والذي يشير إلى جميع الحسابات التي يمكن للمستخدم الوصول إليها.
webPropertyId 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

نص الطلب

لا توفِّر نص طلب بهذه الطريقة.

الإجابة

تحتوي الاستجابة على مورد واحد لكل ملف شخصي مطلوب

{
  "kind": "analytics#profiles",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.profiles Resource
  ]
}
اسم الموقع القيمة الوصف ملاحظات
kind string نوع المجموعةالقيمة هي "analytics;profiles".
username string رقم تعريف البريد الإلكتروني للمستخدم الذي تمت المصادقة عليه
totalResults integer إجمالي عدد نتائج طلب البحث، بغض النظر عن عدد النتائج في الاستجابة.
startIndex integer فهرس البداية للموارد، وهو تلقائيًا 1 أو المُحدَّدة في معلَمة طلب البحث لفهرس البدء.
itemsPerPage integer الحد الأقصى لعدد الموارد التي يمكن أن تحتوي عليها الاستجابة، بغض النظر عن العدد الفعلي للموارد المعروضة. وتتراوح قيمتها بين 1 و1000 مع قيمة 1000 تلقائيًا، أو كما هو محدّد من خلال مَعلمة طلب البحث لتحقيق الحد الأقصى من النتائج.
items[] list قائمة بالملفات الشخصية (الملفات الشخصية).

أمثلة

ملاحظة: إنّ الأمثلة المرتبطة بالرموز والمتوفرة لهذه الطريقة لا تمثّل كل لغات البرمجة المتوافقة (يُرجى مراجعة صفحة مكتبات البرامج للاطّلاع على قائمة باللغات المتوافقة).

Java

يستخدم مكتبة برامج Java.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the View (Profile) Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  Profiles profiles = analytics.management.profiles.list("12345",
      "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * Example #2:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
Profiles profiles = analytics.management.profiles.list("12345",
    "~all").execute();


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
for (Profile profile : profiles.getItems()) {
  System.out.println("Account ID: " + profile.getAccountId());
  System.out.println("Property ID: " + profile.getWebPropertyId());
  System.out.println("Property Internal ID: "
      + profile.getInternalWebPropertyId());
  System.out.println("View (Profile) ID: " + profile.getId());
  System.out.println("View (Profile) Name: " + profile.getName());
  System.out.println("View (Profile) defaultPage: " + profile.getDefaultPage());
  System.out.println("View (Profile) Exclude Query Parameters: "
      + profile.getExcludeQueryParameters());
  System.out.println("View (Profile) Site Search Query Parameters: "
      + profile.getSiteSearchQueryParameters());
  System.out.println("View (Profile) Site Search Category Parameters: "
      + profile.getSiteSearchCategoryParameters());
  System.out.println("View (Profile) Currency: " + profile.getCurrency());
  System.out.println("View (Profile) Timezone: " + profile.getTimezone());
  System.out.println("View (Profile) Created: " + profile.getCreated());
  System.out.println("View (Profile) Updated: " + profile.getUpdated());
  System.out.println("View (Profile) eCommerce Tracking: "
      + profile.getECommerceTracking());
  System.out.println("View (Profile) Enhanced eCommerce Tracking: "
      + profile.getEnhancedECommerceTracking());
}

PHP

استخدام مكتبة برامج PHP.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the View (Profile) Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  $profiles = $analytics->management_profiles
      ->listManagementProfiles('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:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
$profiles = $analytics->management_profiles
    ->listManagementProfiles('123456', '~all');


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
foreach ($profiles->getItems() as $profile) {
  $html = <<<HTML
<pre>
Account id                      = {$profile->getAccountId()}
Property id                     = {$profile->getWebPropertyId()}
View (Profile) id               = {$profile->getId()}
View (Profile) name             = {$profile->getName()}
View (Profile) type             = {$profile->getType()}
Default page                    = {$profile->getDefaultPage()}
Exclude query parameters        = {$profile->getExcludeQueryParameters()}
Site search category parameters = {$profile->getSiteSearchCategoryParameters()}
Currency                        = {$profile->getCurrency()}
Timezone                        = {$profile->getTimezone()}
Created                         = {$profile->getCreated()}
Updated                         = {$profile->getUpdated()}
eCommerce tracking              = {$profile->getECommerceTracking()}
Enhanced eCommerce Tracking     = {$profile->getEnhancedECommerceTracking()}
</pre>
HTML;
  print $html;
}

Python

استخدام مكتبة برامج Python.

# Note: This code assumes you have an authorized Analytics service object.
# See the View (Profile) Developer Guide for details.

# Example #1:
# Requests a list of views (profiles) for the authorized user.
try:
  profiles = analytics.management().profiles().list(
      accountId='12345',
      webPropertyId='UA-12345-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:
# Retrieves views (profiles) for all properties of the user's account,
# using a wildcard '~all' as the webpropertyId.
profiles = analytics.management().profiles().list(accountId='12345',
                                                  webPropertyId='~all'
                                                 ).execute()

# Example #3:
# The results of the list method are stored in the profiles object.
# The following code shows how to iterate through them.
for profile in profiles.get('items', []):
  print 'Account ID                = %s' % profile.get('accountId')
  print 'Property ID           = %s' % profile.get('webPropertyId')
  print 'Internal Property ID  = %s' % profile.get('internalWebPropertyId')
  print 'View (Profile ID)         = %s' % profile.get('id')
  print 'View (Profile) Name       = %s' % profile.get('name')

  print 'Default Page = %s' %  profile.get('defaultPage')
  print 'Exclude Query Parameters        = %s' % profile.get(
      'excludeQueryParameters')
  print 'Site Search Category Parameters = %s' % profile.get(
      'siteSearchCategoryParameters')
  print 'Site Search Query Parameters    = %s' % profile.get(
      'siteSearchQueryParameters')

  print 'Currency = %s' % profile.get('currency')
  print 'Timezone = %s' % profile.get('timezone')
  print 'Created  = %s' % profile.get('created')
  print 'Updated  = %s' % profile.get('updated')
  print 'eCommerce Tracking = %s' % profile.get('eCommerceTracking')
  print 'Enhanced eCommerce Tracking = %s' % profile.get(
      'enhancedECommerceTracking')

JavaScript

استخدام مكتبة عميل JavaScript.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the View (Profiles) Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all View (Profiles) for the authorized user.
 */
function listViews() {
  var request = gapi.client.analytics.management.profiles.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1'
  });
  request.execute(printViews);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printViews(results) {
  if (results && !results.error) {
    var profiles = results.items;
    for (var i = 0, profile; profile = profiles[i]; i++) {
      console.log('Account Id: ' + profile.accountId);
      console.log('Property Id: ' + profile.webPropertyId);
      console.log('Internal Property Id: ' + profile.internalWebPropertyId);
      console.log('View (Profile) Id: ' + profile.id);
      console.log('View (Profile) Name: ' + profile.name);

      console.log('Default Page: ' + profile.defaultPage);
      console.log('Exclude Query Parameters: '
          + profile.excludeQueryParameters);
      console.log('Site Search Category Parameters'
          + profile.siteSearchCategoryParameters);
      console.log('Site Search Query Parameters: '
          + profile.siteSearchQueryParameters);

      console.log('Currency: ' + profile.currency);
      console.log('Timezone: ' + profile.timezone);
      console.log('Created: ' + profile.created);
      console.log('Updated: ' + profile.updated);
    }
  }
}

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

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