class AdvertiserGroups extends Resource (View source)

The "advertiserGroups" collection of methods.

Typical usage is:

 $dfareportingService = new Google\Service\Dfareporting(...);
 $advertiserGroups = $dfareportingService->advertiserGroups;

Methods

delete(string $profileId, string $id, array $optParams = [])

Deletes an existing advertiser group. (advertiserGroups.delete)

get(string $profileId, string $id, array $optParams = [])

Gets one advertiser group by ID. (advertiserGroups.get)

insert(string $profileId, AdvertiserGroup $postBody, array $optParams = [])

Inserts a new advertiser group. (advertiserGroups.insert)

listAdvertiserGroups(string $profileId, array $optParams = [])

Retrieves a list of advertiser groups, possibly filtered. This method supports paging. (advertiserGroups.listAdvertiserGroups)

patch(string $profileId, string $id, AdvertiserGroup $postBody, array $optParams = [])

Updates an existing advertiser group. This method supports patch semantics.

update(string $profileId, AdvertiserGroup $postBody, array $optParams = [])

Updates an existing advertiser group. (advertiserGroups.update)

Details

delete(string $profileId, string $id, array $optParams = [])

Deletes an existing advertiser group. (advertiserGroups.delete)

Parameters

string $profileId

User profile ID associated with this request.

string $id

Advertiser group ID.

array $optParams

Optional parameters.

Exceptions

Exception

AdvertiserGroup get(string $profileId, string $id, array $optParams = [])

Gets one advertiser group by ID. (advertiserGroups.get)

Parameters

string $profileId

User profile ID associated with this request.

string $id

Advertiser group ID.

array $optParams

Optional parameters.

Return Value

AdvertiserGroup

Exceptions

Exception

AdvertiserGroup insert(string $profileId, AdvertiserGroup $postBody, array $optParams = [])

Inserts a new advertiser group. (advertiserGroups.insert)

Parameters

string $profileId

User profile ID associated with this request.

AdvertiserGroup $postBody
array $optParams

Optional parameters.

Return Value

AdvertiserGroup

Exceptions

Exception

AdvertiserGroupsListResponse listAdvertiserGroups(string $profileId, array $optParams = [])

Retrieves a list of advertiser groups, possibly filtered. This method supports paging. (advertiserGroups.listAdvertiserGroups)

Parameters

string $profileId

User profile ID associated with this request.

array $optParams

Optional parameters.

Return Value

AdvertiserGroupsListResponse

Exceptions

Exception

AdvertiserGroup patch(string $profileId, string $id, AdvertiserGroup $postBody, array $optParams = [])

Updates an existing advertiser group. This method supports patch semantics.

(advertiserGroups.patch)

Parameters

string $profileId

User profile ID associated with this request.

string $id

Required. Advertiser Group ID.

AdvertiserGroup $postBody
array $optParams

Optional parameters.

Return Value

AdvertiserGroup

Exceptions

Exception

AdvertiserGroup update(string $profileId, AdvertiserGroup $postBody, array $optParams = [])

Updates an existing advertiser group. (advertiserGroups.update)

Parameters

string $profileId

User profile ID associated with this request.

AdvertiserGroup $postBody
array $optParams

Optional parameters.

Return Value

AdvertiserGroup

Exceptions

Exception