Documentation

Google_Service_Dfareporting_Resource_ContentCategories extends Google_Service_Resource
in package

The "contentCategories" collection of methods.

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

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.
delete()  : mixed
Deletes an existing content category. (contentCategories.delete)
get()  : Google_Service_Dfareporting_ContentCategory
Gets one content category by ID. (contentCategories.get)
insert()  : Google_Service_Dfareporting_ContentCategory
Inserts a new content category. (contentCategories.insert)
listContentCategories()  : Google_Service_Dfareporting_ContentCategoriesListResponse
Retrieves a list of content categories, possibly filtered. This method supports paging. (contentCategories.listContentCategories)
patch()  : Google_Service_Dfareporting_ContentCategory
Updates an existing content category. This method supports patch semantics.
update()  : Google_Service_Dfareporting_ContentCategory
Updates an existing content category. (contentCategories.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

delete()

Deletes an existing content category. (contentCategories.delete)

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

User profile ID associated with this request.

$id : string

Content category ID.

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

Optional parameters.

Return values
mixed —

insert()

Inserts a new content category. (contentCategories.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_ContentCategory —

listContentCategories()

Retrieves a list of content categories, possibly filtered. This method supports paging. (contentCategories.listContentCategories)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum number of results to return.

opt_param

string sortField Field by which to sort the list.

opt_param

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

opt_param

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

opt_param

string sortOrder Order of sorted results.

opt_param

string ids Select only content categories with these IDs.

Return values
Google_Service_Dfareporting_ContentCategoriesListResponse —

patch()

Updates an existing content category. This method supports patch semantics.

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

(contentCategories.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

ContentCategory ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_ContentCategory —

update()

Updates an existing content category. (contentCategories.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_ContentCategory —

convertToArrayAndStripNulls()

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

Search results