Documentation

Google_Service_YouTubeAnalytics_Resource_GroupItems extends Google_Service_Resource
in package

The "groupItems" collection of methods.

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

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
Removes an item from a group. (groupItems.delete)
insert()  : Google_Service_YouTubeAnalytics_GroupItem
Creates a group item. (groupItems.insert)
listGroupItems()  : Google_Service_YouTubeAnalytics_ListGroupItemsResponse
Returns a collection of group items that match the API request parameters.
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()

Removes an item from a group. (groupItems.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 item ID of the group item 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 item. (groupItems.insert)

public insert(Google_Service_YouTubeAnalytics_GroupItem $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_GroupItem
Parameters
$postBody : Google_Service_YouTubeAnalytics_GroupItem
$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_GroupItem —

listGroupItems()

Returns a collection of group items that match the API request parameters.

public listGroupItems([array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeAnalytics_ListGroupItemsResponse

(groupItems.listGroupItems)

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

Optional parameters.

Tags
opt_param

string groupId The groupId parameter specifies the unique ID of the group for which you want to retrieve group items.

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_ListGroupItemsResponse —

convertToArrayAndStripNulls()

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

Search results