API Documentation

Zend/Gdata/Analytics/DataQuery.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Analytics  
Version
$Id$  

\Zend_Gdata_Analytics_DataQuery

Package: Zend\Gdata\Analytics

Parent(s)
\Zend_Gdata_Query
Category
Zend  

Constants

Constant  ANALYTICS_FEED_URI = 'https://www.googleapis.com/analytics/v2.4/data'
Constant  DIMENSION_BROWSER = 'ga:browser'
Constant  DIMENSION_BROWSER_VERSION = 'ga:browserVersion'
Constant  DIMENSION_CITY = 'ga:city'
Constant  DIMENSION_CONNECTIONSPEED = 'ga:connectionSpeed'
Constant  DIMENSION_CONTINENT = 'ga:continent'
Constant  DIMENSION_COUNTRY = 'ga:country'
Constant  DIMENSION_DATE = 'ga:date'
Constant  DIMENSION_DAY = 'ga:day'
Constant  DIMENSION_DAYS_SINCE_LAST_VISIT = 'ga:daysSinceLastVisit'
Constant  DIMENSION_FLASH_VERSION = 'ga:flashVersion'
Constant  DIMENSION_HOSTNAME = 'ga:hostname'
Constant  DIMENSION_HOUR = 'ga:hour'
Constant  DIMENSION_JAVA_ENABLED = 'ga:javaEnabled'
Constant  DIMENSION_LANGUAGE = 'ga:language'
Constant  DIMENSION_LATITUDE = 'ga:latitude'
Constant  DIMENSION_LONGITUDE = 'ga:longitude'
Constant  DIMENSION_MONTH = 'ga:month'
Constant  DIMENSION_NETWORK_DOMAIN = 'ga:networkDomain'
Constant  DIMENSION_NETWORK_LOCATION = 'ga:networkLocation'
Constant  DIMENSION_OPERATING_SYSTEM = 'ga:operatingSystem'
Constant  DIMENSION_OPERATING_SYSTEM_VERSION = 'ga:operatingSystemVersion'
Constant  DIMENSION_PAGE_DEPTH = 'ga:pageDepth'
Constant  DIMENSION_REGION = 'ga:region'
Constant  DIMENSION_SCREEN_COLORS = 'ga:screenColors'
Constant  DIMENSION_SCREEN_RESOLUTION = 'ga:screenResolution'
Constant  DIMENSION_SUB_CONTINENT = 'ga:subContinent'
Constant  DIMENSION_USER_DEFINED_VALUE = 'ga:userDefinedValue'
Constant  DIMENSION_VISIT_COUNT = 'ga:visitCount'
Constant  DIMENSION_VISIT_LENGTH = 'ga:visitLength'
Constant  DIMENSION_VISITOR_TYPE = 'ga:visitorType'
Constant  DIMENSION_WEEK = 'ga:week'
Constant  DIMENSION_YEAR = 'ga:year'
Constant  DIMENSION_AD_CONTENT = 'ga:adContent'
Constant  DIMENSION_AD_GROUP = 'ga:adGroup'
Constant  DIMENSION_AD_SLOT = 'ga:adSlot'
Constant  DIMENSION_AD_SLOT_POSITION = 'ga:adSlotPosition'
Constant  DIMENSION_CAMPAIGN = 'ga:campaign'
Constant  DIMENSION_KEYWORD = 'ga:keyword'
Constant  DIMENSION_MEDIUM = 'ga:medium'
Constant  DIMENSION_REFERRAL_PATH = 'ga:referralPath'
Constant  DIMENSION_SOURCE = 'ga:source'
Constant  DIMENSION_EXIT_PAGE_PATH = 'ga:exitPagePath'
Constant  DIMENSION_LANDING_PAGE_PATH = 'ga:landingPagePath'
Constant  DIMENSION_PAGE_PATH = 'ga:pagePath'
Constant  DIMENSION_PAGE_TITLE = 'ga:pageTitle'
Constant  DIMENSION_SECOND_PAGE_PATH = 'ga:secondPagePath'
Constant  DIMENSION_AFFILIATION = 'ga:affiliation'
Constant  DIMENSION_DAYS_TO_TRANSACTION = 'ga:daysToTransaction'
Constant  DIMENSION_PRODUCT_CATEGORY = 'ga:productCategory'
Constant  DIMENSION_PRODUCT_NAME = 'ga:productName'
Constant  DIMENSION_PRODUCT_SKU = 'ga:productSku'
Constant  DIMENSION_TRANSACTION_ID = 'ga:transactionId'
Constant  DIMENSION_VISITS_TO_TRANSACTION = 'ga:visitsToTransaction'
Constant  DIMENSION_SEARCH_CATEGORY = 'ga:searchCategory'
Constant  DIMENSION_SEARCH_DESTINATION_PAGE = 'ga:searchDestinationPage'
Constant  DIMENSION_SEARCH_KEYWORD = 'ga:searchKeyword'
Constant  DIMENSION_SEARCH_KEYWORD_REFINEMENT = 'ga:searchKeywordRefinement'
Constant  DIMENSION_SEARCH_START_PAGE = 'ga:searchStartPage'
Constant  DIMENSION_SEARCH_USED = 'ga:searchUsed'
Constant  DIMENSION_NEXT_PAGE_PATH = 'ga:nextPagePath'
Constant  DIMENSION_PREV_PAGE_PATH = 'ga:previousPagePath'
Constant  DIMENSION_EVENT_CATEGORY = 'ga:eventCategory'
Constant  DIMENSION_EVENT_ACTION = 'ga:eventAction'
Constant  DIMENSION_EVENT_LABEL = 'ga:eventLabel'
Constant  DIMENSION_CUSTOM_VAR_NAME_1 = 'ga:customVarName1'
Constant  DIMENSION_CUSTOM_VAR_NAME_2 = 'ga:customVarName2'
Constant  DIMENSION_CUSTOM_VAR_NAME_3 = 'ga:customVarName3'
Constant  DIMENSION_CUSTOM_VAR_NAME_4 = 'ga:customVarName4'
Constant  DIMENSION_CUSTOM_VAR_NAME_5 = 'ga:customVarName5'
Constant  DIMENSION_CUSTOM_VAR_VALUE_1 = 'ga:customVarValue1'
Constant  DIMENSION_CUSTOM_VAR_VALUE_2 = 'ga:customVarValue2'
Constant  DIMENSION_CUSTOM_VAR_VALUE_3 = 'ga:customVarValue3'
Constant  DIMENSION_CUSTOM_VAR_VALUE_4 = 'ga:customVarValue4'
Constant  DIMENSION_CUSTOM_VAR_VALUE_5 = 'ga:customVarValue5'
Constant  METRIC_BOUNCES = 'ga:bounces'
Constant  METRIC_ENTRANCES = 'ga:entrances'
Constant  METRIC_EXITS = 'ga:exits'
Constant  METRIC_NEW_VISITS = 'ga:newVisits'
Constant  METRIC_PAGEVIEWS = 'ga:pageviews'
Constant  METRIC_TIME_ON_PAGE = 'ga:timeOnPage'
Constant  METRIC_TIME_ON_SITE = 'ga:timeOnSite'
Constant  METRIC_VISITORS = 'ga:visitors'
Constant  METRIC_VISITS = 'ga:visits'
Constant  METRIC_AD_CLICKS = 'ga:adClicks'
Constant  METRIC_AD_COST = 'ga:adCost'
Constant  METRIC_CPC = 'ga:CPC'
Constant  METRIC_CPM = 'ga:CPM'
Constant  METRIC_CTR = 'ga:CTR'
Constant  METRIC_IMPRESSIONS = 'ga:impressions'
Constant  METRIC_UNIQUE_PAGEVIEWS = 'ga:uniquePageviews'
Constant  METRIC_ITEM_REVENUE = 'ga:itemRevenue'
Constant  METRIC_ITEM_QUANTITY = 'ga:itemQuantity'
Constant  METRIC_TRANSACTIONS = 'ga:transactions'
Constant  METRIC_TRANSACTION_REVENUE = 'ga:transactionRevenue'
Constant  METRIC_TRANSACTION_SHIPPING = 'ga:transactionShipping'
Constant  METRIC_TRANSACTION_TAX = 'ga:transactionTax'
Constant  METRIC_UNIQUE_PURCHASES = 'ga:uniquePurchases'
Constant  METRIC_SEARCH_DEPTH = 'ga:searchDepth'
Constant  METRIC_SEARCH_DURATION = 'ga:searchDuration'
Constant  METRIC_SEARCH_EXITS = 'ga:searchExits'
Constant  METRIC_SEARCH_REFINEMENTS = 'ga:searchRefinements'
Constant  METRIC_SEARCH_UNIQUES = 'ga:searchUniques'
Constant  METRIC_SEARCH_VISIT = 'ga:searchVisits'
Constant  METRIC_GOAL_COMPLETIONS_ALL = 'ga:goalCompletionsAll'
Constant  METRIC_GOAL_STARTS_ALL = 'ga:goalStartsAll'
Constant  METRIC_GOAL_VALUE_ALL = 'ga:goalValueAll'
Constant  METRIC_GOAL_1_COMPLETION = 'ga:goal1Completions'
Constant  METRIC_GOAL_1_STARTS = 'ga:goal1Starts'
Constant  METRIC_GOAL_1_VALUE = 'ga:goal1Value'
Constant  METRIC_TOTAL_EVENTS = 'ga:totalEvents'
Constant  METRIC_UNIQUE_EVENTS = 'ga:uniqueEvents'
Constant  METRIC_EVENT_VALUE = 'ga:eventValue'
Constant  EQUALS = "=="
Constant  EQUALS_NOT = "!="
Constant  GREATER = ">"
Constant  LESS = ">"
Constant  GREATER_EQUAL = ">="
Constant  LESS_EQUAL = "<="
Constant  CONTAINS = "=@"
Constant  CONTAINS_NOT = "!@"
Constant  REGULAR = "=~"
Constant  REGULAR_NOT = "!~"

