Documentation

Google_Service_PlayMovies_Resource_AccountsAvails extends Google_Service_Resource
in package

The "avails" collection of methods.

Typical usage is: $playmoviespartnerService = new Google_Service_PlayMovies(...); $avails = $playmoviespartnerService->avails;

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.
get()  : Google_Service_PlayMovies_Avail
Get an Avail given its avail group id and avail id. (avails.get)
listAccountsAvails()  : Google_Service_PlayMovies_ListAvailsResponse
List Avails owned or managed by the partner.
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

get()

Get an Avail given its avail group id and avail id. (avails.get)

public get(string $accountId, string $availId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PlayMovies_Avail
Parameters
$accountId : string

REQUIRED. See General rules for more information about this field.

$availId : string

REQUIRED. Avail ID.

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

Optional parameters.

Return values
Google_Service_PlayMovies_Avail

listAccountsAvails()

List Avails owned or managed by the partner.

public listAccountsAvails(string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PlayMovies_ListAvailsResponse

See Authentication and Authorization rules and List methods rules for more information about this method. (avails.listAccountsAvails)

Parameters
$accountId : string

REQUIRED. See General rules for more information about this field.

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

Optional parameters.

Tags
opt_param

string pphNames See List methods rules for info about this field.

opt_param

string altId Filter Avails that match a case-insensitive, partner- specific custom id. NOTE: this field is deprecated and will be removed on V2; alt_ids should be used instead.

opt_param

string studioNames See List methods rules for info about this field.

opt_param

string territories Filter Avails that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").

opt_param

string title Filter that matches Avails with a title_internal_alias, series_title_internal_alias, season_title_internal_alias, or episode_title_internal_alias that contains the given case-insensitive title.

opt_param

string videoIds Filter Avails that match any of the given video_ids.

opt_param

string pageToken See List methods rules for info about this field.

opt_param

int pageSize See List methods rules for info about this field.

opt_param

string altIds Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.

Return values
Google_Service_PlayMovies_ListAvailsResponse

convertToArrayAndStripNulls()

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

Search results