class Advertisers extends Resource (View source)

The "advertisers" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $advertisers = $displayvideoService->advertisers;

Methods

audit(string $advertiserId, array $optParams = [])

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.

create(Advertiser $postBody, array $optParams = [])

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

delete(string $advertiserId, array $optParams = [])

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)

editAssignedTargetingOptions(string $advertiserId, BulkEditAdvertiserAssignedTargetingOptionsRequest $postBody, array $optParams = [])

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 .

get(string $advertiserId, array $optParams = [])

Gets an advertiser. (advertisers.get)

listAdvertisers(array $optParams = [])

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)

listAssignedTargetingOptions(string $advertiserId, array $optParams = [])

Lists assigned targeting options of an advertiser across targeting types.

patch(string $advertiserId, Advertiser $postBody, array $optParams = [])

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

Details

AuditAdvertiserResponse audit(string $advertiserId, array $optParams = [])

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.

(advertisers.audit)

Parameters

string $advertiserId

Required. The ID of the advertiser to audit.

array $optParams

Optional parameters.

Return Value

AuditAdvertiserResponse

Exceptions

Exception

Advertiser create(Advertiser $postBody, array $optParams = [])

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

This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors. (advertisers.create)

Parameters

Advertiser $postBody
array $optParams

Optional parameters.

Return Value

Advertiser

Exceptions

Exception

DisplayvideoEmpty delete(string $advertiserId, array $optParams = [])

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)

Parameters

string $advertiserId

The ID of the advertiser we need to delete.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

BulkEditAdvertiserAssignedTargetingOptionsResponse editAssignedTargetingOptions(string $advertiserId, BulkEditAdvertiserAssignedTargetingOptionsRequest $postBody, array $optParams = [])

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 .

(advertisers.editAssignedTargetingOptions)

Parameters

string $advertiserId

Required. The ID of the advertiser.

BulkEditAdvertiserAssignedTargetingOptionsRequest $postBody
array $optParams

Optional parameters.

Return Value

BulkEditAdvertiserAssignedTargetingOptionsResponse

Exceptions

Exception

Advertiser get(string $advertiserId, array $optParams = [])

Gets an advertiser. (advertisers.get)

Parameters

string $advertiserId

Required. The ID of the advertiser to fetch.

array $optParams

Optional parameters.

Return Value

Advertiser

Exceptions

Exception

ListAdvertisersResponse listAdvertisers(array $optParams = [])

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)

Parameters

array $optParams

Optional parameters.

Return Value

ListAdvertisersResponse

Exceptions

Exception

BulkListAdvertiserAssignedTargetingOptionsResponse listAssignedTargetingOptions(string $advertiserId, array $optParams = [])

Lists assigned targeting options of an advertiser across targeting types.

(advertisers.listAssignedTargetingOptions)

Parameters

string $advertiserId

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

array $optParams

Optional parameters.

Return Value

BulkListAdvertiserAssignedTargetingOptionsResponse

Exceptions

Exception

Advertiser patch(string $advertiserId, Advertiser $postBody, array $optParams = [])

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

(advertisers.patch)

Parameters

string $advertiserId

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

Advertiser $postBody
array $optParams

Optional parameters.

Return Value

Advertiser

Exceptions

Exception