Google_Service_YouTubeAnalytics_Reports_Resource

The "reports" collection of methods.

Defined (1)

The class is defined in the following location(s).

/src/Google/Service/YouTubeAnalytics.php  
  1. class Google_Service_YouTubeAnalytics_Reports_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Retrieve your YouTube Analytics reports. (reports.query) 
  5. * @param string $ids Identifies the YouTube channel or content owner for which 
  6. * you are retrieving YouTube Analytics data. - To request data for a YouTube 
  7. * user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID 
  8. * specifies the unique YouTube channel ID. - To request data for a YouTube CMS 
  9. * content owner, set the ids parameter value to contentOwner==OWNER_NAME, where 
  10. * OWNER_NAME is the CMS name of the content owner. 
  11. * @param string $startDate The start date for fetching YouTube Analytics data. 
  12. * The value should be in YYYY-MM-DD format. 
  13. * @param string $endDate The end date for fetching YouTube Analytics data. The 
  14. * value should be in YYYY-MM-DD format. 
  15. * @param string $metrics A comma-separated list of YouTube Analytics metrics,  
  16. * such as views or likes, dislikes. See the Available Reports document for a 
  17. * list of the reports that you can retrieve and the metrics available in each 
  18. * report, and see the Metrics document for definitions of those metrics. 
  19. * @param array $optParams Optional parameters. 
  20. * @opt_param int max-results The maximum number of rows to include in the 
  21. * response. 
  22. * @opt_param string sort A comma-separated list of dimensions or metrics that 
  23. * determine the sort order for YouTube Analytics data. By default the sort 
  24. * order is ascending. The '-' prefix causes descending sort order. 
  25. * @opt_param string dimensions A comma-separated list of YouTube Analytics 
  26. * dimensions, such as views or ageGroup, gender. See the Available Reports 
  27. * document for a list of the reports that you can retrieve and the dimensions 
  28. * used for those reports. Also see the Dimensions document for definitions of 
  29. * those dimensions. 
  30. * @opt_param int start-index An index of the first entity to retrieve. Use this 
  31. * parameter as a pagination mechanism along with the max-results parameter 
  32. * (one-based, inclusive). 
  33. * @opt_param string filters A list of filters that should be applied when 
  34. * retrieving YouTube Analytics data. The Available Reports document identifies 
  35. * the dimensions that can be used to filter each report, and the Dimensions 
  36. * document defines those dimensions. If a request uses multiple filters, join 
  37. * them together with a semicolon (;), and the returned result table will 
  38. * satisfy both filters. For example, a filters parameter value of 
  39. * video==dMH0bHeiRNg;country==IT restricts the result set to include data for 
  40. * the given video in Italy. 
  41. * @return Google_Service_YouTubeAnalytics_ResultTable 
  42. */ 
  43. public function query($ids, $startDate, $endDate, $metrics, $optParams = array()) 
  44. $params = array('ids' => $ids, 'start-date' => $startDate, 'end-date' => $endDate, 'metrics' => $metrics); 
  45. $params = array_merge($params, $optParams); 
  46. return $this->call('query', array($params), "Google_Service_YouTubeAnalytics_ResultTable");