Documentation

Google_Service_Dfareporting_Resource_FloodlightActivities extends Google_Service_Resource
in package

The "floodlightActivities" collection of methods.

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

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()  : mixed
Deletes an existing floodlight activity. (floodlightActivities.delete)
generatetag()  : Google_Service_Dfareporting_FloodlightActivitiesGenerateTagResponse
Generates a tag for a floodlight activity. (floodlightActivities.generatetag)
get()  : Google_Service_Dfareporting_FloodlightActivity
Gets one floodlight activity by ID. (floodlightActivities.get)
insert()  : Google_Service_Dfareporting_FloodlightActivity
Inserts a new floodlight activity. (floodlightActivities.insert)
listFloodlightActivities()  : Google_Service_Dfareporting_FloodlightActivitiesListResponse
Retrieves a list of floodlight activities, possibly filtered. This method supports paging. (floodlightActivities.listFloodlightActivities)
patch()  : Google_Service_Dfareporting_FloodlightActivity
Updates an existing floodlight activity. This method supports patch semantics. (floodlightActivities.patch)
update()  : Google_Service_Dfareporting_FloodlightActivity
Updates an existing floodlight activity. (floodlightActivities.update)
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 an existing floodlight activity. (floodlightActivities.delete)

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

User profile ID associated with this request.

$id : string

Floodlight activity ID.

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

Optional parameters.

Return values
mixed —

generatetag()

Generates a tag for a floodlight activity. (floodlightActivities.generatetag)

public generatetag(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_FloodlightActivitiesGenerateTagResponse
Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string floodlightActivityId Floodlight activity ID for which we want to generate a tag.

Return values
Google_Service_Dfareporting_FloodlightActivitiesGenerateTagResponse —

insert()

Inserts a new floodlight activity. (floodlightActivities.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivity —

listFloodlightActivities()

Retrieves a list of floodlight activities, possibly filtered. This method supports paging. (floodlightActivities.listFloodlightActivities)

public listFloodlightActivities(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_FloodlightActivitiesListResponse
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 floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

opt_param

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

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "floodlightactivity2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 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 "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".

opt_param

string advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

opt_param

string floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string.

opt_param

string tagString Select only floodlight activities with the specified tag string.

opt_param

string floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type.

opt_param

string floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs.

opt_param

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

opt_param

string sortOrder Order of sorted results.

opt_param

string floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name.

opt_param

string sortField Field by which to sort the list.

Return values
Google_Service_Dfareporting_FloodlightActivitiesListResponse —

patch()

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

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

User profile ID associated with this request.

$id : string

FloodlightActivity ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivity —

update()

Updates an existing floodlight activity. (floodlightActivities.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_FloodlightActivity —

convertToArrayAndStripNulls()

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

Search results