Documentation

Google_Service_Dfareporting_Resource_PlacementGroups extends Google_Service_Resource
in package

The "placementGroups" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Dfareporting_PlacementGroup
Gets one placement group by ID. (placementGroups.get)
insert()  : Google_Service_Dfareporting_PlacementGroup
Inserts a new placement group. (placementGroups.insert)
listPlacementGroups()  : Google_Service_Dfareporting_PlacementGroupsListResponse
Retrieves a list of placement groups, possibly filtered. This method supports paging. (placementGroups.listPlacementGroups)
patch()  : Google_Service_Dfareporting_PlacementGroup
Updates an existing placement group. This method supports patch semantics.
update()  : Google_Service_Dfareporting_PlacementGroup
Updates an existing placement group. (placementGroups.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

insert()

Inserts a new placement group. (placementGroups.insert)

public insert(string $profileId, Google_Service_Dfareporting_PlacementGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_PlacementGroup
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_PlacementGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_PlacementGroup —

listPlacementGroups()

Retrieves a list of placement groups, possibly filtered. This method supports paging. (placementGroups.listPlacementGroups)

public listPlacementGroups(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_PlacementGroupsListResponse
Parameters
$profileId : string

User profile ID associated with this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string contentCategoryIds Select only placement groups that are associated with these content categories.

opt_param

string maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

opt_param

string siteIds Select only placement groups that are associated with these sites.

opt_param

int maxResults Maximum number of results to return.

opt_param

bool archived Select only archived placements. Don't set this field to select both archived and non-archived placements.

opt_param

string directorySiteIds Select only placement groups that are associated with these directory sites.

opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string campaignIds Select only placement groups that belong to these campaigns.

opt_param

string advertiserIds Select only placement groups that belong to these advertisers.

opt_param

string pricingTypes Select only placement groups with these pricing types.

opt_param

string placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.

opt_param

string minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

opt_param

string placementStrategyIds Select only placement groups that are associated with these placement strategies.

opt_param

string sortField Field by which to sort the list.

opt_param

string searchString Allows searching for placement groups by name or ID. Wildcards () are allowed. For example, "placement2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 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 "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".

opt_param

string sortOrder Order of sorted results.

opt_param

string maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

opt_param

string minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

opt_param

string ids Select only placement groups with these IDs.

Return values
Google_Service_Dfareporting_PlacementGroupsListResponse —

patch()

Updates an existing placement group. This method supports patch semantics.

public patch(string $profileId, string $id, Google_Service_Dfareporting_PlacementGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_PlacementGroup

(placementGroups.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

PlacementGroup ID.

$postBody : Google_Service_Dfareporting_PlacementGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_PlacementGroup —

update()

Updates an existing placement group. (placementGroups.update)

public update(string $profileId, Google_Service_Dfareporting_PlacementGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_PlacementGroup
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_PlacementGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_PlacementGroup —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results