Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Dfareporting_FloodlightActivities_Resource Class Reference

The "floodlightActivities" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_FloodlightActivities_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($profileId, $id, $optParams=array())
 Deletes an existing floodlight activity.
 
 generatetag ($profileId, $optParams=array())
 Generates a tag for a floodlight activity.
 
 get ($profileId, $id, $optParams=array())
 Gets one floodlight activity by ID.
 
 insert ($profileId, Google_Service_Dfareporting_FloodlightActivity $postBody, $optParams=array())
 Inserts a new floodlight activity.
 
 listFloodlightActivities ($profileId, $optParams=array())
 Retrieves a list of floodlight activities, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_FloodlightActivity $postBody, $optParams=array())
 Updates an existing floodlight activity.
 
 update ($profileId, Google_Service_Dfareporting_FloodlightActivity $postBody, $optParams=array())
 Updates an existing floodlight activity.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "floodlightActivities" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Dfareporting_FloodlightActivities_Resource::delete ( $profileId,
$id,
$optParams = array() )

Deletes an existing floodlight activity.

(floodlightActivities.delete)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight activity ID.
array$optParamsOptional parameters.

◆ generatetag()

Google_Service_Dfareporting_FloodlightActivities_Resource::generatetag ( $profileId,
$optParams = array() )

Generates a tag for a floodlight activity.

(floodlightActivities.generatetag)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

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

Return values
Google_Service_Dfareporting_FloodlightActivitiesGenerateTagResponse

◆ get()

Google_Service_Dfareporting_FloodlightActivities_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one floodlight activity by ID.

(floodlightActivities.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight activity ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightActivity

◆ insert()

Google_Service_Dfareporting_FloodlightActivities_Resource::insert ( $profileId,
Google_Service_Dfareporting_FloodlightActivity $postBody,
$optParams = array() )

Inserts a new floodlight activity.

(floodlightActivities.insert)

Parameters
string$profileIdUser profile ID associated with this request.
Google_FloodlightActivity$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightActivity

◆ listFloodlightActivities()

Google_Service_Dfareporting_FloodlightActivities_Resource::listFloodlightActivities ( $profileId,
$optParams = array() )

Retrieves a list of floodlight activities, possibly filtered.

(floodlightActivities.listFloodlightActivities)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

@opt_param string floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" 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 sortField Field by which to sort the list. @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 ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. @opt_param string floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. @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 pageToken Value of the nextPageToken from the previous result page. @opt_param int maxResults Maximum number of results to return. @opt_param string tagString Select only floodlight activities with the specified tag string. @opt_param string floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. @opt_param string floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type.

Return values
Google_Service_Dfareporting_FloodlightActivitiesListResponse

◆ patch()

Google_Service_Dfareporting_FloodlightActivities_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_FloodlightActivity $postBody,
$optParams = array() )

Updates an existing floodlight activity.

This method supports patch semantics. (floodlightActivities.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight activity ID.
Google_FloodlightActivity$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightActivity

◆ update()

Google_Service_Dfareporting_FloodlightActivities_Resource::update ( $profileId,
Google_Service_Dfareporting_FloodlightActivity $postBody,
$optParams = array() )

Updates an existing floodlight activity.

(floodlightActivities.update)

Parameters
string$profileIdUser profile ID associated with this request.
Google_FloodlightActivity$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightActivity

The documentation for this class was generated from the following file: