Reference documentation and code samples for the Google Ads Data Manager V1 Client class RemoveAllAudienceMembersRequest.
Request to remove all users from an audience in the provided destinations.
Returns a RemoveAllAudienceMembersResponse.
Generated from protobuf message google.ads.datamanager.v1.RemoveAllAudienceMembersRequest
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ destinations |
array<Destination>
Required. The list of destinations to remove the users from. |
↳ remove_as_of_time |
Google\Protobuf\Timestamp
Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future. |
↳ validate_only |
bool
Optional. For testing purposes. If |
getDestinations
Required. The list of destinations to remove the users from.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Destination> |
|
setDestinations
Required. The list of destinations to remove the users from.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Destination>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRemoveAsOfTime
Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time.
The remove as of time must not be in the future.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasRemoveAsOfTime
clearRemoveAsOfTime
setRemoveAsOfTime
Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time.
The remove as of time must not be in the future.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidateOnly
Optional. For testing purposes. If true, the request is validated but not
executed. Only errors are returned, not results.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
Optional. For testing purposes. If true, the request is validated but not
executed. Only errors are returned, not results.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|