Get segment by ID

GET 
/ad-publishing/google/segments/:segmentId

Retrieve a specific Google Ads audience segment by ID

Request

Version stringrequired

API Version

Available optionsv3

segmentId stringrequired

Segment identifier

locationId stringrequired

Location identifier

type stringrequired

Segment type

Available optionsCUSTOM_SEGMENTSDATA_SEGMENTS

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.

application/json

Schema

Schema

oneOf
• GoogleSegmentDetailDTO
• GoogleDataSegmentDetailDTO

resourceNamestringrequired

Google Ads resource name

idstringrequired

Segment id

statusstringrequired

Segment status

namestringrequired

Segment name

typestringrequired

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

membersobject[]required

Keywords, URLs and apps that define the segment

Example (auto)

{
  "resourceName": "customers/6776452901/customAudiences/874396901",
  "id": "874396901",
  "status": "ENABLED",
  "name": "Running shoe shoppers",
  "type": "AUTO",
  "members": [
    {
      "memberType": "KEYWORD",
      "keyword": "running shoes",
      "url": "www.example.com",
      "app": "app.example.com"
    }
  ]
}