Documentation

Google_Service_YouTubeAnalytics_Resource_Groups extends Google_Service_Resource
in package

The "groups" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_YouTubeAnalytics_EmptyResponse
Deletes a group. (groups.delete)
insert()  : Google_Service_YouTubeAnalytics_Group
Creates a group. (groups.insert)
listGroups()  : Google_Service_YouTubeAnalytics_ListGroupsResponse
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)
update()  : Google_Service_YouTubeAnalytics_Group
Modifies a group. For example, you could change a group's title.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a group. (groups.delete)

public delete([array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_EmptyResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string id The id parameter specifies the YouTube group ID of the group that is being deleted.

opt_param

string onBehalfOfContentOwner This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. 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 account that the user authenticates with must be linked to the specified YouTube content owner.

Return values
Google_Service_YouTubeAnalytics_EmptyResponse

insert()

Creates a group. (groups.insert)

public insert(Google_Service_YouTubeAnalytics_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_Group
Parameters
$postBody : Google_Service_YouTubeAnalytics_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string onBehalfOfContentOwner This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. 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 account that the user authenticates with must be linked to the specified YouTube content owner.

Return values
Google_Service_YouTubeAnalytics_Group

listGroups()

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)

public listGroups([array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_ListGroupsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string onBehalfOfContentOwner This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. 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 account that the user authenticates with must be linked to the specified YouTube content owner.

opt_param

bool mine This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.

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. Each group must be owned by the authenticated user. In a group resource, the id property specifies the group's YouTube group ID. Note that if you do not specify a value for the id parameter, then you must set the mine parameter to true.

opt_param

string pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.

Return values
Google_Service_YouTubeAnalytics_ListGroupsResponse

update()

Modifies a group. For example, you could change a group's title.

public update(Google_Service_YouTubeAnalytics_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_Group

(groups.update)

Parameters
$postBody : Google_Service_YouTubeAnalytics_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string onBehalfOfContentOwner This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. 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 account that the user authenticates with must be linked to the specified YouTube content owner.

Return values
Google_Service_YouTubeAnalytics_Group

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results