Skip to main content
Google AdsVersion: v3

Get segment by ID

GET/ad-publishing/google/segments/{segmentId}

Retrieve a specific Google Ads audience segment by ID

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

segmentIdstringrequired

Segment identifier

Example:seg_abc123

Query Parameters

locationIdstringrequired

Location identifier

Example:HChooFuiyPpVYzeJ4HMe
typestringrequired

Segment type

Available optionsCUSTOM_SEGMENTSDATA_SEGMENTS
Example:CUSTOM_SEGMENTS

Response

application/json

The segment, shaped by the requested type. CUSTOM_SEGMENTS returns a custom audience with status and members; DATA_SEGMENTS returns a Google user list with rules, sizes, access metadata, and an optional extras block holding this product's own record.

oneOf
resourceNamestringrequired

Google Ads resource name

Example:customers/6776452901/customAudiences/874396901
idstringrequired

Segment id

Example:874396901
statusstringrequired

Segment status

Example:ENABLED
namestringrequired

Segment name

Example:Running shoe shoppers
typestringrequired

Google custom-audience type. AUTO is the default applied when none is supplied on create.

Example:AUTO
membersobject[]required

Keywords, URLs and apps that define the segment