public interface AudienceSegmentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdIdSize()
public abstract 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 abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long |
The categoryIds at the given index. |
getCategoryIdsCount()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getDescription()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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:
~directfor directly licensed third-party segments~globalfor globally licensed third-party segments
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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:
~directfor directly licensed third-party segments~globalfor globally licensed third-party segments
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNonRuleBasedFirstPartyAudienceSegment()
public abstract 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 abstract 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 |
|
getPpidSize()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getSharedId()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract AudienceSegment.SubTypeCase getSubTypeCase()| Returns | |
|---|---|
| Type | Description |
AudienceSegment.SubTypeCase |
|
getThirdPartyAudienceSegment()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |