نیاز به مجوز دارد
ویژگی هایی را که کاربر به آنها دسترسی دارد فهرست می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .
علاوه بر پارامترهای استاندارد ، این روش از پارامترهای فهرست شده در جدول پارامترها پشتیبانی می کند.
درخواست
درخواست HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای مسیر | ||
accountId | 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 |
درخواست بدن
با این روش بدنه درخواستی ارائه نکنید.
واکنش
پاسخ شامل یک منبع Webproperty برای هر ویژگی وب Analytics درخواست شده است.
{ "kind": "analytics#webproperties", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webproperties Resource ] }
نام ملک | ارزش | شرح | یادداشت |
---|---|---|---|
kind | string | نوع مجموعه مقدار " analytics#webProperties " است. | |
username | string | شناسه ایمیل کاربر احراز هویت شده | |
totalResults | integer | تعداد کل نتایج برای پرس و جو، صرف نظر از تعداد نتایج در پاسخ. | |
startIndex | integer | شاخص شروع منابع که به طور پیشفرض 1 است یا توسط پارامتر جستجوی start-index مشخص میشود. | |
itemsPerPage | integer | حداکثر تعداد منابعی که پاسخ می تواند داشته باشد، صرف نظر از تعداد واقعی منابع برگشتی. مقدار آن از 1 تا 1000 با مقدار 1000 به طور پیش فرض متغیر است، یا در غیر این صورت توسط پارامتر پرس و جو max-results | |
previousLink | string | پیوند به صفحه قبلی برای این مجموعه دارایی وب. | |
nextLink | string | پیوند به صفحه بعدی این مجموعه دارایی وب. | |
items[] | list | لیستی از خواص وب |
مثال ها
توجه: نمونههای کد موجود برای این روش همه زبانهای برنامهنویسی پشتیبانیشده را نشان نمیدهند (برای فهرست زبانهای پشتیبانیشده به صفحه کتابخانههای سرویس گیرنده مراجعه کنید).
جاوا
از کتابخانه سرویس گیرنده جاوا استفاده می کند.
/** * Note: This code assumes you have an authorized Analytics service object. * See the Web Property Developer Guide for details. */ /** * Example #1: * Requests a list of all properties for the authorized user. */ try { Webproperties properties = analytics.management. webproperties.list("12345").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * Example #2: * Retrieves all properties for the user's account, using a * wildcard '~all' as the accountId. */ Webproperties properties = analytics.management. webproperties.list("~all").execute(); /** * Example #3: * The results of the list method are stored in the properties object. * The following code shows how to iterate through them. */ for (Webproperty property : properties.getItems()) { System.out.println("Account ID: " + property.getAccountId()); System.out.println("Property ID: " + property.getId()); System.out.println("Property Name: " + property.getName()); System.out.println("Property Profile Count: " + property.getProfileCount()); System.out.println("Property Industry Vertical: " + property.getIndustryVertical()); System.out.println("Property Internal Id: " + property.getInternalWebPropertyId()); System.out.println("Property Level: " + property.getLevel(); if (property.getWebsiteUrl() != null) { System.out.println("Property URL: " + property.getWebsiteUrl()); } System.out.println("Property Created: " + property.getCreated()); System.out.println("Property Updated: " + property.getUpdated()); }
PHP
از کتابخانه مشتری PHP استفاده می کند.
/** * Note: This code assumes you have an authorized Analytics service object. * See the Web Property Developer Guide for details. */ /** * Example #1: * Requests a list of all properties for the authorized user. */ try { $properties = $analytics->management_webproperties ->listManagementWebproperties('123456'); } 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 all properties for the user's account, using a * wildcard ~all as the accountId. */ $properties = $analytics->management_webproperties ->listManagementWebproperties('~all'); /** * Example #3: * The results of the list method are stored in the properties object. * The following code shows how to iterate through them. */ foreach ($properties->getItems() as $property) { $html = <<<HTML <pre> Account id = {$property->getAccountId()} Property id = {$property->getId()} Property name = {$property->getName()} Property URL = {$property->getWebsiteUrl()} Created = {$property->getCreated()} Updated = {$property->getUpdated()} </pre> HTML; print $html; }
پایتون
از کتابخانه کلاینت پایتون استفاده می کند.
# Note: This code assumes you have an authorized Analytics service object. # See the Web Property Developer Guide for details. # Example #1: # Requests a list of all properties for the authorized user. try: properties = analytics.management().webproperties().list( accountId='12345').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 all properties for the user's account, using a # wildcard ~all as the accountId. properties = service.management().webproperties().list( accountId='~all').execute() # Example #3: # The results of the list method are stored in the webproperties object. # The following code shows how to iterate through them. for property in properties.get('items', []): print 'Account ID = %s' % property.get('accountId') print 'Property ID = %s' % property.get('id') print 'Property Name = %s' % property.get('name') print 'Property Profile Count = %s' % property.get('profileCount') print 'Property Industry Vertical = %s' % property.get('industryVertical') print 'Property Internal Id = %s' % property.get( 'internalWebPropertyId') print 'Property Level = %s' % property.get('level') if property.get('websiteUrl'): print 'Property URL = %s' % property.get('websiteUrl') print 'Created = %s' % property.get('created') print 'Updated = %s' % property.get('updated')
جاوا اسکریپت
از کتابخانه سرویس گیرنده جاوا اسکریپت استفاده می کند.
/* * Note: This code assumes you have an authorized Analytics client object. * See the Web Property Developer Guide for details. */ /* * Example 1: * Requests a list of all properties for the authorized user. */ function listProperties() { var request = gapi.client.analytics.management.webproperties.list({ 'accountId': '123456' }); request.execute(printProperties); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printProperties(results) { if (results && !results.error) { var properties = results.items; for (var i = 0, property; property = properties[i]; i++) { console.log('Account Id: ' + property.accountId); console.log('Property Id: ' + property.id); console.log('Property Name: ' + property.name); console.log('Property Profile Count: ' + property.profileCount); console.log('Property Industry Vertical: ' + property.industryVertical); console.log('Property Internal Id: ' + property.internalWebPropertyId); console.log('Property Level: ' + property.level); if (property.websiteUrl) { console.log('Property URL: ' + property.websiteUrl); } console.log('Created: ' + property.created); console.log('Updated: ' + property.updated); } } }
آن را امتحان کنید!
از APIs Explorer زیر برای فراخوانی این روش در دادههای زنده و دیدن پاسخ استفاده کنید. از طرف دیگر، اکسپلورر مستقل را امتحان کنید.