Zend Framework API Documentation
Back to top  

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.

category Zend
package Zend_Gdata
subpackage Analytics
inherited_from \Zend_Gdata_Query

 Methods

Create Gdata_Query object

__construct($url = null) 
Inherited

Parameters

$url

__get() 

__get($name) 
Inherited

Parameters

$name

__set() 

__set($name, $val) 
Inherited

Parameters

$name

$val

addDimension() 

addDimension(string $dimension) : \Zend_Gdata_Analytics_DataQuery

Parameters

$dimension

string

Returns

\Zend_Gdata_Analytics_DataQuery

addFilter() 

addFilter(string $filter) : \Zend_Gdata_Analytics_DataQuery

Parameters

$filter

string

Returns

\Zend_Gdata_Analytics_DataQuery

addMetric() 

addMetric(string $metric) : \Zend_Gdata_Analytics_DataQuery

Parameters

$metric

string

Returns

\Zend_Gdata_Analytics_DataQuery

addOrFilter() 

addOrFilter(string $filter) : \Zend_Gdata_Analytics_DataQuery

Parameters

$filter

string

Returns

\Zend_Gdata_Analytics_DataQuery

addSort() 

addSort(string $sort, \boolean[optional] $descending = false) : \Zend_Gdata_Analytics_DataQuery

Parameters

$sort

string

$descending

\boolean[optional]

Returns

\Zend_Gdata_Analytics_DataQuery

clearSort() 

clearSort() : \Zend_Gdata_Analytics_DataQuery

Returns

\Zend_Gdata_Analytics_DataQuery

getAlt() 

getAlt() : string
Inherited

Returns

stringrss or atom

getAuthor() 

getAuthor() : string
Inherited

Returns

stringauthor

getCategory() 

getCategory() 
Inherited

getDimensions() 

getDimensions() : array

Returns

array

getMaxResults() 

getMaxResults() : integer
Inherited

Returns

integermaxResults

getMetrics() 

getMetrics() : array

Returns

array

getParam() 

getParam(string $name) 
Inherited

Parameters

$name

string

getProfileId() 

getProfileId() : string

Returns

string

getPublishedMax() 

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin() 

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery() 

getQuery() : string
Inherited

Returns

stringquery

getQueryString() 

getQueryString() : string
Inherited

Returns

stringquerystring

getQueryUrl() 

getQueryUrl() : string
inherited_from \Zend_Gdata_Query::getQueryUrl()

Returns

stringurl

getQueryUrl() 

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex() 

getStartIndex() : integer
Inherited

Returns

integerstartIndex

getUpdatedMax() 

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin() 

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

removeDimension() 

removeDimension(string $dimension) : \Zend_Gdata_Analytics_DataQuery

Parameters

$dimension

string

Returns

\Zend_Gdata_Analytics_DataQuery

removeMetric() 

removeMetric(string $metric) : \Zend_Gdata_Analytics_DataQuery

Parameters

$metric

string

Returns

\Zend_Gdata_Analytics_DataQuery

resetParameters() 

resetParameters() 
Inherited

setAlt() 

setAlt(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor() 

setAuthor(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory() 

setCategory(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setEndDate() 

setEndDate($date) : \Zend_Gdata_Analytics_DataQuery

Parameters

$date

Returns

\Zend_Gdata_Analytics_DataQuery

setMaxResults() 

setMaxResults(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setParam() 

setParam(string $name, string $value) : \Zend_Gdata_Query
Inherited

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setProfileId() 

setProfileId(string $id) : \Zend_Gdata_Analytics_DataQuery

Parameters

$id

string

Returns

\Zend_Gdata_Analytics_DataQuery

setPublishedMax() 

setPublishedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin() 

setPublishedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery() 

setQuery(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setSegment() 

setSegment(string $segment) : \Zend_Gdata_Analytics_DataQuery

Parameters

$segment

string

Returns

\Zend_Gdata_Analytics_DataQuery

setStartDate() 

setStartDate($date) : \Zend_Gdata_Analytics_DataQuery

Parameters

$date

Returns

\Zend_Gdata_Analytics_DataQuery

setStartIndex() 

setStartIndex(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMax() 

setUpdatedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin() 

setUpdatedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

 Properties

 

Category for the query

$_category : string

Default

null
 

The default URI used for feeds.

$_defaultFeedUri 

Default

self::ANALYTICS_FEED_URI
inherited_from \Zend_Gdata_Query::_defaultFeedUri
 

Default URL

$_defaultFeedUri : string

Default

null
 

$_dimensions

$_dimensions : array

Default

array()
 

$_filters

$_filters : array

Default

array()
 

$_metrics

$_metrics : array

Default

array()
 

Query parameters.

$_params : array

Default

array()
 

$_profileId

$_profileId : string

Default

 

$_sort

$_sort : array

Default

array()
 

Base URL TODO: Add setters and getters

$_url : string

Default

null

 Constants

 

ANALYTICS_FEED_URI

ANALYTICS_FEED_URI = 'https://www.googleapis.com/analytics/v2.4/data' 
 

CONTAINS

CONTAINS = "=@" 
 

CONTAINS_NOT

CONTAINS_NOT = "!@" 
 

DIMENSION_AD_CONTENT

DIMENSION_AD_CONTENT = 'ga:adContent' 
 

DIMENSION_AD_GROUP

DIMENSION_AD_GROUP = 'ga:adGroup' 
 

DIMENSION_AD_SLOT

DIMENSION_AD_SLOT = 'ga:adSlot' 
 

DIMENSION_AD_SLOT_POSITION

DIMENSION_AD_SLOT_POSITION = 'ga:adSlotPosition' 
 

DIMENSION_AFFILIATION

DIMENSION_AFFILIATION = 'ga:affiliation' 
 

DIMENSION_BROWSER

DIMENSION_BROWSER = 'ga:browser' 
 

DIMENSION_BROWSER_VERSION

DIMENSION_BROWSER_VERSION = 'ga:browserVersion' 
 

DIMENSION_CAMPAIGN

DIMENSION_CAMPAIGN = 'ga:campaign' 
 

DIMENSION_CITY

DIMENSION_CITY = 'ga:city' 
 

DIMENSION_CONNECTIONSPEED

DIMENSION_CONNECTIONSPEED = 'ga:connectionSpeed' 
 

DIMENSION_CONTINENT

DIMENSION_CONTINENT = 'ga:continent' 
 

DIMENSION_COUNTRY

DIMENSION_COUNTRY = 'ga:country' 
 

DIMENSION_CUSTOM_VAR_NAME_1

DIMENSION_CUSTOM_VAR_NAME_1 = 'ga:customVarName1' 
 

DIMENSION_CUSTOM_VAR_NAME_2

DIMENSION_CUSTOM_VAR_NAME_2 = 'ga:customVarName2' 
 

DIMENSION_CUSTOM_VAR_NAME_3

DIMENSION_CUSTOM_VAR_NAME_3 = 'ga:customVarName3' 
 

DIMENSION_CUSTOM_VAR_NAME_4

DIMENSION_CUSTOM_VAR_NAME_4 = 'ga:customVarName4' 
 

DIMENSION_CUSTOM_VAR_NAME_5

DIMENSION_CUSTOM_VAR_NAME_5 = 'ga:customVarName5' 
 

DIMENSION_CUSTOM_VAR_VALUE_1

DIMENSION_CUSTOM_VAR_VALUE_1 = 'ga:customVarValue1' 
 

DIMENSION_CUSTOM_VAR_VALUE_2

DIMENSION_CUSTOM_VAR_VALUE_2 = 'ga:customVarValue2' 
 

DIMENSION_CUSTOM_VAR_VALUE_3

DIMENSION_CUSTOM_VAR_VALUE_3 = 'ga:customVarValue3' 
 

DIMENSION_CUSTOM_VAR_VALUE_4

DIMENSION_CUSTOM_VAR_VALUE_4 = 'ga:customVarValue4' 
 

DIMENSION_CUSTOM_VAR_VALUE_5

DIMENSION_CUSTOM_VAR_VALUE_5 = 'ga:customVarValue5' 
 

DIMENSION_DATE

DIMENSION_DATE = 'ga:date' 
 

DIMENSION_DAY

DIMENSION_DAY = 'ga:day' 
 

DIMENSION_DAYS_SINCE_LAST_VISIT

DIMENSION_DAYS_SINCE_LAST_VISIT = 'ga:daysSinceLastVisit' 
 

DIMENSION_DAYS_TO_TRANSACTION

DIMENSION_DAYS_TO_TRANSACTION = 'ga:daysToTransaction' 
 

DIMENSION_EVENT_ACTION

DIMENSION_EVENT_ACTION = 'ga:eventAction' 
 

DIMENSION_EVENT_CATEGORY

DIMENSION_EVENT_CATEGORY = 'ga:eventCategory' 
 

DIMENSION_EVENT_LABEL

DIMENSION_EVENT_LABEL = 'ga:eventLabel' 
 

DIMENSION_EXIT_PAGE_PATH

DIMENSION_EXIT_PAGE_PATH = 'ga:exitPagePath' 
 

DIMENSION_FLASH_VERSION

DIMENSION_FLASH_VERSION = 'ga:flashVersion' 
 

DIMENSION_HOSTNAME

DIMENSION_HOSTNAME = 'ga:hostname' 
 

DIMENSION_HOUR

DIMENSION_HOUR = 'ga:hour' 
 

DIMENSION_JAVA_ENABLED

DIMENSION_JAVA_ENABLED = 'ga:javaEnabled' 
 

DIMENSION_KEYWORD

DIMENSION_KEYWORD = 'ga:keyword' 
 

DIMENSION_LANDING_PAGE_PATH

DIMENSION_LANDING_PAGE_PATH = 'ga:landingPagePath' 
 

DIMENSION_LANGUAGE

DIMENSION_LANGUAGE = 'ga:language' 
 

DIMENSION_LATITUDE

DIMENSION_LATITUDE = 'ga:latitude' 
 

DIMENSION_LONGITUDE

DIMENSION_LONGITUDE = 'ga:longitude' 
 

DIMENSION_MEDIUM

DIMENSION_MEDIUM = 'ga:medium' 
 

DIMENSION_MONTH

DIMENSION_MONTH = 'ga:month' 
 

DIMENSION_NETWORK_DOMAIN

DIMENSION_NETWORK_DOMAIN = 'ga:networkDomain' 
 

DIMENSION_NETWORK_LOCATION

DIMENSION_NETWORK_LOCATION = 'ga:networkLocation' 
 

DIMENSION_NEXT_PAGE_PATH

DIMENSION_NEXT_PAGE_PATH = 'ga:nextPagePath' 
 

DIMENSION_OPERATING_SYSTEM

DIMENSION_OPERATING_SYSTEM = 'ga:operatingSystem' 
 

DIMENSION_OPERATING_SYSTEM_VERSION

DIMENSION_OPERATING_SYSTEM_VERSION = 'ga:operatingSystemVersion' 
 

DIMENSION_PAGE_DEPTH

DIMENSION_PAGE_DEPTH = 'ga:pageDepth' 
 

DIMENSION_PAGE_PATH

DIMENSION_PAGE_PATH = 'ga:pagePath' 
 

DIMENSION_PAGE_TITLE

DIMENSION_PAGE_TITLE = 'ga:pageTitle' 
 

DIMENSION_PREV_PAGE_PATH

DIMENSION_PREV_PAGE_PATH = 'ga:previousPagePath' 
 

DIMENSION_PRODUCT_CATEGORY

DIMENSION_PRODUCT_CATEGORY = 'ga:productCategory' 
 

DIMENSION_PRODUCT_NAME

DIMENSION_PRODUCT_NAME = 'ga:productName' 
 

DIMENSION_PRODUCT_SKU

DIMENSION_PRODUCT_SKU = 'ga:productSku' 
 

DIMENSION_REFERRAL_PATH

DIMENSION_REFERRAL_PATH = 'ga:referralPath' 
 

DIMENSION_REGION

DIMENSION_REGION = 'ga:region' 
 

DIMENSION_SCREEN_COLORS

DIMENSION_SCREEN_COLORS = 'ga:screenColors' 
 

DIMENSION_SCREEN_RESOLUTION

DIMENSION_SCREEN_RESOLUTION = 'ga:screenResolution' 
 

DIMENSION_SEARCH_CATEGORY

DIMENSION_SEARCH_CATEGORY = 'ga:searchCategory' 
 

DIMENSION_SEARCH_DESTINATION_PAGE

DIMENSION_SEARCH_DESTINATION_PAGE = 'ga:searchDestinationPage' 
 

DIMENSION_SEARCH_KEYWORD

DIMENSION_SEARCH_KEYWORD = 'ga:searchKeyword' 
 

DIMENSION_SEARCH_KEYWORD_REFINEMENT

DIMENSION_SEARCH_KEYWORD_REFINEMENT = 'ga:searchKeywordRefinement' 
 

DIMENSION_SEARCH_START_PAGE

DIMENSION_SEARCH_START_PAGE = 'ga:searchStartPage' 
 

DIMENSION_SEARCH_USED

DIMENSION_SEARCH_USED = 'ga:searchUsed' 
 

DIMENSION_SECOND_PAGE_PATH

DIMENSION_SECOND_PAGE_PATH = 'ga:secondPagePath' 
 

DIMENSION_SOURCE

DIMENSION_SOURCE = 'ga:source' 
 

DIMENSION_SUB_CONTINENT

DIMENSION_SUB_CONTINENT = 'ga:subContinent' 
 

DIMENSION_TRANSACTION_ID

DIMENSION_TRANSACTION_ID = 'ga:transactionId' 
 

DIMENSION_USER_DEFINED_VALUE

DIMENSION_USER_DEFINED_VALUE = 'ga:userDefinedValue' 
 

DIMENSION_VISITOR_TYPE

DIMENSION_VISITOR_TYPE = 'ga:visitorType' 
 

DIMENSION_VISITS_TO_TRANSACTION

DIMENSION_VISITS_TO_TRANSACTION = 'ga:visitsToTransaction' 
 

DIMENSION_VISIT_COUNT

DIMENSION_VISIT_COUNT = 'ga:visitCount' 
 

DIMENSION_VISIT_LENGTH

DIMENSION_VISIT_LENGTH = 'ga:visitLength' 
 

DIMENSION_WEEK

DIMENSION_WEEK = 'ga:week' 
 

DIMENSION_YEAR

DIMENSION_YEAR = 'ga:year' 
 

EQUALS

EQUALS = "==" 
 

EQUALS_NOT

EQUALS_NOT = "!=" 
 

GREATER

GREATER = ">" 
 

GREATER_EQUAL

GREATER_EQUAL = ">=" 
 

LESS

LESS = ">" 
 

LESS_EQUAL

LESS_EQUAL = "<=" 
 

METRIC_AD_CLICKS

METRIC_AD_CLICKS = 'ga:adClicks' 
 

METRIC_AD_COST

METRIC_AD_COST = 'ga:adCost' 
 

METRIC_BOUNCES

METRIC_BOUNCES = 'ga:bounces' 
 

METRIC_CPC

METRIC_CPC = 'ga:CPC' 
 

METRIC_CPM

METRIC_CPM = 'ga:CPM' 
 

METRIC_CTR

METRIC_CTR = 'ga:CTR' 
 

METRIC_ENTRANCES

METRIC_ENTRANCES = 'ga:entrances' 
 

METRIC_EVENT_VALUE

METRIC_EVENT_VALUE = 'ga:eventValue' 
 

METRIC_EXITS

METRIC_EXITS = 'ga:exits' 
 

METRIC_GOAL_1_COMPLETION

METRIC_GOAL_1_COMPLETION = 'ga:goal1Completions' 
 

METRIC_GOAL_1_STARTS

METRIC_GOAL_1_STARTS = 'ga:goal1Starts' 
 

METRIC_GOAL_1_VALUE

METRIC_GOAL_1_VALUE = 'ga:goal1Value' 
 

METRIC_GOAL_COMPLETIONS_ALL

METRIC_GOAL_COMPLETIONS_ALL = 'ga:goalCompletionsAll' 
 

METRIC_GOAL_STARTS_ALL

METRIC_GOAL_STARTS_ALL = 'ga:goalStartsAll' 
 

METRIC_GOAL_VALUE_ALL

METRIC_GOAL_VALUE_ALL = 'ga:goalValueAll' 
 

METRIC_IMPRESSIONS

METRIC_IMPRESSIONS = 'ga:impressions' 
 

METRIC_ITEM_QUANTITY

METRIC_ITEM_QUANTITY = 'ga:itemQuantity' 
 

METRIC_ITEM_REVENUE

METRIC_ITEM_REVENUE = 'ga:itemRevenue' 
 

METRIC_NEW_VISITS

METRIC_NEW_VISITS = 'ga:newVisits' 
 

METRIC_PAGEVIEWS

METRIC_PAGEVIEWS = 'ga:pageviews' 
 

METRIC_SEARCH_DEPTH

METRIC_SEARCH_DEPTH = 'ga:searchDepth' 
 

METRIC_SEARCH_DURATION

METRIC_SEARCH_DURATION = 'ga:searchDuration' 
 

METRIC_SEARCH_EXITS

METRIC_SEARCH_EXITS = 'ga:searchExits' 
 

METRIC_SEARCH_REFINEMENTS

METRIC_SEARCH_REFINEMENTS = 'ga:searchRefinements' 
 

METRIC_SEARCH_UNIQUES

METRIC_SEARCH_UNIQUES = 'ga:searchUniques' 
 

METRIC_SEARCH_VISIT

METRIC_SEARCH_VISIT = 'ga:searchVisits' 
 

METRIC_TIME_ON_PAGE

METRIC_TIME_ON_PAGE = 'ga:timeOnPage' 
 

METRIC_TIME_ON_SITE

METRIC_TIME_ON_SITE = 'ga:timeOnSite' 
 

METRIC_TOTAL_EVENTS

METRIC_TOTAL_EVENTS = 'ga:totalEvents' 
 

METRIC_TRANSACTIONS

METRIC_TRANSACTIONS = 'ga:transactions' 
 

METRIC_TRANSACTION_REVENUE

METRIC_TRANSACTION_REVENUE = 'ga:transactionRevenue' 
 

METRIC_TRANSACTION_SHIPPING

METRIC_TRANSACTION_SHIPPING = 'ga:transactionShipping' 
 

METRIC_TRANSACTION_TAX

METRIC_TRANSACTION_TAX = 'ga:transactionTax' 
 

METRIC_UNIQUE_EVENTS

METRIC_UNIQUE_EVENTS = 'ga:uniqueEvents' 
 

METRIC_UNIQUE_PAGEVIEWS

METRIC_UNIQUE_PAGEVIEWS = 'ga:uniquePageviews' 
 

METRIC_UNIQUE_PURCHASES

METRIC_UNIQUE_PURCHASES = 'ga:uniquePurchases' 
 

METRIC_VISITORS

METRIC_VISITORS = 'ga:visitors' 
 

METRIC_VISITS

METRIC_VISITS = 'ga:visits' 
 

REGULAR

REGULAR = "=~" 
 

REGULAR_NOT

REGULAR_NOT = "!~"