Google_Service_Dfareporting_Ads_Resource Class Reference

The "ads" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Ads_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "ads" collection of methods.

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

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

Gets one ad by ID.

(ads.get)

Parameters

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

Return values

Google_Service_Dfareporting_Ad

insert()

Google_Service_Dfareporting_Ads_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Ad	$postBody,
			$optParams = array() )

Inserts a new ad.

(ads.insert)

Parameters

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

Return values

Google_Service_Dfareporting_Ad

listAds()

Google_Service_Dfareporting_Ads_Resource::listAds	(		$profileId,
			$optParams = array() )

Retrieves a list of ads, possibly filtered.

(ads.listAds)

Parameters

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

@opt_param string landingPageIds Select only ads with these landing page IDs. @opt_param string overriddenEventTagId Select only ads with this event tag override ID. @opt_param string campaignIds Select only ads with these campaign IDs. @opt_param bool archived Select only archived ads. @opt_param string creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. @opt_param bool sslCompliant Select only ads that are SSL-compliant. @opt_param string sizeIds Select only ads with these size 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. @opt_param string type Select only ads with these types. @opt_param bool sslRequired Select only ads that require SSL. @opt_param string creativeIds Select only ads with these creative IDs assigned. @opt_param int maxResults Maximum number of results to return. @opt_param string creativeType Select only ads with the specified creativeType. @opt_param string placementIds Select only ads with these placement IDs assigned. @opt_param bool active Select only active ads. @opt_param string compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in- stream video ads developed with the VAST standard. @opt_param string advertiserId Select only ads with this advertiser ID. @opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad". @opt_param string sortField Field by which to sort the list. @opt_param string audienceSegmentIds Select only ads with these audience segment IDs. @opt_param string ids Select only ads with these IDs. @opt_param string remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. @opt_param bool dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Return values

Google_Service_Dfareporting_AdsListResponse

patch()

Google_Service_Dfareporting_Ads_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Ad	$postBody,
			$optParams = array() )

Updates an existing ad.

This method supports patch semantics. (ads.patch)

Parameters

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

Return values

Google_Service_Dfareporting_Ad

update()

Google_Service_Dfareporting_Ads_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Ad	$postBody,
			$optParams = array() )

Updates an existing ad.

(ads.update)

Parameters

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

Return values

Google_Service_Dfareporting_Ad

---

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

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