Skip to content

List Ads

Endpoint

http
GET /unified/ads/ads
Integrations supported
  • Google Ads
  • Meta Marketing API

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
account_id
string
The unique identifier for the account.
Required in
  • Google Ads
  • Meta Marketing API

Response Body

result
object[]
List of Ads
id
string
REQUIRED · The unique identifier for the ad.
Supported in
  • Google Ads
  • Meta Marketing API
name
string
The name of the ad.
Supported in
  • Meta Marketing API
type
string
The type of the ad
Supported in
  • Google Ads
  • Meta Marketing API
status
string
The status of the ad.
All possible enum values:
  • active
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
  • campaign_paused
  • pending_review
  • disapproved
  • preapproved
  • pending_billing_info
  • adset_paused
Supported in
  • Google Ads
  • Meta Marketing API
account_id
string
The unique identifier for the account.
Supported in
  • Google Ads
  • Meta Marketing API
ad_group_id
string
The unique identifier for the ad_group.
Supported in
  • Meta Marketing API
campaign_id
string
The unique identifier for the campaign.
Supported in
  • Google Ads
  • Meta Marketing API
labels
object[]
The labels for the ad.
Supported in
  • Google Ads
  • Meta Marketing API
id
string
The unique identifier for the label.
name
string
The name of the label.
schedule
object
The schedule for the ad.
Supported in
  • Meta Marketing API
end_time
string · date-time
The end time for the ad.
start_time
string · date-time
The start time for the ad.
bid
object
The bid for the ad.
Supported in
  • Meta Marketing API
adjustments
object
The bid adjustments for the ad.
amount
string
The bid amount for the ad.
constraints
object
The bid constraints for the ad.
objective_values
object
The bid values for different objectives of the ad.
strategy
object
The bid strategy for the ad.
id
string
The unique identifier for the bid strategy.
name
string
The name of the bid strategy.
conversion_domain
string
The conversion domain for the ad.
Supported in
  • Meta Marketing API
creative
object
The creative for the ad.
Supported in
  • Google Ads
creative_id
string[]
The unique identifier for the creative.
Supported in
  • Meta Marketing API
issues
object[]
The issues for the ad that prevented the ad from being delivered.
Supported in
  • Meta Marketing API
code
string
The code for the issue.
message
string
The error message for the issue.
description
string
The error summary for the issue.
level
string
The level for the issue.
type
string
The type for the issue.
preview_url
object[]
The preview URL for the ad.
Supported in
  • Meta Marketing API
url
string
The URL for the preview.
type
string
The type for the preview.
tracking_specs
object[]
The tracking specs for the ad.
Supported in
  • Meta Marketing API
created_at
string · date-time
The date and time the ad was created.
Supported in
  • Meta Marketing API
updated_at
string · date-time
The date and time the ad was last updated.
Supported in
  • Meta Marketing API
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.