Gdata/Analytics/DataQuery.php

Show: PublicProtectedPrivateinherited
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
Provides a mechanism to build a query URL for Gdata services.

Queries are not defined for APP, but are provided by Gdata services as an extension.

Parent(s)
\Zend_Gdata_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  

Constants

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

Properties

>VPropertyprotectedstring $_category = null
inherited
Category for the query
Inherited from: \Zend_Gdata_Query::$$_category
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
>VPropertyprotectedstring $_defaultFeedUri = self::ANALYTICS_FEED_URI
The default URI used for feeds.
Default valueself::ANALYTICS_FEED_URIDetails
Type
string
>VPropertyprotectedarray $_dimensions = array()
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_filters = array()
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_metrics = array()
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
>VPropertyprotectedstring $_profileId
Details
Type
string
>VPropertyprotectedarray $_sort = array()
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_url = null
inherited
Base URL TODO: Add setters and getters
Inherited from: \Zend_Gdata_Query::$$_url
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_url  

Methods

methodpublic__construct( $url = null) : void
inherited

Create Gdata_Query object

Inherited from: \Zend_Gdata_Query::__construct()
Parameters
NameTypeDescription
$url
methodpublic__get( $name) : void
inherited

Inherited from: \Zend_Gdata_Query::__get()
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: \Zend_Gdata_Query::__set()
Parameters
NameTypeDescription
$name
$val
methodpublicaddDimension(string $dimension) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$dimensionstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicaddFilter(string $filter) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$filterstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicaddMetric(string $metric) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$metricstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicaddOrFilter(string $filter) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$filterstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicaddSort(string $sort, \boolean[optional] $descending = false) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$sortstring
$descending\boolean[optional]
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicgetAlt() : string
inherited

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns
TypeDescription
stringauthor
methodpublicgetCategory() : void
inherited

Inherited from: \Zend_Gdata_Query::getCategory()
methodpublicgetDimensions() : array

Returns
TypeDescription
array
methodpublicgetMaxResults() : int
inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns
TypeDescription
intmaxResults
methodpublicgetMetrics() : array

Returns
TypeDescription
array
methodpublicgetParam(string $name) : void
inherited

Inherited from: \Zend_Gdata_Query::getParam()
Parameters
NameTypeDescription
$namestring
methodpublicgetProfileId() : string

Returns
TypeDescription
string
methodpublicgetPublishedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
inherited

Inherited from: \Zend_Gdata_Query::getQuery()
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
inherited

Inherited from: \Zend_Gdata_Query::getQueryString()
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl() : string

Returns
TypeDescription
stringurl
methodpublicgetStartIndex() : int
inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns
TypeDescription
intstartIndex
methodpublicgetUpdatedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicremoveDimension(string $dimension) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$dimensionstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicremoveMetric(string $metric) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$metricstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicresetParameters() : void
inherited

Inherited from: \Zend_Gdata_Query::resetParameters()
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetEndDate( $date) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$date
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setParam()
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetProfileId(string $id) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetSegment(string $segment) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$segmentstring
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicsetStartDate( $date) : \Zend_Gdata_Analytics_DataQuery

Parameters
NameTypeDescription
$date
Returns
TypeDescription
\Zend_Gdata_Analytics_DataQuery
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.