Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Dfareporting_FloodlightActivityGroups_Resource Class Reference

The "floodlightActivityGroups" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_FloodlightActivityGroups_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 group.
 
 get ($profileId, $id, $optParams=array())
 Gets one floodlight activity group by ID.
 
 insert ($profileId, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams=array())
 Inserts a new floodlight activity group.
 
 listFloodlightActivityGroups ($profileId, $optParams=array())
 Retrieves a list of floodlight activity groups, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams=array())
 Updates an existing floodlight activity group.
 
 update ($profileId, Google_Service_Dfareporting_FloodlightActivityGroup $postBody, $optParams=array())
 Updates an existing floodlight activity group.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "floodlightActivityGroups" collection of methods.

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

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_FloodlightActivityGroups_Resource::delete ( $profileId,
$id,
$optParams = array() )

Deletes an existing floodlight activity group.

(floodlightActivityGroups.delete)

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

◆ get()

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

Gets one floodlight activity group by ID.

(floodlightActivityGroups.get)

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

◆ insert()

Google_Service_Dfareporting_FloodlightActivityGroups_Resource::insert ( $profileId,
Google_Service_Dfareporting_FloodlightActivityGroup $postBody,
$optParams = array() )

Inserts a new floodlight activity group.

(floodlightActivityGroups.insert)

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

◆ listFloodlightActivityGroups()

Google_Service_Dfareporting_FloodlightActivityGroups_Resource::listFloodlightActivityGroups ( $profileId,
$optParams = array() )

Retrieves a list of floodlight activity groups, possibly filtered.

(floodlightActivityGroups.listFloodlightActivityGroups)

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

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

Return values
Google_Service_Dfareporting_FloodlightActivityGroupsListResponse

◆ patch()

Google_Service_Dfareporting_FloodlightActivityGroups_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_FloodlightActivityGroup $postBody,
$optParams = array() )

Updates an existing floodlight activity group.

This method supports patch semantics. (floodlightActivityGroups.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight activity Group ID.
Google_FloodlightActivityGroup$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightActivityGroup

◆ update()

Google_Service_Dfareporting_FloodlightActivityGroups_Resource::update ( $profileId,
Google_Service_Dfareporting_FloodlightActivityGroup $postBody,
$optParams = array() )

Updates an existing floodlight activity group.

(floodlightActivityGroups.update)

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

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