Google_Service_Dfareporting_Campaigns_Resource Class Reference

The "campaigns" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Campaigns_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "campaigns" collection of methods.

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

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

Gets one campaign by ID.

(campaigns.get)

Parameters

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

Return values

Google_Service_Dfareporting_Campaign

insert()

Google_Service_Dfareporting_Campaigns_Resource::insert	(		$profileId,
			$defaultLandingPageName,
			$defaultLandingPageUrl,
		Google_Service_Dfareporting_Campaign	$postBody,
			$optParams = array() )

Inserts a new campaign.

(campaigns.insert)

Parameters

string	$profileId	User profile ID associated with this request.
string	$defaultLandingPageName	Default landing page name for this new campaign. Must be less than 256 characters long.
string	$defaultLandingPageUrl	Default landing page URL for this new campaign.
Google_Campaign	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Campaign

listCampaigns()

Google_Service_Dfareporting_Campaigns_Resource::listCampaigns	(		$profileId,
			$optParams = array() )

Retrieves a list of campaigns, possibly filtered.

(campaigns.listCampaigns)

Parameters

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

@opt_param bool archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. @opt_param string searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". @opt_param string subaccountId Select only campaigns that belong to this subaccount. @opt_param string sortField Field by which to sort the list. @opt_param string advertiserIds Select only campaigns that belong to these advertisers. @opt_param string ids Select only campaigns with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string excludedIds Exclude campaigns with these IDs. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string overriddenEventTagId Select only campaigns that have overridden this event tag ID. @opt_param bool atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity.

Return values

Google_Service_Dfareporting_CampaignsListResponse

patch()

Google_Service_Dfareporting_Campaigns_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Campaign	$postBody,
			$optParams = array() )

Updates an existing campaign.

This method supports patch semantics. (campaigns.patch)

Parameters

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

Return values

Google_Service_Dfareporting_Campaign

update()

Google_Service_Dfareporting_Campaigns_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Campaign	$postBody,
			$optParams = array() )

Updates an existing campaign.

(campaigns.update)

Parameters

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

Return values

Google_Service_Dfareporting_Campaign

---

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

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