Interface IngestAudienceMembersRequestOrBuilder (0.1.0)

public interface IngestAudienceMembersRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudienceMembers(int index)

public abstract AudienceMember getAudienceMembers(int index)

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

repeated .google.ads.datamanager.v1.AudienceMember audience_members = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AudienceMember

getAudienceMembersCount()

public abstract int getAudienceMembersCount()

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

repeated .google.ads.datamanager.v1.AudienceMember audience_members = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getAudienceMembersList()

public abstract List<AudienceMember> getAudienceMembersList()

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

repeated .google.ads.datamanager.v1.AudienceMember audience_members = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<AudienceMember>

getAudienceMembersOrBuilder(int index)

public abstract AudienceMemberOrBuilder getAudienceMembersOrBuilder(int index)

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

repeated .google.ads.datamanager.v1.AudienceMember audience_members = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AudienceMemberOrBuilder

getAudienceMembersOrBuilderList()

public abstract List<? extends AudienceMemberOrBuilder> getAudienceMembersOrBuilderList()

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

repeated .google.ads.datamanager.v1.AudienceMember audience_members = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.datamanager.v1.AudienceMemberOrBuilder>

getConsent()

public abstract Consent 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.

.google.ads.datamanager.v1.Consent consent = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Consent

The consent.

getConsentOrBuilder()

public abstract ConsentOrBuilder getConsentOrBuilder()

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.

.google.ads.datamanager.v1.Consent consent = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConsentOrBuilder

getDestinations(int index)

public abstract Destination getDestinations(int index)

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

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Destination

getDestinationsCount()

public abstract int getDestinationsCount()

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

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getDestinationsList()

public abstract List<Destination> getDestinationsList()

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

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Destination>

getDestinationsOrBuilder(int index)

public abstract DestinationOrBuilder getDestinationsOrBuilder(int index)

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

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DestinationOrBuilder

getDestinationsOrBuilderList()

public abstract List<? extends DestinationOrBuilder> getDestinationsOrBuilderList()

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

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.datamanager.v1.DestinationOrBuilder>

getEncoding()

public abstract Encoding 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.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Encoding

The encoding.

getEncodingValue()

public abstract int getEncodingValue()

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.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getEncryptionInfo()

public abstract EncryptionInfo 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.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoOrBuilder()

public abstract EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

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.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionInfoOrBuilder

getTermsOfService()

public abstract TermsOfService getTermsOfService()

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

.google.ads.datamanager.v1.TermsOfService terms_of_service = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TermsOfService

The termsOfService.

getTermsOfServiceOrBuilder()

public abstract TermsOfServiceOrBuilder getTermsOfServiceOrBuilder()

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

.google.ads.datamanager.v1.TermsOfService terms_of_service = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TermsOfServiceOrBuilder

getValidateOnly()

public abstract boolean getValidateOnly()

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

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasConsent()

public abstract boolean hasConsent()

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.

.google.ads.datamanager.v1.Consent consent = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the consent field is set.

hasEncryptionInfo()

public abstract boolean hasEncryptionInfo()

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.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

hasTermsOfService()

public abstract boolean hasTermsOfService()

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

.google.ads.datamanager.v1.TermsOfService terms_of_service = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the termsOfService field is set.