Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Dfareporting_CreativeGroups_Resource Class Reference

The "creativeGroups" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_CreativeGroups_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $id, $optParams=array())
 Gets one creative group by ID.
 
 insert ($profileId, Google_Service_Dfareporting_CreativeGroup $postBody, $optParams=array())
 Inserts a new creative group.
 
 listCreativeGroups ($profileId, $optParams=array())
 Retrieves a list of creative groups, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_CreativeGroup $postBody, $optParams=array())
 Updates an existing creative group.
 
 update ($profileId, Google_Service_Dfareporting_CreativeGroup $postBody, $optParams=array())
 Updates an existing creative group.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "creativeGroups" collection of methods.

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

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

◆ get()

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

Gets one creative group by ID.

(creativeGroups.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idCreative group ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeGroup

◆ insert()

Google_Service_Dfareporting_CreativeGroups_Resource::insert ( $profileId,
Google_Service_Dfareporting_CreativeGroup $postBody,
$optParams = array() )

Inserts a new creative group.

(creativeGroups.insert)

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

◆ listCreativeGroups()

Google_Service_Dfareporting_CreativeGroups_Resource::listCreativeGroups ( $profileId,
$optParams = array() )

Retrieves a list of creative groups, possibly filtered.

(creativeGroups.listCreativeGroups)

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

@opt_param string searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". @opt_param string sortField Field by which to sort the list. @opt_param string advertiserIds Select only creative groups that belong to these advertisers. @opt_param int groupNumber Select only creative groups that belong to this subgroup. @opt_param int maxResults Maximum number of results to return. @opt_param string ids Select only creative groups with these IDs. @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_CreativeGroupsListResponse

◆ patch()

Google_Service_Dfareporting_CreativeGroups_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_CreativeGroup $postBody,
$optParams = array() )

Updates an existing creative group.

This method supports patch semantics. (creativeGroups.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idCreative group ID.
Google_CreativeGroup$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeGroup

◆ update()

Google_Service_Dfareporting_CreativeGroups_Resource::update ( $profileId,
Google_Service_Dfareporting_CreativeGroup $postBody,
$optParams = array() )

Updates an existing creative group.

(creativeGroups.update)

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

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