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

The "creativeFieldValues" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_CreativeFieldValues_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($profileId, $creativeFieldId, $id, $optParams=array())
 Deletes an existing creative field value.
 
 get ($profileId, $creativeFieldId, $id, $optParams=array())
 Gets one creative field value by ID.
 
 insert ($profileId, $creativeFieldId, Google_Service_Dfareporting_CreativeFieldValue $postBody, $optParams=array())
 Inserts a new creative field value.
 
 listCreativeFieldValues ($profileId, $creativeFieldId, $optParams=array())
 Retrieves a list of creative field values, possibly filtered.
 
 patch ($profileId, $creativeFieldId, $id, Google_Service_Dfareporting_CreativeFieldValue $postBody, $optParams=array())
 Updates an existing creative field value.
 
 update ($profileId, $creativeFieldId, Google_Service_Dfareporting_CreativeFieldValue $postBody, $optParams=array())
 Updates an existing creative field value.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "creativeFieldValues" collection of methods.

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

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

Deletes an existing creative field value.

(creativeFieldValues.delete)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
string$idCreative Field Value ID
array$optParamsOptional parameters.

◆ get()

Google_Service_Dfareporting_CreativeFieldValues_Resource::get ( $profileId,
$creativeFieldId,
$id,
$optParams = array() )

Gets one creative field value by ID.

(creativeFieldValues.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
string$idCreative Field Value ID
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeFieldValue

◆ insert()

Google_Service_Dfareporting_CreativeFieldValues_Resource::insert ( $profileId,
$creativeFieldId,
Google_Service_Dfareporting_CreativeFieldValue $postBody,
$optParams = array() )

Inserts a new creative field value.

(creativeFieldValues.insert)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
Google_CreativeFieldValue$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeFieldValue

◆ listCreativeFieldValues()

Google_Service_Dfareporting_CreativeFieldValues_Resource::listCreativeFieldValues ( $profileId,
$creativeFieldId,
$optParams = array() )

Retrieves a list of creative field values, possibly filtered.

(creativeFieldValues.listCreativeFieldValues)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
array$optParamsOptional parameters.

@opt_param string searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only creative field values with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string sortOrder Order of sorted results, default is ASCENDING.

Return values
Google_Service_Dfareporting_CreativeFieldValuesListResponse

◆ patch()

Google_Service_Dfareporting_CreativeFieldValues_Resource::patch ( $profileId,
$creativeFieldId,
$id,
Google_Service_Dfareporting_CreativeFieldValue $postBody,
$optParams = array() )

Updates an existing creative field value.

This method supports patch semantics. (creativeFieldValues.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
string$idCreative Field Value ID
Google_CreativeFieldValue$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeFieldValue

◆ update()

Google_Service_Dfareporting_CreativeFieldValues_Resource::update ( $profileId,
$creativeFieldId,
Google_Service_Dfareporting_CreativeFieldValue $postBody,
$optParams = array() )

Updates an existing creative field value.

(creativeFieldValues.update)

Parameters
string$profileIdUser profile ID associated with this request.
string$creativeFieldIdCreative field ID for this creative field value.
Google_CreativeFieldValue$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_CreativeFieldValue

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