ads
campaign

List all campaigns

get/ads/{connection_id}/campaign

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/ads/{connection_id}/campaign
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

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

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AdsOrganization)

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

goal'UNSPECIFIED' | 'BRAND_AWARENESS' | 'ENGAGEMENT' | 'REACH' | 'WEBSITE_TRAFFIC' | 'LEADS' | 'SALES' | 'APP_PROMOTION'
effective_status'UNSPECIFIED' | 'SERVING' | 'LIMITED' | 'LEARNING' | 'PAUSED' | 'PENDING' | 'ENDED' | 'MISCONFIGURED' | 'NOT_ELIGIBLE' | 'ARCHIVED' | 'REMOVED'
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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
organization_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'

read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

budget_amountnumber
budget_period'DAILY' | 'MONTHLY' | 'TOTAL' | 'LIFETIME'
budget_unit'UNSPECIFIED' | 'CURRENCY' | 'IMPRESSIONS'
total_spend_amountnumber
goal'UNSPECIFIED' | 'BRAND_AWARENESS' | 'ENGAGEMENT' | 'REACH' | 'WEBSITE_TRAFFIC' | 'LEADS' | 'SALES' | 'APP_PROMOTION'
planned_spend_amountnumber
advertising_channel_type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH' | 'PERFORMANCE_MAX'
campaign_budget_identifierstring

Resource name for existing/shared budget (Google)

currencystring
categorystring

Housing, employment, credit, NONE (Meta)

has_eu_political_adsboolean
labelsstring[]
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.