Documentation

Google_Service_Dfareporting_Resource_Placements extends Google_Service_Resource
in package

The "placements" collection of methods.

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

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.
generatetags()  : Google_Service_Dfareporting_PlacementsGenerateTagsResponse
Generates tags for a placement. (placements.generatetags)
get()  : Google_Service_Dfareporting_Placement
Gets one placement by ID. (placements.get)
insert()  : Google_Service_Dfareporting_Placement
Inserts a new placement. (placements.insert)
listPlacements()  : Google_Service_Dfareporting_PlacementsListResponse
Retrieves a list of placements, possibly filtered. This method supports paging. (placements.listPlacements)
patch()  : Google_Service_Dfareporting_Placement
Updates an existing placement. This method supports patch semantics.
update()  : Google_Service_Dfareporting_Placement
Updates an existing placement. (placements.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

generatetags()

Generates tags for a placement. (placements.generatetags)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

opt_param

string placementIds Generate tags for these placements.

opt_param

string campaignId Generate placements belonging to this campaign. This is a required field.

Return values
Google_Service_Dfareporting_PlacementsGenerateTagsResponse —

insert()

Inserts a new placement. (placements.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Placement —

listPlacements()

Retrieves a list of placements, possibly filtered. This method supports paging. (placements.listPlacements)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string ids Select only placements with these IDs.

opt_param

string campaignIds Select only placements that belong to these campaigns.

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 sortField Field by which to sort the list.

opt_param

string sizeIds Select only placements that are associated with these sizes.

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 pageToken Value of the nextPageToken from the previous result page.

opt_param

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

opt_param

string siteIds Select only placements that are associated with these sites.

opt_param

string compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_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 in in-stream video ads developed with the VAST standard.

opt_param

string advertiserIds Select only placements that belong to these advertisers.

opt_param

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

opt_param

string sortOrder Order of sorted results.

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 placementStrategyIds Select only placements that are associated with these placement strategies.

opt_param

string paymentSource Select only placements with this payment source.

opt_param

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

opt_param

string pricingTypes Select only placements with these pricing types.

opt_param

string groupIds Select only placements that belong to these placement groups.

opt_param

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

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

int maxResults Maximum number of results to return.

Return values
Google_Service_Dfareporting_PlacementsListResponse —

patch()

Updates an existing placement. This method supports patch semantics.

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

(placements.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Placement ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Placement —

update()

Updates an existing placement. (placements.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Placement —

convertToArrayAndStripNulls()

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

Search results