Documentation

Google_Service_Dfareporting_Resource_FloodlightActivityGroups extends Google_Service_Resource
in package

The "floodlightActivityGroups" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $floodlightActivityGroups = $dfareportingService->floodlightActivityGroups;

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_Dfareporting_FloodlightActivityGroup
Gets one floodlight activity group by ID. (floodlightActivityGroups.get)
insert()  : Google_Service_Dfareporting_FloodlightActivityGroup
Inserts a new floodlight activity group. (floodlightActivityGroups.insert)
listFloodlightActivityGroups()  : Google_Service_Dfareporting_FloodlightActivityGroupsListResponse
Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
patch()  : Google_Service_Dfareporting_FloodlightActivityGroup
Updates an existing floodlight activity group. This method supports patch semantics. (floodlightActivityGroups.patch)
update()  : Google_Service_Dfareporting_FloodlightActivityGroup
Updates an existing floodlight activity group.
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()

Gets one floodlight activity group by ID. (floodlightActivityGroups.get)

public get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_FloodlightActivityGroup
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Floodlight activity Group ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivityGroup —

insert()

Inserts a new floodlight activity group. (floodlightActivityGroups.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivityGroup —

listFloodlightActivityGroups()

Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.

public listFloodlightActivityGroups(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_FloodlightActivityGroupsListResponse

(floodlightActivityGroups.listFloodlightActivityGroups)

Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum number of results to return.

opt_param

string type Select only floodlight activity groups with the specified floodlight activity group type.

opt_param

string sortOrder Order of sorted results.

opt_param

string advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

opt_param

string floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.

opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

opt_param

string sortField Field by which to sort the list.

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "floodlightactivitygroup2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".

Return values
Google_Service_Dfareporting_FloodlightActivityGroupsListResponse —

patch()

Updates an existing floodlight activity group. This method supports patch semantics. (floodlightActivityGroups.patch)

public patch(string $profileId, string $id, Google_Service_Dfareporting_FloodlightActivityGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_FloodlightActivityGroup
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

FloodlightActivityGroup ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivityGroup —

update()

Updates an existing floodlight activity group.

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

(floodlightActivityGroups.update)

Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivityGroup —

convertToArrayAndStripNulls()

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

Search results