Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AudienceSegment.
The AudienceSegment resource.
Generated from protobuf message google.ads.admanager.v1.AudienceSegment
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ non_rule_based_first_party_audience_segment |
AudienceSegment\NonRuleBasedFirstPartyAudienceSegment
Optional. An |
↳ rule_based_first_party_audience_segment |
AudienceSegment\RuleBasedFirstPartyAudienceSegment
Optional. An |
↳ third_party_audience_segment |
AudienceSegment\ThirdPartyAudienceSegment
Output only. An |
↳ name |
string
Identifier. The resource name of the |
↳ shared_id |
int|string
Output only. The ID of the |
↳ display_name |
string
Required. Display name of the |
↳ category_ids |
int[]|string[]
Optional. Unordered list. IDs of the categories that this audience segment belongs to. See |
↳ description |
string
Optional. Description of the |
↳ status |
int
Output only. Non-empty default. Status of the |
↳ size |
int|string
Output only. Number of unique identifiers in the |
↳ mobile_web_size |
int|string
Output only. Number of unique mobile web identifiers in the |
↳ idfa_size |
int|string
Output only. Number of unique Identifier for Advertisers (IDFA) identifiers in the |
↳ ad_id_size |
int|string
Output only. Number of unique AdID identifiers in the |
↳ ppid_size |
int|string
Output only. Number of unique publisher-provided (PPID) identifiers in the |
↳ data_provider_display_name |
string
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. |
↳ segment_type |
int
Output only. Non-empty default. Type of the |
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.
| Returns | |
|---|---|
| Type | Description |
AudienceSegment\NonRuleBasedFirstPartyAudienceSegment|null |
|
hasNonRuleBasedFirstPartyAudienceSegment
setNonRuleBasedFirstPartyAudienceSegment
Optional. An AudienceSegment owned by the publisher network that does
not contain a rule. Cookies are usually added to these segments through
cookie upload.
| Parameter | |
|---|---|
| Name | Description |
var |
AudienceSegment\NonRuleBasedFirstPartyAudienceSegment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleBasedFirstPartyAudienceSegment
Optional. An AudienceSegment owned by the publisher network that
contains a rule.
| Returns | |
|---|---|
| Type | Description |
AudienceSegment\RuleBasedFirstPartyAudienceSegment|null |
|
hasRuleBasedFirstPartyAudienceSegment
setRuleBasedFirstPartyAudienceSegment
Optional. An AudienceSegment owned by the publisher network that
contains a rule.
| Parameter | |
|---|---|
| Name | Description |
var |
AudienceSegment\RuleBasedFirstPartyAudienceSegment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getThirdPartyAudienceSegment
Output only. An AudienceSegment owned by a data provider and licensed
to the Ad Manager publisher network.
| Returns | |
|---|---|
| Type | Description |
AudienceSegment\ThirdPartyAudienceSegment|null |
|
hasThirdPartyAudienceSegment
setThirdPartyAudienceSegment
Output only. An AudienceSegment owned by a data provider and licensed
to the Ad Manager publisher network.
| Parameter | |
|---|---|
| Name | Description |
var |
AudienceSegment\ThirdPartyAudienceSegment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSharedId
Output only. The ID of the AudienceSegment. Up to two resources may share
this ID.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setSharedId
Output only. The ID of the AudienceSegment. Up to two resources may share
this ID.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. Display name of the AudienceSegment. The attribute has a
maximum length of 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. Display name of the AudienceSegment. The attribute has a
maximum length of 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategoryIds
Optional. Unordered list. IDs of the categories that this audience segment
belongs to. See segment_categories for additional information about the
categories.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int>|Google\Protobuf\RepeatedField<string> |
|
setCategoryIds
Optional. Unordered list. IDs of the categories that this audience segment
belongs to. See segment_categories for additional information about the
categories.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]|string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the AudienceSegment. This has a maximum length
of 8192 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
Optional. Description of the AudienceSegment. This has a maximum length
of 8192 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSize
Output only. Number of unique identifiers in the AudienceSegment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasSize
clearSize
setSize
Output only. Number of unique identifiers in the AudienceSegment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMobileWebSize
Output only. Number of unique mobile web identifiers in the
AudienceSegment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMobileWebSize
clearMobileWebSize
setMobileWebSize
Output only. Number of unique mobile web identifiers in the
AudienceSegment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdfaSize
Output only. Number of unique Identifier for Advertisers (IDFA) identifiers
in the AudienceSegment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasIdfaSize
clearIdfaSize
setIdfaSize
Output only. Number of unique Identifier for Advertisers (IDFA) identifiers
in the AudienceSegment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdIdSize
Output only. Number of unique AdID identifiers in the AudienceSegment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasAdIdSize
clearAdIdSize
setAdIdSize
Output only. Number of unique AdID identifiers in the AudienceSegment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPpidSize
Output only. Number of unique publisher-provided (PPID) identifiers in the
AudienceSegment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasPpidSize
clearPpidSize
setPpidSize
Output only. Number of unique publisher-provided (PPID) identifiers in the
AudienceSegment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDataProviderDisplayName
clearDataProviderDisplayName
setDataProviderDisplayName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSegmentType
Output only. Non-empty default. Type of the AudienceSegment. Every
AudienceSegment is either FIRST_PARTY or THIRD_PARTY.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSegmentType
clearSegmentType
setSegmentType
Output only. Non-empty default. Type of the AudienceSegment. Every
AudienceSegment is either FIRST_PARTY or THIRD_PARTY.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubType
| Returns | |
|---|---|
| Type | Description |
string |
|