ads
ad

Update an ad

Changed on
patch/ads/{connection_id}/ad/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ads/{connection_id}/ad/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Ad

Query parameters

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

Request body

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
campaign_idstring
group_idstring

(reference to AdsGroup)

organization_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
ad_type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH' | 'PERFORMANCE_MAX'
advertiser_namestring
creative_idsstring[]
creative_asset_urlstring
ad_copystring
headlinestring
descriptionstring
ctastring
final_urlstring
display_urlstring
path1string
path2string
logo_creative_idstring
rawobject

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
campaign_idstring
group_idstring

(reference to AdsGroup)

organization_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
ad_type'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH' | 'PERFORMANCE_MAX'
advertiser_namestring
creative_idsstring[]
creative_asset_urlstring
ad_copystring
headlinestring
descriptionstring
ctastring
final_urlstring
display_urlstring
path1string
path2string
logo_creative_idstring
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

  • fbf77d34910fRevision changes
    • warning

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

    • info

      added the new PERFORMANCE_MAX enum value to the request property