نیاز به مجوز دارد
نماها (پروفایل) را که کاربر به آنها دسترسی دارد فهرست می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .
علاوه بر پارامترهای استاندارد ، این روش از پارامترهای فهرست شده در جدول پارامترها پشتیبانی می کند.
درخواست
درخواست 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 | نوع مجموعه مقدار "تحلیل #پروفایل" است. | |
username | string | شناسه ایمیل کاربر احراز هویت شده | |
totalResults | integer | تعداد کل نتایج برای پرس و جو، صرف نظر از تعداد نتایج در پاسخ. | |
startIndex | integer | شاخص شروع منابع که به طور پیشفرض 1 است یا توسط پارامتر جستجوی start-index مشخص میشود. | |
itemsPerPage | integer | حداکثر تعداد منابعی که پاسخ می تواند داشته باشد، صرف نظر از تعداد واقعی منابع برگشتی. مقدار آن از 1 تا 1000 با مقدار 1000 به طور پیش فرض متغیر است، یا در غیر این صورت توسط پارامتر query max-results مشخص شده است. | |
previousLink | string | پیوند به صفحه قبلی برای این مجموعه نمایش (نمایه). | |
nextLink | string | پیوند به صفحه بعدی برای این مجموعه نمایش (نمایه). | |
items[] | list | لیستی از بازدیدها (پروفایل). |
مثال ها
توجه: نمونههای کد موجود برای این روش همه زبانهای برنامهنویسی پشتیبانیشده را نشان نمیدهند (برای فهرست زبانهای پشتیبانیشده به صفحه کتابخانههای سرویس گیرنده مراجعه کنید).
جاوا
از کتابخانه سرویس گیرنده جاوا استفاده می کند.
/** * 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; }
پایتون
از کتابخانه کلاینت پایتون استفاده می کند.
# 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')
جاوا اسکریپت
از کتابخانه سرویس گیرنده جاوا اسکریپت استفاده می کند.
/* * 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 زیر برای فراخوانی این روش در دادههای زنده و دیدن پاسخ استفاده کنید. از طرف دیگر، اکسپلورر مستقل را امتحان کنید.