1. class
  2. Google
  3. \
  4. Service
  5. \
  6. RealTimeBidding
  7. \
  8. Resource
  9. \
  10. BiddersPretargetingConfigs

BiddersPretargetingConfigs

class BiddersPretargetingConfigs extends Resource (View source)

The "pretargetingConfigs" collection of methods.

Typical usage is:

 $realtimebiddingService = new Google\Service\RealTimeBidding(...);
 $pretargetingConfigs = $realtimebiddingService->bidders_pretargetingConfigs;

Methods

PretargetingConfig
activate(string $name, ActivatePretargetingConfigRequest $postBody, array $optParams = [])

Activates a pretargeting configuration. (pretargetingConfigs.activate)

PretargetingConfig
addTargetedApps(string $pretargetingConfig, AddTargetedAppsRequest $postBody, array $optParams = [])

Adds targeted apps to the pretargeting configuration.

PretargetingConfig
addTargetedPublishers(string $pretargetingConfig, AddTargetedPublishersRequest $postBody, array $optParams = [])

Adds targeted publishers to the pretargeting config.

PretargetingConfig
addTargetedSites(string $pretargetingConfig, AddTargetedSitesRequest $postBody, array $optParams = [])

Adds targeted sites to the pretargeting configuration.

PretargetingConfig
create(string $parent, PretargetingConfig $postBody, array $optParams = [])

Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error. (pretargetingConfigs.create)

RealtimebiddingEmpty
delete(string $name, array $optParams = [])

Deletes a pretargeting configuration. (pretargetingConfigs.delete)

PretargetingConfig
get(string $name, array $optParams = [])

Gets a pretargeting configuration. (pretargetingConfigs.get)

ListPretargetingConfigsResponse
listBiddersPretargetingConfigs(string $parent, array $optParams = [])

Lists all pretargeting configurations for a single bidder.

PretargetingConfig
patch(string $name, PretargetingConfig $postBody, array $optParams = [])

Updates a pretargeting configuration. (pretargetingConfigs.patch)

PretargetingConfig
removeTargetedApps(string $pretargetingConfig, RemoveTargetedAppsRequest $postBody, array $optParams = [])

Removes targeted apps from the pretargeting configuration.

PretargetingConfig
removeTargetedPublishers(string $pretargetingConfig, RemoveTargetedPublishersRequest $postBody, array $optParams = [])

Removes targeted publishers from the pretargeting config.

PretargetingConfig
removeTargetedSites(string $pretargetingConfig, RemoveTargetedSitesRequest $postBody, array $optParams = [])

Removes targeted sites from the pretargeting configuration.

PretargetingConfig
suspend(string $name, SuspendPretargetingConfigRequest $postBody, array $optParams = [])

Suspends a pretargeting configuration. (pretargetingConfigs.suspend)

Details

at line 52
PretargetingConfig activate(string $name, ActivatePretargetingConfigRequest $postBody, array $optParams = [])

Activates a pretargeting configuration. (pretargetingConfigs.activate)

Parameters

string $name

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
ActivatePretargetingConfigRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 70
PretargetingConfig addTargetedApps(string $pretargetingConfig, AddTargetedAppsRequest $postBody, array $optParams = [])

Adds targeted apps to the pretargeting configuration.

(pretargetingConfigs.addTargetedApps)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
AddTargetedAppsRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 88
PretargetingConfig addTargetedPublishers(string $pretargetingConfig, AddTargetedPublishersRequest $postBody, array $optParams = [])

Adds targeted publishers to the pretargeting config.

(pretargetingConfigs.addTargetedPublishers)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
AddTargetedPublishersRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 106
PretargetingConfig addTargetedSites(string $pretargetingConfig, AddTargetedSitesRequest $postBody, array $optParams = [])

Adds targeted sites to the pretargeting configuration.

(pretargetingConfigs.addTargetedSites)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
AddTargetedSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 126
PretargetingConfig create(string $parent, PretargetingConfig $postBody, array $optParams = [])

Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error. (pretargetingConfigs.create)

Parameters

string $parent

Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId}
PretargetingConfig $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 141
RealtimebiddingEmpty delete(string $name, array $optParams = [])

Deletes a pretargeting configuration. (pretargetingConfigs.delete)

Parameters

string $name

Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
array $optParams

Optional parameters.

Return Value

RealtimebiddingEmpty

Exceptions

Exception

at line 156
PretargetingConfig get(string $name, array $optParams = [])

Gets a pretargeting configuration. (pretargetingConfigs.get)

Parameters

string $name

Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 180
ListPretargetingConfigsResponse listBiddersPretargetingConfigs(string $parent, array $optParams = [])

Lists all pretargeting configurations for a single bidder.

(pretargetingConfigs.listBiddersPretargetingConfigs)

Parameters

string $parent

Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId}
array $optParams

Optional parameters.

Return Value

ListPretargetingConfigsResponse

Exceptions

Exception

at line 199
PretargetingConfig patch(string $name, PretargetingConfig $postBody, array $optParams = [])

Updates a pretargeting configuration. (pretargetingConfigs.patch)

Parameters

string $name

Output only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}
PretargetingConfig $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 217
PretargetingConfig removeTargetedApps(string $pretargetingConfig, RemoveTargetedAppsRequest $postBody, array $optParams = [])

Removes targeted apps from the pretargeting configuration.

(pretargetingConfigs.removeTargetedApps)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
RemoveTargetedAppsRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 235
PretargetingConfig removeTargetedPublishers(string $pretargetingConfig, RemoveTargetedPublishersRequest $postBody, array $optParams = [])

Removes targeted publishers from the pretargeting config.

(pretargetingConfigs.removeTargetedPublishers)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
RemoveTargetedPublishersRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 253
PretargetingConfig removeTargetedSites(string $pretargetingConfig, RemoveTargetedSitesRequest $postBody, array $optParams = [])

Removes targeted sites from the pretargeting configuration.

(pretargetingConfigs.removeTargetedSites)

Parameters

string $pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
RemoveTargetedSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception

at line 269
PretargetingConfig suspend(string $name, SuspendPretargetingConfigRequest $postBody, array $optParams = [])

Suspends a pretargeting configuration. (pretargetingConfigs.suspend)

Parameters

string $name

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
SuspendPretargetingConfigRequest $postBody
array $optParams

Optional parameters.

Return Value

PretargetingConfig

Exceptions

Exception