Views (Profiles): list

נדרשת הרשאה

בתיבת הדו-שיח הזו מפורטים תצוגות (פרופילים) שלמשתמש יש גישה אליהן. אפשר לנסות עכשיו או לראות דוגמה.

בנוסף לפרמטרים הרגילים, השיטה הזו תומכת בפרמטרים המפורטים בטבלת הפרמטרים.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים של נתיב
`accountId`	`string`	מספר החשבון של התצוגה המפורטת (הפרופילים) שצריך לאחזר. יכול להיות מספר חשבון ספציפי או '~all', שמתייחס לכל החשבונות שאליהם למשתמש יש גישה.
`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 כברירת מחדל או שצוין אחרת על ידי פרמטר השאילתה 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 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);
    }
  }
}

רוצה לנסות?

צריך להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר לנסות את ה-Explorer העצמאי.