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

The "placementStrategies" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_PlacementStrategies_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 placement strategy.
 
 get ($profileId, $id, $optParams=array())
 Gets one placement strategy by ID.
 
 insert ($profileId, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams=array())
 Inserts a new placement strategy.
 
 listPlacementStrategies ($profileId, $optParams=array())
 Retrieves a list of placement strategies, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams=array())
 Updates an existing placement strategy.
 
 update ($profileId, Google_Service_Dfareporting_PlacementStrategy $postBody, $optParams=array())
 Updates an existing placement strategy.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "placementStrategies" collection of methods.

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

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

Deletes an existing placement strategy.

(placementStrategies.delete)

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

◆ get()

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

Gets one placement strategy by ID.

(placementStrategies.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idPlacement strategy ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_PlacementStrategy

◆ insert()

Google_Service_Dfareporting_PlacementStrategies_Resource::insert ( $profileId,
Google_Service_Dfareporting_PlacementStrategy $postBody,
$optParams = array() )

Inserts a new placement strategy.

(placementStrategies.insert)

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

◆ listPlacementStrategies()

Google_Service_Dfareporting_PlacementStrategies_Resource::listPlacementStrategies ( $profileId,
$optParams = array() )

Retrieves a list of placement strategies, possibly filtered.

(placementStrategies.listPlacementStrategies)

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, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 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 "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only placement strategies with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is ASCENDING.

Return values
Google_Service_Dfareporting_PlacementStrategiesListResponse

◆ patch()

Google_Service_Dfareporting_PlacementStrategies_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_PlacementStrategy $postBody,
$optParams = array() )

Updates an existing placement strategy.

This method supports patch semantics. (placementStrategies.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idPlacement strategy ID.
Google_PlacementStrategy$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_PlacementStrategy

◆ update()

Google_Service_Dfareporting_PlacementStrategies_Resource::update ( $profileId,
Google_Service_Dfareporting_PlacementStrategy $postBody,
$optParams = array() )

Updates an existing placement strategy.

(placementStrategies.update)

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

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