Class AudienceSegment (0.58.0)

public final class AudienceSegment extends GeneratedMessage implements AudienceSegmentOrBuilder

The AudienceSegment resource.

Protobuf type google.ads.admanager.v1.AudienceSegment

Static Fields

AD_ID_SIZE_FIELD_NUMBER

public static final int AD_ID_SIZE_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_IDS_FIELD_NUMBER

public static final int CATEGORY_IDS_FIELD_NUMBER
Field Value
Type Description
int

DATA_PROVIDER_DISPLAY_NAME_FIELD_NUMBER

public static final int DATA_PROVIDER_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

IDFA_SIZE_FIELD_NUMBER

public static final int IDFA_SIZE_FIELD_NUMBER
Field Value
Type Description
int

MOBILE_WEB_SIZE_FIELD_NUMBER

public static final int MOBILE_WEB_SIZE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NON_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER

public static final int NON_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

PPID_SIZE_FIELD_NUMBER

public static final int PPID_SIZE_FIELD_NUMBER
Field Value
Type Description
int

RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER

public static final int RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_TYPE_FIELD_NUMBER

public static final int SEGMENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SHARED_ID_FIELD_NUMBER

public static final int SHARED_ID_FIELD_NUMBER
Field Value
Type Description
int

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

THIRD_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER

public static final int THIRD_PARTY_AUDIENCE_SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AudienceSegment getDefaultInstance()
Returns
Type Description
AudienceSegment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AudienceSegment.Builder newBuilder()
Returns
Type Description
AudienceSegment.Builder

newBuilder(AudienceSegment prototype)

public static AudienceSegment.Builder newBuilder(AudienceSegment prototype)
Parameter
Name Description
prototype AudienceSegment
Returns
Type Description
AudienceSegment.Builder

parseDelimitedFrom(InputStream input)

public static AudienceSegment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AudienceSegment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudienceSegment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudienceSegment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AudienceSegment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AudienceSegment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudienceSegment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceSegment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AudienceSegment> parser()
Returns
Type Description
Parser<AudienceSegment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdIdSize()

public long getAdIdSize()

Output only. Number of unique AdID identifiers in the AudienceSegment.

optional int64 ad_id_size = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The adIdSize.

getCategoryIds(int index)

public long getCategoryIds(int index)

Optional. Unordered list. IDs of the categories that this audience segment belongs to. See segment_categories for additional information about the categories.

repeated int64 category_ids = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The categoryIds at the given index.

getCategoryIdsCount()

public int getCategoryIdsCount()

Optional. Unordered list. IDs of the categories that this audience segment belongs to. See segment_categories for additional information about the categories.

repeated int64 category_ids = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST];

Returns
Type Description
int

The count of categoryIds.

getCategoryIdsList()

public List<Long> getCategoryIdsList()

Optional. Unordered list. IDs of the categories that this audience segment belongs to. See segment_categories for additional information about the categories.

repeated int64 category_ids = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST];

Returns
Type Description
List<Long>

A list containing the categoryIds.

getDataProviderDisplayName()

public String getDataProviderDisplayName()

Output only. Display name of the owner data provider. For a first-party audience segment, this is the display name of the publisher network. Otherwise, this is the display name of the entity providing the audience segment.

optional string data_provider_display_name = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dataProviderDisplayName.

getDataProviderDisplayNameBytes()

public ByteString getDataProviderDisplayNameBytes()

Output only. Display name of the owner data provider. For a first-party audience segment, this is the display name of the publisher network. Otherwise, this is the display name of the entity providing the audience segment.

optional string data_provider_display_name = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dataProviderDisplayName.

getDefaultInstanceForType()

public AudienceSegment getDefaultInstanceForType()
Returns
Type Description
AudienceSegment

getDescription()

public String getDescription()

Optional. Description of the AudienceSegment. This has a maximum length of 8192 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the AudienceSegment. This has a maximum length of 8192 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Display name of the AudienceSegment. The attribute has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the AudienceSegment. The attribute has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getIdfaSize()

public long getIdfaSize()

Output only. Number of unique Identifier for Advertisers (IDFA) identifiers in the AudienceSegment.

optional int64 idfa_size = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The idfaSize.

getMobileWebSize()

public long getMobileWebSize()

Output only. Number of unique mobile web identifiers in the AudienceSegment.

optional int64 mobile_web_size = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The mobileWebSize.

getName()

public String getName()

Identifier. The resource name of the AudienceSegment. Format: networks/{network_code}/audienceSegments/{audience_segment_id} The audience_segment_id is not always numerical and may have one of the following suffixes:

  • ~direct for directly licensed third-party segments
  • ~global for globally licensed third-party segments

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the AudienceSegment. Format: networks/{network_code}/audienceSegments/{audience_segment_id} The audience_segment_id is not always numerical and may have one of the following suffixes:

  • ~direct for directly licensed third-party segments
  • ~global for globally licensed third-party segments

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNonRuleBasedFirstPartyAudienceSegment()

public AudienceSegment.NonRuleBasedFirstPartyAudienceSegment getNonRuleBasedFirstPartyAudienceSegment()

Optional. An AudienceSegment owned by the publisher network that does not contain a rule. Cookies are usually added to these segments through cookie upload.

.google.ads.admanager.v1.AudienceSegment.NonRuleBasedFirstPartyAudienceSegment non_rule_based_first_party_audience_segment = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudienceSegment.NonRuleBasedFirstPartyAudienceSegment

The nonRuleBasedFirstPartyAudienceSegment.

getNonRuleBasedFirstPartyAudienceSegmentOrBuilder()

public AudienceSegment.NonRuleBasedFirstPartyAudienceSegmentOrBuilder getNonRuleBasedFirstPartyAudienceSegmentOrBuilder()

Optional. An AudienceSegment owned by the publisher network that does not contain a rule. Cookies are usually added to these segments through cookie upload.

.google.ads.admanager.v1.AudienceSegment.NonRuleBasedFirstPartyAudienceSegment non_rule_based_first_party_audience_segment = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudienceSegment.NonRuleBasedFirstPartyAudienceSegmentOrBuilder

getParserForType()

public Parser<AudienceSegment> getParserForType()
Returns
Type Description
Parser<AudienceSegment>
Overrides

getPpidSize()

public long getPpidSize()

Output only. Number of unique publisher-provided (PPID) identifiers in the AudienceSegment.

optional int64 ppid_size = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The ppidSize.

getRuleBasedFirstPartyAudienceSegment()

public AudienceSegment.RuleBasedFirstPartyAudienceSegment getRuleBasedFirstPartyAudienceSegment()

Optional. An AudienceSegment owned by the publisher network that contains a rule.

.google.ads.admanager.v1.AudienceSegment.RuleBasedFirstPartyAudienceSegment rule_based_first_party_audience_segment = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudienceSegment.RuleBasedFirstPartyAudienceSegment

The ruleBasedFirstPartyAudienceSegment.

getRuleBasedFirstPartyAudienceSegmentOrBuilder()

public AudienceSegment.RuleBasedFirstPartyAudienceSegmentOrBuilder getRuleBasedFirstPartyAudienceSegmentOrBuilder()

Optional. An AudienceSegment owned by the publisher network that contains a rule.

.google.ads.admanager.v1.AudienceSegment.RuleBasedFirstPartyAudienceSegment rule_based_first_party_audience_segment = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudienceSegment.RuleBasedFirstPartyAudienceSegmentOrBuilder

getSegmentType()

public AudienceSegmentTypeEnum.AudienceSegmentType getSegmentType()

Output only. Non-empty default. Type of the AudienceSegment. Every AudienceSegment is either FIRST_PARTY or THIRD_PARTY.

optional .google.ads.admanager.v1.AudienceSegmentTypeEnum.AudienceSegmentType segment_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
AudienceSegmentTypeEnum.AudienceSegmentType

The segmentType.

getSegmentTypeValue()

public int getSegmentTypeValue()

Output only. Non-empty default. Type of the AudienceSegment. Every AudienceSegment is either FIRST_PARTY or THIRD_PARTY.

optional .google.ads.admanager.v1.AudienceSegmentTypeEnum.AudienceSegmentType segment_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for segmentType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSharedId()

public long getSharedId()

Output only. The ID of the AudienceSegment. Up to two resources may share this ID.

int64 shared_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The sharedId.

getSize()

public long getSize()

Output only. Number of unique identifiers in the AudienceSegment.

optional int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The size.

getStatus()

public AudienceSegmentStatusEnum.AudienceSegmentStatus getStatus()

Output only. Non-empty default. Status of the AudienceSegment used to determine whether the segment is available for targeting. Defaults to ACTIVE if not set.

optional .google.ads.admanager.v1.AudienceSegmentStatusEnum.AudienceSegmentStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
AudienceSegmentStatusEnum.AudienceSegmentStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. Non-empty default. Status of the AudienceSegment used to determine whether the segment is available for targeting. Defaults to ACTIVE if not set.

optional .google.ads.admanager.v1.AudienceSegmentStatusEnum.AudienceSegmentStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for status.

getSubTypeCase()

