Documentation

Google_Service_Dfareporting_Resource_DirectorySites extends Google_Service_Resource
in package

The "directorySites" collection of methods.

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

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_DirectorySite
Gets one directory site by ID. (directorySites.get)
insert()  : Google_Service_Dfareporting_DirectorySite
Inserts a new directory site. (directorySites.insert)
listDirectorySites()  : Google_Service_Dfareporting_DirectorySitesListResponse
Retrieves a list of directory sites, possibly filtered. This method supports paging. (directorySites.listDirectorySites)
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 directory site. (directorySites.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_DirectorySite —

listDirectorySites()

Retrieves a list of directory sites, possibly filtered. This method supports paging. (directorySites.listDirectorySites)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string dfpNetworkCode Select only directory sites with this Ad Manager network code.

opt_param

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

opt_param

string ids Select only directory sites with these IDs.

opt_param

bool acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned.

opt_param

string sortField Field by which to sort the list.

opt_param

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

opt_param

int maxResults Maximum number of results to return.

opt_param

string sortOrder Order of sorted results.

opt_param

bool acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned.

opt_param

bool active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

opt_param

bool acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank.

Return values
Google_Service_Dfareporting_DirectorySitesListResponse —

convertToArrayAndStripNulls()

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

Search results