Documentation

Google_Service_Dfareporting_Resource_OrderDocuments extends Google_Service_Resource
in package

The "orderDocuments" collection of methods.

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

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_OrderDocument
Gets one order document by ID. (orderDocuments.get)
listOrderDocuments()  : Google_Service_Dfareporting_OrderDocumentsListResponse
Retrieves a list of order documents, possibly filtered. This method supports paging. (orderDocuments.listOrderDocuments)
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 order document by ID. (orderDocuments.get)

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

User profile ID associated with this request.

$projectId : string

Project ID for order documents.

$id : string

Order document ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_OrderDocument —

listOrderDocuments()

Retrieves a list of order documents, possibly filtered. This method supports paging. (orderDocuments.listOrderDocuments)

public listOrderDocuments(string $profileId, string $projectId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_OrderDocumentsListResponse
Parameters
$profileId : string

User profile ID associated with this request.

$projectId : string

Project ID for order documents.

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

Optional parameters.

Tags
opt_param

string ids Select only order documents with these IDs.

opt_param

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

opt_param

bool approved Select only order documents that have been approved by at least one user.

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

opt_param

string orderId Select only order documents for specified orders.

opt_param

string siteId Select only order documents that are associated with these sites.

opt_param

string sortOrder Order of sorted results.

Return values
Google_Service_Dfareporting_OrderDocumentsListResponse —

convertToArrayAndStripNulls()

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

Search results