Sign in
ads
group

List all groups

get/ads/{connection_id}/group

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AdsOrganization)

campaign_idstring

The campaign ID to filter by

parent_idstring

The parent ID to filter by

io_idstring

The IO ID to filter by

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

statusstring

The status to filter by

effective_statusstring
fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
parent_idstring
campaign_idstring
organization_idstring
insertionorder_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
effective_status'UNSPECIFIED' | 'SERVING' | 'LIMITED' | 'LEARNING' | 'PAUSED' | 'PENDING' | 'ENDED' | 'MISCONFIGURED' | 'NOT_ELIGIBLE' | 'ARCHIVED' | 'REMOVED'
bid_amountnumber
budget_amountnumber
budget_period'DAILY' | 'MONTHLY' | 'TOTAL' | 'LIFETIME'
budget_allocation_type'UNSPECIFIED' | 'AUTOMATIC' | 'FIXED' | 'UNLIMITED'
start_atstring date-time
end_atstring date-time
budget_unit'UNSPECIFIED' | 'CURRENCY' | 'IMPRESSIONS'
budget_max_amountnumber
type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH' | 'PERFORMANCE_MAX'
has_eu_political_adsboolean
creative_idsstring[]
optimization_goal'REACH' | 'IMPRESSIONS' | 'LINK_CLICKS' | 'LANDING_PAGE_VIEWS' | 'CONVERSIONS' | 'LEAD_GENERATION' | 'APP_INSTALLS' | 'APP_ENGAGEMENT' | 'VIDEO_VIEWS' | 'ENGAGEMENT' | 'PAGE_LIKES' | 'MESSAGES'
billing_event'IMPRESSIONS' | 'LINK_CLICKS' | 'VIDEO_VIEWS' | 'APP_INSTALLS' | 'ENGAGEMENT' | 'PAGE_LIKES' | 'MESSAGES' | 'POST_ENGAGEMENT' | 'PURCHASE' | 'NONE'
currencystring
language_localestring
creative_selection'OPTIMIZED' | 'ROUND_ROBIN'
rawobject

Changes

Changed in 4 of the 34 revisions of this API.47

  • fbf77d34910f1See the full diff
    • ●

      added the new PERFORMANCE_MAX enum value to the / response property for the response status

      response-property-enum-value-added

  • 1f72720916e44See the full diff
    • ○

      added the enum value creative_selection to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value language_locale to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 963bcc74f9e33See the full diff
    • ●

      added the new CTV enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new DOOH enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new NATIVE enum value to the / response property for the response status

      response-property-enum-value-added

  • 8f24376685673See the full diff
    • ○

      added the new optional query request parameter effective_status

      new-optional-request-parameter

    • ○

      added the enum value effective_status to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added