Google Ads Data Manager V1 Client - Class IngestAudienceMembersRequest (0.1.1)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class IngestAudienceMembersRequest.

Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse .

Generated from protobuf message google.ads.datamanager.v1.IngestAudienceMembersRequest

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ destinations
array< Destination >

Required. The list of destinations to send the audience members to.

↳ audience_members
array< AudienceMember >

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.

↳ consent
Consent

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember .

↳ validate_only
bool

Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.

↳ encoding
int

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

↳ 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 UserData uploads, this field is ignored.

↳ terms_of_service
TermsOfService

Optional. The terms of service that the user has accepted/rejected.

getDestinations

Required. The list of destinations to send the audience members to.

Returns
Type
Description

setDestinations

Required. The list of destinations to send the audience members to.

Parameter
Name
Description
var
array< Destination >
Returns
Type
Description
$this

getAudienceMembers

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.

Returns
Type
Description

setAudienceMembers

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.

Parameter
Name
Description
var
array< AudienceMember >
Returns
Type
Description
$this

getConsent

Optional. Request-level consent to apply to all users in the request.

User-level consent overrides request-level consent, and can be specified in each AudienceMember .

Returns
Type
Description
Consent |null

hasConsent

clearConsent

setConsent

Optional. Request-level consent to apply to all users in the request.

User-level consent overrides request-level consent, and can be specified in each AudienceMember .

Parameter
Name
Description
var
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. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. 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. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. 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

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
Returns
Type
Description
$this

getTermsOfService

Optional. The terms of service that the user has accepted/rejected.

Returns
Type
Description

hasTermsOfService

clearTermsOfService

setTermsOfService

Optional. The terms of service that the user has accepted/rejected.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: