Google_Service_YouTubeAnalytics_Reports_Resource Class Reference

The "reports" collection of methods. More...

Inheritance diagram for Google_Service_YouTubeAnalytics_Reports_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	query ($ids, $startDate, $endDate, $metrics, $optParams=array())
	Retrieve your YouTube Analytics reports.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "reports" collection of methods.

Typical usage is: $youtubeAnalyticsService = new Google_Service_YouTubeAnalytics(...); $reports = $youtubeAnalyticsService->reports;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

query()

Google_Service_YouTubeAnalytics_Reports_Resource::query	(		$ids,
			$startDate,
			$endDate,
			$metrics,
			$optParams = array() )

Retrieve your YouTube Analytics reports.

(reports.query)

Parameters

string	$ids	Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner.
string	$startDate	The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
string	$endDate	The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
string	$metrics	A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.
array	$optParams	Optional parameters.

@opt_param int max-results The maximum number of rows to include in the response. @opt_param string sort A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. @opt_param string dimensions A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. @opt_param int start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). @opt_param string currency The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. @opt_param string filters A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy.

Return values

Google_Service_YouTubeAnalytics_ResultTable

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/YouTubeAnalytics.php