Get segments

GET 
/ad-publishing/google/segments

Retrieve Google Ads audience segments for a location. Without limit the response is a plain array. When limit is provided (max 100, default 100) the response is a paginated { segments, paging } envelope; pass pageToken (from paging.next) to fetch the next batch.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location identifier

type string

Segment type

Available optionsCUSTOM_SEGMENTSDATA_SEGMENTSALL

limit string

Page size for a paginated fetch (max 100, defaults to 100). When set, the response is a { segments, paging } envelope instead of a plain array.

pageToken string

Opaque cursor for the next batch, taken from the previous response paging.next

application/json

A plain array of segments (default), or a { segments, paging } envelope when limit is provided

application/json

Schema

Schema

oneOf
• object[]
• PaginatedGoogleSegmentsDTO
Array [
oneOf
• GoogleCustomSegmentSummaryDTO
• GoogleDataSegmentDTO
resourceNamestringrequired
Google Ads resource name
idstringrequired
Segment id
namestringrequired
Segment name
statusstringrequired
Segment status
typestringrequired
Always the literal CUSTOM_SEGMENTS. The service overwrites Google's own type with this constant so the value can be used as the discriminator that tells custom-audience entries apart from user-list entries in the merged ALL listing.
Available optionsCUSTOM_SEGMENTS
interestTypestring
Google's own custom-audience type, moved here because type is reused as the discriminator.
Available optionsAUTOINTERESTPURCHASE_INTENTSEARCHUNKNOWNUNSPECIFIED
descriptionstring
Segment description
]

Example (auto)

[
  {
    "resourceName": "customers/6776452901/customAudiences/874396901",
    "id": "874396901",
    "name": "Running shoe shoppers",
    "status": "ENABLED",
    "type": "CUSTOM_SEGMENTS",
    "interestType": "AUTO",
    "description": "Visitors interested in running shoes"
  },
  {
    "resourceName": "customers/6776452901/userLists/9215680180",
    "id": "9215680180",
    "name": "Website visitors",
    "type": "WEBSITE_VISITOR",
    "status": "ENABLED",
    "membershipStatus": "OPEN",
    "accessReason": "OWNED",
    "accountUserListStatus": "ENABLED",
    "readOnly": false,
    "sizeForDisplay": "0",
    "sizeForSearch": "0",
    "ruleBasedUserList": {
      "prepopulationStatus": "FINISHED"
    },
    "logicalUserList": {}
  }
]