نیاز به مجوز دارد
بخش هایی را که کاربر به آنها دسترسی دارد فهرست می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .
علاوه بر پارامترهای استاندارد ، این روش از پارامترهای فهرست شده در جدول پارامترها پشتیبانی می کند.
درخواست
درخواست HTTP
GET https://www.googleapis.com/analytics/v3/management/segments
مولفه های
نام پارامتر | ارزش | شرح |
---|---|---|
پارامترهای پرس و جو اختیاری | ||
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#segments", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.segments 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 | لیستی از بخش ها |
مثال ها
توجه: نمونههای کد موجود برای این روش همه زبانهای برنامهنویسی پشتیبانیشده را نشان نمیدهند (برای فهرست زبانهای پشتیبانیشده به صفحه کتابخانههای سرویس گیرنده مراجعه کنید).
PHP
از کتابخانه مشتری PHP استفاده می کند.
/** * Note: This code assumes you have an authorized Analytics service object. * See the Segments Developer Guide for details. */ /** * Example #1: * Requests a list of all Segments for the authorized user. */ try { $segments = $analytics->management_segments->listManagementSegments(); } 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 segments object. * The following code shows how to iterate through them. */ foreach ($segments->getItems() as $segment) { $html .= <<<HTML <pre> Segment ID = {$segment->getId()} Kind = {$segment->getKind()} Self Link = {$segment->getSelfLink()} Name = {$segment->getName()} Definition = {$segment->getDefinition()} Created = {$segment->getCreated()} Updated = {$segment->getUpdated()} </pre> HTML; print $html; }
پایتون
از کتابخانه کلاینت پایتون استفاده می کند.
# Note: This code assumes you have an authorized Analytics service object. # See the Segments Developer Guide for details. # Example #1: # Requests a list of segments to which the user has access. try: segments = analytics.management().segments().list().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 segments object. # The following code shows how to iterate through them. for segment in segments.get('items', []): print 'Segment Id = %s' % segment.get('id') print 'Segment kind = %s' % segment.get('kind') print 'Segment segmentId = %s' % segment.get('segmentId') print 'Segment Name = %s' % segment.get('name') print 'Segment Definition = %s' % segment.get('definition') if segment.get('created'): print 'Created = %s' % segment.get('created') print 'Updated = %s' % segment.get('updated') print
جاوا اسکریپت
از کتابخانه سرویس گیرنده جاوا اسکریپت استفاده می کند.
/* * Note: This code assumes you have an authorized Analytics client object. * See the Segment Developer Guide for details. */ /* * Example 1: * Requests a list of all Segments for the authorized user. */ function listSegments() { var request = gapi.client.analytics.management.segments.list(); request.execute(printSegments); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printSegments(results) { if (results && !results.error) { var segments = results.items; for (var i = 0, segment; segment = segments[i]; i++) { console.log('Segment Id: ' + segment.id); console.log('Segment Kind: ' + segment.kind); console.log('Segment Name: ' + segment.name); console.log('Segment Definition: ' + segment.definition); // These fields are only set for custom segments and not default segments. if (segment.created) { console.log('Created: ' + segment.created); console.log('Updated: ' + segment.updated); } } } }
آن را امتحان کنید!
از APIs Explorer زیر برای فراخوانی این روش در دادههای زنده و دیدن پاسخ استفاده کنید. از طرف دیگر، اکسپلورر مستقل را امتحان کنید.