Google_Service_Dfareporting_CreativeFields_Resource Class Reference

The "creativeFields" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_CreativeFields_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "creativeFields" collection of methods.

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

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

Deletes an existing creative field.

(creativeFields.delete)

Parameters

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

get()

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

Gets one creative field by ID.

(creativeFields.get)

Parameters

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

Return values

Google_Service_Dfareporting_CreativeField

insert()

Google_Service_Dfareporting_CreativeFields_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_CreativeField	$postBody,
			$optParams = array() )

Inserts a new creative field.

(creativeFields.insert)

Parameters

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

Return values

Google_Service_Dfareporting_CreativeField

listCreativeFields()

Google_Service_Dfareporting_CreativeFields_Resource::listCreativeFields	(		$profileId,
			$optParams = array() )

Retrieves a list of creative fields, possibly filtered.

(creativeFields.listCreativeFields)

Parameters

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

@opt_param string searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 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 "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". @opt_param string sortField Field by which to sort the list. @opt_param string advertiserIds Select only creative fields that belong to these advertisers. @opt_param string ids Select only creative fields 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_CreativeFieldsListResponse

patch()

Google_Service_Dfareporting_CreativeFields_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_CreativeField	$postBody,
			$optParams = array() )

Updates an existing creative field.

This method supports patch semantics. (creativeFields.patch)

Parameters

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

Return values

Google_Service_Dfareporting_CreativeField

update()

Google_Service_Dfareporting_CreativeFields_Resource::update	(		$profileId,
		Google_Service_Dfareporting_CreativeField	$postBody,
			$optParams = array() )

Updates an existing creative field.

(creativeFields.update)

Parameters

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

Return values

Google_Service_Dfareporting_CreativeField

---

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

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