List
|
|||||
|
|
||||
Lists segments to which the user has access
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your Google Analytics data
- Edit Google Analytics management entities
- View your Google Analytics data
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
max-results |
INTEGER |
The maximum number of segments to include in this response |
start-index |
INTEGER |
An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
= Parameter name
= Format
|
max-results INTEGER The maximum number of segments to include in this response |
|
start-index INTEGER An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 17 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics segment |
items[].created |
DATE_TIME |
Time the segment was created |
items[].definition |
STRING |
Segment definition |
items[].id |
STRING |
Segment ID |
items[].kind |
STRING |
Resource type for Analytics segment |
items[].name |
STRING |
Segment name |
items[].segmentId |
STRING |
Segment ID. Can be used with the 'segment' parameter in Core Reporting API |
items[].selfLink |
STRING |
Link for this segment |
items[].type |
STRING |
Type for a segment. Possible values are "BUILT_IN" or "CUSTOM" |
items[].updated |
DATE_TIME |
Time the segment was last modified |
itemsPerPage |
INTEGER |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter |
kind |
STRING |
Collection type for segments |
nextLink |
STRING |
Link to next page for this segment collection |
previousLink |
STRING |
Link to previous page for this segment collection |
startIndex |
INTEGER |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter |
totalResults |
INTEGER |
The total number of results for the query, regardless of the number of results in the response |
username |
STRING |
Email ID of the authenticated user |
= Parameter name
= Format
|
items[] OBJECT JSON template for an Analytics segment |
|
items[].created DATE_TIME Time the segment was created |
|
items[].definition STRING Segment definition |
|
items[].id STRING Segment ID |
|
items[].kind STRING Resource type for Analytics segment |
|
items[].name STRING Segment name |
|
items[].segmentId STRING Segment ID. Can be used with the 'segment' parameter in Core Reporting API |
|
items[].selfLink STRING Link for this segment |
|
items[].type STRING Type for a segment. Possible values are "BUILT_IN" or "CUSTOM" |
|
items[].updated DATE_TIME Time the segment was last modified |
|
itemsPerPage INTEGER The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter |
|
kind STRING Collection type for segments |
|
nextLink STRING Link to next page for this segment collection |
|
previousLink STRING Link to previous page for this segment collection |
|
startIndex INTEGER The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter |
|
totalResults INTEGER The total number of results for the query, regardless of the number of results in the response |
|
username STRING Email ID of the authenticated user |