Documentation

Google_Service_Dfareporting_Resource_Sites extends Google_Service_Resource
in package

The "sites" collection of methods.

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

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_Site
Gets one site by ID. (sites.get)
insert()  : Google_Service_Dfareporting_Site
Inserts a new site. (sites.insert)
listSites()  : Google_Service_Dfareporting_SitesListResponse
Retrieves a list of sites, possibly filtered. This method supports paging.
patch()  : Google_Service_Dfareporting_Site
Updates an existing site. This method supports patch semantics. (sites.patch)
update()  : Google_Service_Dfareporting_Site
Updates an existing site. (sites.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

get()

Gets one site by ID. (sites.get)

public get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Site
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Site ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Site —

listSites()

Retrieves a list of sites, possibly filtered. This method supports paging.

public listSites(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_SitesListResponse

(sites.listSites)

Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string subaccountId Select only sites with this subaccount ID.

opt_param

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

opt_param

string sortField Field by which to sort the list.

opt_param

string campaignIds Select only sites with these campaign IDs.

opt_param

bool acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements.

opt_param

bool unmappedSite Select only sites that have not been mapped to a directory site.

opt_param

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

opt_param

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

opt_param

int maxResults Maximum number of results to return.

opt_param

bool adWordsSite Select only AdWords sites.

opt_param

string directorySiteIds Select only sites with these directory site IDs.

opt_param

string ids Select only sites with these IDs.

opt_param

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

opt_param

string sortOrder Order of sorted results.

opt_param

bool approved Select only approved sites.

Return values
Google_Service_Dfareporting_SitesListResponse —

patch()

Updates an existing site. This method supports patch semantics. (sites.patch)

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

User profile ID associated with this request.

$id : string

Site ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Site —

convertToArrayAndStripNulls()

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

Search results