Documentation

Google_Service_DisplayVideo_Resource_Advertisers extends Google_Service_Resource
in package

The "advertisers" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $advertisers = $displayvideoService->advertisers;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
audit()  : Google_Service_DisplayVideo_AuditAdvertiserResponse
Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
bulkEditAdvertiserAssignedTargetingOptions()  : Google_Service_DisplayVideo_BulkEditAdvertiserAssignedTargetingOptionsResponse
Bulk edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
bulkListAdvertiserAssignedTargetingOptions()  : Google_Service_DisplayVideo_BulkListAdvertiserAssignedTargetingOptionsResponse
Lists assigned targeting options of an advertiser across targeting types.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DisplayVideo_Advertiser
Creates a new advertiser. Returns the newly created advertiser if successful.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. (advertisers.delete)
get()  : Google_Service_DisplayVideo_Advertiser
Gets an advertiser. (advertisers.get)
listAdvertisers()  : Google_Service_DisplayVideo_ListAdvertisersResponse
Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross- partner listing is not supported. (advertisers.listAdvertisers)
patch()  : Google_Service_DisplayVideo_Advertiser
Updates an existing advertiser. Returns the updated advertiser if successful.
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 —

audit()

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

public audit(string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_AuditAdvertiserResponse

(advertisers.audit)

Parameters
$advertiserId : string

Required. The ID of the advertiser to audit.

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

Optional parameters.

Tags
opt_param

string readMask Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount

Return values
Google_Service_DisplayVideo_AuditAdvertiserResponse —

bulkEditAdvertiserAssignedTargetingOptions()

Bulk edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .

public bulkEditAdvertiserAssignedTargetingOptions(string $advertiserId, Google_Service_DisplayVideo_BulkEditAdvertiserAssignedTargetingOptionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditAdvertiserAssignedTargetingOptionsResponse

(advertisers.bulkEditAdvertiserAssignedTargetingOptions)

Parameters
$advertiserId : string

Required. The ID of the advertiser.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_BulkEditAdvertiserAssignedTargetingOptionsResponse —

bulkListAdvertiserAssignedTargetingOptions()

Lists assigned targeting options of an advertiser across targeting types.

public bulkListAdvertiserAssignedTargetingOptions(string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkListAdvertiserAssignedTargetingOptionsResponse

(advertisers.bulkListAdvertiserAssignedTargetingOptions)

Parameters
$advertiserId : string

Required. The ID of the advertiser the line item belongs to.

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

Optional parameters.

Tags
opt_param

string filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR.. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=). * Supported fields: - targetingType Examples: * targetingType with value TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_CHANNEL" The length of this field should be no more than 500 characters.

opt_param

int pageSize Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is '5000'. Returns error code INVALID_ARGUMENT if an invalid value is specified.

opt_param

string orderBy Field by which to sort the list. Acceptable values are: * targetingType (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.

opt_param

string pageToken A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to BulkListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.

Return values
Google_Service_DisplayVideo_BulkListAdvertiserAssignedTargetingOptionsResponse —

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 —

create()

Creates a new advertiser. Returns the newly created advertiser if successful.

public create(Google_Service_DisplayVideo_Advertiser $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_Advertiser

This method can take up to 180 seconds to complete. (advertisers.create)

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

Optional parameters.

Return values
Google_Service_DisplayVideo_Advertiser —

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 advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. (advertisers.delete)

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

The ID of the advertiser we need to delete.

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

Optional parameters.

Return values
Google_Service_DisplayVideo_DisplayvideoEmpty —

listAdvertisers()

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross- partner listing is not supported. (advertisers.listAdvertisers)

public listAdvertisers([array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListAdvertisersResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string orderBy Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

opt_param

int pageSize Requested page size. Must be between 1 and 100. If unspecified will default to 100.

opt_param

string filter Allows filtering by advertiser properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=). * Supported fields: - advertiserId - displayName - entityStatus Examples:

  • All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters.
opt_param

string partnerId Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdvertisers method. If not specified, the first page of results will be returned.

Return values
Google_Service_DisplayVideo_ListAdvertisersResponse —

patch()

Updates an existing advertiser. Returns the updated advertiser if successful.

public patch(string $advertiserId, Google_Service_DisplayVideo_Advertiser $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_Advertiser

(advertisers.patch)

Parameters
$advertiserId : string

Output only. The unique ID of the advertiser. Assigned by the system.

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

Optional parameters.

Tags
opt_param

string updateMask Required. The mask to control which fields to update.

Return values
Google_Service_DisplayVideo_Advertiser —

convertToArrayAndStripNulls()

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

Search results