Reference documentation and code samples for the Google Ads Data Manager V1 Client class RemoveAudienceMembersRequest.
Request to remove users from an audience in the provided destinations.
Returns a RemoveAudienceMembersResponse.
Generated from protobuf message google.ads.datamanager.v1.RemoveAudienceMembersRequest
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. |
↳ audience_members |
array<AudienceMember>
Required. The list of users to remove. |
↳ validate_only |
bool
Optional. For testing purposes. If |
↳ encoding |
int
Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non |
↳ encryption_info |
EncryptionInfo
Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non |
getDestinations
Required. The list of destinations to remove the users from.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDestinations
Required. The list of destinations to remove the users from.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Destination>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAudienceMembers
Required. The list of users to remove.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAudienceMembers
Required. The list of users to remove.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AudienceMember>
|
| 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 |
|
getEncoding
Optional. Required for UserData
uploads. The encoding type of the user identifiers. Applies to only the
outer encoding for encrypted user identifiers. For non UserData uploads,
this field is ignored.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Encoding. |
setEncoding
Optional. Required for UserData
uploads. The encoding type of the user identifiers. Applies to only the
outer encoding for encrypted user identifiers. For non UserData uploads,
this field is ignored.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Encoding. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionInfo
Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted.
For non UserData uploads, this field is ignored.
| Returns | |
|---|---|
| Type | Description |
EncryptionInfo|null |
|
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted.
For non UserData uploads, this field is ignored.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|