Properties

Propertyprotected  $_defaultFeedUri= 'self::ANALYTICS_FEED_URI'

The default URI used for feeds.

Default valueself::ANALYTICS_FEED_URIDetails
Type
Propertyprotectedarray  $_dimensions= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_filters= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_metrics= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedstring  $_profileId= ''

Details
Type
string
Propertyprotectedarray  $_sort= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublicaddDimension( string $dimension ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$dimension string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicaddFilter( string $filter ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$filter string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicaddMetric( string $metric ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$metric string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicaddOrFilter( string $filter ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$filter string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicaddSort( string $sort, \boolean[optional] $descending = false ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$sort string
$descending \boolean[optional]
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicclearSort( ) : \Zend_Gdata_Analytics_DataQuery

Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicgetDimensions( ) : array

Returns
Type Description
array
methodpublicgetMetrics( ) : array

Returns
Type Description
array
methodpublicgetProfileId( ) : string

Returns
Type Description
string
methodpublicgetQueryUrl( ) : string

Returns
Type Description
string url
methodpublicremoveDimension( string $dimension ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$dimension string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicremoveMetric( string $metric ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$metric string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicsetEndDate(  $date ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$date
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicsetProfileId( string $id ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$id string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicsetSegment( string $segment ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$segment string
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
methodpublicsetStartDate(  $date ) : \Zend_Gdata_Analytics_DataQuery

Parameters
Name Type Description
$date
Returns
Type Description
\Zend_Gdata_Analytics_DataQuery
Documentation was generated by DocBlox 0.15.1.