public AudienceSegment.SubTypeCase getSubTypeCase()
Returns
Type Description
AudienceSegment.SubTypeCase

getThirdPartyAudienceSegment()

public AudienceSegment.ThirdPartyAudienceSegment getThirdPartyAudienceSegment()

Output only. An AudienceSegment owned by a data provider and licensed to the Ad Manager publisher network.

.google.ads.admanager.v1.AudienceSegment.ThirdPartyAudienceSegment third_party_audience_segment = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AudienceSegment.ThirdPartyAudienceSegment

The thirdPartyAudienceSegment.

getThirdPartyAudienceSegmentOrBuilder()

public AudienceSegment.ThirdPartyAudienceSegmentOrBuilder getThirdPartyAudienceSegmentOrBuilder()

Output only. An AudienceSegment owned by a data provider and licensed to the Ad Manager publisher network.

.google.ads.admanager.v1.AudienceSegment.ThirdPartyAudienceSegment third_party_audience_segment = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AudienceSegment.ThirdPartyAudienceSegmentOrBuilder

hasAdIdSize()

public boolean hasAdIdSize()

Output only. Number of unique AdID identifiers in the AudienceSegment.

optional int64 ad_id_size = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the adIdSize field is set.

hasDataProviderDisplayName()

public boolean hasDataProviderDisplayName()

Output only. Display name of the owner data provider. For a first-party audience segment, this is the display name of the publisher network. Otherwise, this is the display name of the entity providing the audience segment.

optional string data_provider_display_name = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataProviderDisplayName field is set.

hasDescription()

public boolean hasDescription()

Optional. Description of the AudienceSegment. This has a maximum length of 8192 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the description field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Display name of the AudienceSegment. The attribute has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasIdfaSize()

public boolean hasIdfaSize()

Output only. Number of unique Identifier for Advertisers (IDFA) identifiers in the AudienceSegment.

optional int64 idfa_size = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the idfaSize field is set.

hasMobileWebSize()

public boolean hasMobileWebSize()

Output only. Number of unique mobile web identifiers in the AudienceSegment.

optional int64 mobile_web_size = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the mobileWebSize field is set.

hasNonRuleBasedFirstPartyAudienceSegment()

public boolean hasNonRuleBasedFirstPartyAudienceSegment()

Optional. An AudienceSegment owned by the publisher network that does not contain a rule. Cookies are usually added to these segments through cookie upload.

.google.ads.admanager.v1.AudienceSegment.NonRuleBasedFirstPartyAudienceSegment non_rule_based_first_party_audience_segment = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nonRuleBasedFirstPartyAudienceSegment field is set.

hasPpidSize()

public boolean hasPpidSize()

Output only. Number of unique publisher-provided (PPID) identifiers in the AudienceSegment.

optional int64 ppid_size = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the ppidSize field is set.

hasRuleBasedFirstPartyAudienceSegment()

public boolean hasRuleBasedFirstPartyAudienceSegment()

Optional. An AudienceSegment owned by the publisher network that contains a rule.

.google.ads.admanager.v1.AudienceSegment.RuleBasedFirstPartyAudienceSegment rule_based_first_party_audience_segment = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ruleBasedFirstPartyAudienceSegment field is set.

hasSegmentType()

public boolean hasSegmentType()

Output only. Non-empty default. Type of the AudienceSegment. Every AudienceSegment is either FIRST_PARTY or THIRD_PARTY.

optional .google.ads.admanager.v1.AudienceSegmentTypeEnum.AudienceSegmentType segment_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the segmentType field is set.

hasSize()

public boolean hasSize()

Output only. Number of unique identifiers in the AudienceSegment.

optional int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the size field is set.

hasStatus()

public boolean hasStatus()

Output only. Non-empty default. Status of the AudienceSegment used to determine whether the segment is available for targeting. Defaults to ACTIVE if not set.

optional .google.ads.admanager.v1.AudienceSegmentStatusEnum.AudienceSegmentStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the status field is set.

hasThirdPartyAudienceSegment()

public boolean hasThirdPartyAudienceSegment()

Output only. An AudienceSegment owned by a data provider and licensed to the Ad Manager publisher network.

.google.ads.admanager.v1.AudienceSegment.ThirdPartyAudienceSegment third_party_audience_segment = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the thirdPartyAudienceSegment field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AudienceSegment.Builder newBuilderForType()
Returns
Type Description
AudienceSegment.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AudienceSegment.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AudienceSegment.Builder
Overrides

toBuilder()

public AudienceSegment.Builder toBuilder()
Returns
Type Description
AudienceSegment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException