Reference documentation and code samples for the Google Ads Data Manager V1 Client class IngestUsersRequest.
Request to upload users to the provided destinations.
Generated from protobuf message google.ads.datamanager.v1.IngestUsersRequest
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 possible ingestion destinations. |
↳ users |
array<User>
Required. The list of users to ingest. |
↳ encryption_info |
EncryptionInfo
Optional. Encryption information about encryption keys which are used to encrypt the data. |
↳ validate_only |
bool
Optional. If |
↳ encoding |
int
Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding. |
getDestinations
Required. The list of possible ingestion destinations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Destination> |
|
setDestinations
Required. The list of possible ingestion destinations.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Destination>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsers
Required. The list of users to ingest.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<User> |
|
setUsers
Required. The list of users to ingest.
| Parameter | |
|---|---|
| Name | Description |
var |
array<User>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionInfo
Optional. Encryption information about encryption keys which are used to encrypt the data.
| Returns | |
|---|---|
| Type | Description |
EncryptionInfo|null |
|
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Optional. Encryption information about encryption keys which are used to encrypt the data.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidateOnly
Optional. If true, the request is validated but not executed.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
Optional. If true, the request is validated but not executed.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncoding
Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Encoding. |
setEncoding
Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Encoding. |
| Returns | |
|---|---|
| Type | Description |
$this |
|