Skip to main content

Get Change Set

GET 

/api/advertising/change-sets/:changeSet

Returns one change set with every line. Each line carries the entity (entity_type, entity_id, external_id, a readable entity_label), the operation, the before and after values, its own status (pending, applied, failed, skipped, skipped_drift, skipped_hold, skipped_cap, reverted), any error, when it was applied and verified, and the product it concerns.

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each line also carries applied_state (the values the platform confirmed after the write, with the same keys as before/after; it can differ from after when the platform clamps a value; null until applied), estimated_daily_spend_delta (the line's own share of the set's estimate, in the account currency), parent_change_id (for a line that creates a child of an entity created by another line of the set, such as an ad group of a new campaign) and depends_on_change_id (a line that must apply first; see depends_on_key on Create Change Set).

The set carries reverts_change_set_id (on an undo set: the set it undoes), reverted_by_change_set_id (the undo set that reverted this one), supersedes_change_set_id (on an edited copy: the set it replaced) and superseded_by_change_set_id (on a set in status superseded: its replacement).

can_undo is true for applied and partially applied sets that were not dry runs. tracked_job_log_id identifies the background job that applied (or is applying) the set.

Requires the advertising.view permission. Personal access tokens need the advertising:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type