Google_Service_Dfareporting_Creatives_Resource Class Reference

The "creatives" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Creatives_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "creatives" collection of methods.

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

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

Gets one creative by ID.

(creatives.get)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Creative ID.
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Creative

insert()

Google_Service_Dfareporting_Creatives_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Creative	$postBody,
			$optParams = array() )

Inserts a new creative.

(creatives.insert)

Parameters

string	$profileId	User profile ID associated with this request.
Google_Creative	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Creative

listCreatives()

Google_Service_Dfareporting_Creatives_Resource::listCreatives	(		$profileId,
			$optParams = array() )

Retrieves a list of creatives, possibly filtered.

(creatives.listCreatives)

Parameters

string	$profileId	User profile ID associated with this request.
array	$optParams	Optional parameters.

@opt_param string sizeIds Select only creatives with these size IDs. @opt_param bool archived Select only archived creatives. Leave blank to select archived and unarchived creatives. @opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 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 "creative" will match objects with name "my creative", "creative 2015", or simply "creative". @opt_param string campaignId Select only creatives with this campaign ID. @opt_param string sortField Field by which to sort the list. @opt_param string renderingIds Select only creatives with these rendering IDs. @opt_param string ids Select only creatives with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string advertiserId Select only creatives with this advertiser ID. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string studioCreativeId Select only creatives corresponding to this Studio creative ID. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string companionCreativeIds Select only in-stream video creatives with these companion IDs. @opt_param bool active Select only active creatives. Leave blank to select active and inactive creatives. @opt_param string creativeFieldIds Select only creatives with these creative field IDs. @opt_param string types Select only creatives with these creative types.

Return values

Google_Service_Dfareporting_CreativesListResponse

patch()

Google_Service_Dfareporting_Creatives_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Creative	$postBody,
			$optParams = array() )

Updates an existing creative.

This method supports patch semantics. (creatives.patch)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Creative ID.
Google_Creative	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Creative

update()

Google_Service_Dfareporting_Creatives_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Creative	$postBody,
			$optParams = array() )

Updates an existing creative.

(creatives.update)

Parameters

string	$profileId	User profile ID associated with this request.
Google_Creative	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Creative

---

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

• lib/google/src/Google/Service/Dfareporting.php