Skip to main content
Google AdsVersion: v3

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.

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

Query Parameters

locationIdstringrequired

Location identifier

Example:loc_abc123
typestring

Segment type

Available optionsCUSTOM_SEGMENTSDATA_SEGMENTSALL
Example:CUSTOM_SEGMENTS
limitstring

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.

Example:100
pageTokenstring

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

Example:100

Response

application/json

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

oneOf
  • Array items
    • oneOf
    resourceNamestringrequired

    Google Ads resource name

    Example:customers/6776452901/customAudiences/874396901
    idstringrequired

    Segment id

    Example:874396901
    namestringrequired

    Segment name

    Example:Running shoe shoppers
    statusstringrequired

    Segment status

    Example:ENABLED
    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
    Example:CUSTOM_SEGMENTS
    interestTypestring

    Google's own custom-audience type, moved here because type is reused as the discriminator.

    Available optionsAUTOINTERESTPURCHASE_INTENTSEARCHUNKNOWNUNSPECIFIED
    Example:AUTO
    descriptionstring

    Segment description

    Example:Visitors interested in running shoes