Google_Service_YouTubeAnalytics_Groups_Resource Class Reference

The "groups" collection of methods. More...

Inheritance diagram for Google_Service_YouTubeAnalytics_Groups_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($id, $optParams=array())
	Deletes a group.
	insert (Google_Service_YouTubeAnalytics_Group $postBody, $optParams=array())
	Creates a group.
	listGroups ($optParams=array())
	Returns a collection of groups that match the API request parameters.
	update (Google_Service_YouTubeAnalytics_Group $postBody, $optParams=array())
	Modifies a group.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "groups" collection of methods.

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

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

delete()

Google_Service_YouTubeAnalytics_Groups_Resource::delete	(		$id,
			$optParams = array() )

Deletes a group.

(groups.delete)

Parameters

string	$id	The id parameter specifies the YouTube group ID for the group that is being deleted.
array	$optParams	Optional parameters.

@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

insert()

Google_Service_YouTubeAnalytics_Groups_Resource::insert	(	Google_Service_YouTubeAnalytics_Group	$postBody,
			$optParams = array() )

Creates a group.

(groups.insert)

Parameters

Google_Group	$postBody
array	$optParams	Optional parameters.

@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Return values

Google_Service_YouTubeAnalytics_Group

listGroups()

Google_Service_YouTubeAnalytics_Groups_Resource::listGroups

(

$optParams = array()

)

Returns a collection of groups that match the API request parameters.

For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. (groups.listGroups)

Parameters

array

$optParams

Optional parameters.

@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param string id The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. @opt_param bool mine Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.

Return values

Google_Service_YouTubeAnalytics_GroupListResponse

update()

Google_Service_YouTubeAnalytics_Groups_Resource::update	(	Google_Service_YouTubeAnalytics_Group	$postBody,
			$optParams = array() )

Modifies a group.

For example, you could change a group's title. (groups.update)

Parameters

Google_Group	$postBody
array	$optParams	Optional parameters.

@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Return values

Google_Service_YouTubeAnalytics_Group

---

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

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