Skip to main content
Retrieve the current operational state of media buys: configuration, creative approval status, missing assets, and optional near-real-time delivery snapshots. Response Time: ~1 second Request Schema: /schemas/latest/media-buy/get-media-buys-request.json Response Schema: /schemas/latest/media-buy/get-media-buys-response.json

Request Parameters

ParameterTypeRequiredDescription
accountaccount-refNoAccount reference. Pass { "account_id": "..." } or { "brand": {...}, "operator": "..." } if the seller supports implicit resolution. When omitted, returns data across all accessible accounts.
media_buy_idsstring[]No*Array of media buy IDs to retrieve
status_filterstring | string[]NoStatus filter: "pending_activation", "active", "paused", "completed", "rejected", "canceled". Defaults to ["active"] only when media_buy_ids is omitted.
include_snapshotbooleanNoWhen true, include near-real-time delivery snapshots for each package. Defaults to false.
include_historyintegerNoInclude the last N revision history entries per media buy (returns min(N, available)). 0 or omit to exclude. Max 1000.
paginationobjectNoCursor-based pagination controls (max_results, cursor) for broad queries.
*media_buy_ids filters results to specific media buys. If neither is provided, the query is scope-based and uses status_filter + pagination. When media_buy_ids are provided, no implicit status filtering is applied. Pass status_filter explicitly if you want to filter identified buys by status.

Response

Returns an array of media buys with current status, creative approval state, and optionally delivery snapshots:
FieldDescription
media_buysArray of media buy objects
paginationCursor pagination metadata (has_more, cursor, optional total_count)
errorsTask-specific errors (e.g., media buy not found)

Media Buy Object

FieldDescription
media_buy_idSeller’s media buy identifier
invoice_recipientPer-buy invoice recipient when provided at creation. Confirms the seller accepted the billing override. Bank details are omitted (write-only).
statusCurrent status (pending_activation, active, paused, completed, rejected, canceled)
currencyISO 4217 currency for media-buy-level monetary values
total_budgetTotal campaign budget (in currency)
creative_deadlineCreative upload deadline (ISO 8601)
confirmed_atISO 8601 timestamp when the seller confirmed this media buy
cancellationCancellation metadata (present only when status is canceled). Object with canceled_at (ISO 8601), canceled_by ("buyer" or "seller"), and optional reason.
revisionCurrent revision number. Pass in update_media_buy for optimistic concurrency.
valid_actionsActions the buyer can perform in the current state (e.g., ["pause", "cancel", "update_budget"]). See valid actions mapping.
historyRevision history entries, most recent first. Only present when include_history > 0. Append-only — entries are never modified or deleted.
packagesArray of packages with creative status and optional snapshots

Package Object

FieldDescription
package_idSeller’s package identifier
currencyOptional package-level currency override (defaults to media buy currency)
bid_priceCurrent bid price for auction-based packages (in package currency if present, otherwise media buy currency)
start_timeFlight start time (ISO 8601). Check this before interpreting delivery status.
end_timeFlight end time (ISO 8601)
pausedWhether buyer has paused this package
canceledWhether this package has been canceled (irreversible)
cancellationCancellation metadata (present only when canceled is true). Object with canceled_at (ISO 8601), canceled_by ("buyer" or "seller"), and optional reason.
creative_deadlinePer-package creative deadline (ISO 8601). When absent, the media buy’s creative_deadline applies.
creative_approvalsArray of creative approval states (see below)
format_ids_pendingFormat IDs from format_ids_to_provide not yet uploaded
snapshot_unavailable_reasonReason code when include_snapshot: true but no snapshot is returned for this package
snapshotNear-real-time delivery snapshot (when include_snapshot: true)

Creative Approval Object

FieldDescription
creative_idCreative identifier
approval_statuspending_review, approved, or rejected
rejection_reasonExplanation of rejection (when approval_status is rejected)
Creative revisions are represented as approval_status: "rejected" with a specific rejection_reason. There is no package-level input-required status for creative edits; upload corrected assets via sync_creatives.

History Entry Object

FieldRequiredDescription
revisionYesRevision number after this change was applied
timestampYesISO 8601 timestamp when this change occurred
actionYesWhat happened: created, activated, paused, resumed, canceled, rejected, completed, updated_budget, updated_dates, updated_packages, package_canceled, package_paused, package_resumed
actorNoIdentity of who made the change (server-derived from auth context, not caller-provided)
summaryNoHuman-readable description (e.g., “Budget changed from 5,000to5,000 to 7,500 on pkg_abc”)
package_idNoPackage affected, when the change targeted a specific package
History entries are append-only — sellers MUST NOT modify or delete previously emitted entries. Callers MAY cache entries by revision number.

Snapshot Object

FieldDescription
as_ofISO 8601 timestamp when the platform captured this snapshot
staleness_secondsMaximum data age in seconds. Use this to interpret zero delivery: 900 (15 min) means zero is likely real; 14400 (4 hr) means reporting may still be catching up.
impressionsTotal impressions delivered since package start
spendTotal spend since package start
currencyOptional snapshot currency override for spend
clicksTotal clicks since package start (when available)
pacing_indexDelivery pace (1.0 = on track, <1.0 = behind, >1.0 = ahead)
delivery_statusdelivering, not_delivering, completed, budget_exhausted, flight_ended, goal_met
extOptional extension object for seller-specific operational fields
not_delivering means the package is within its scheduled flight but has delivered zero impressions for at least one full staleness cycle. Implementers must not return not_delivering until staleness_seconds have elapsed since package activation — a new package with no impressions in its first minutes is expected, not a problem. Check start_time to confirm the package is within its flight before acting on this status. Money fields use this currency precedence: snapshot.currency -> package.currency -> media_buy.currency.

Valid Actions Mapping

The valid_actions array tells agents what operations are permitted on a media buy in its current state. Sellers SHOULD include this field. Expected values by status:
StatusExpected valid_actions
pending_activationcancel, sync_creatives
activepause, cancel, update_budget, update_dates, update_packages, add_packages, sync_creatives
pausedresume, cancel, update_budget, update_dates, update_packages, add_packages, sync_creatives
completed(empty array)
rejected(empty array)
canceled(empty array)
Sellers MAY omit actions based on business rules (e.g., omit cancel when the media buy has contractual obligations that prevent cancellation).

Common Scenarios

Check creative approval status

import { testAgent } from '@adcp/client/testing';
import { GetMediaBuysResponseSchema } from '@adcp/client';

const result = await testAgent.getMediaBuys({
  media_buy_ids: ['mb_12345']
});

if (!result.success) {
  throw new Error(`Request failed: ${result.error}`);
}

const validated = GetMediaBuysResponseSchema.parse(result.data);

if (validated.errors?.length > 0) {
  throw new Error(`Query failed: ${JSON.stringify(validated.errors)}`);
}

for (const mediaBuy of validated.media_buys) {
  for (const pkg of mediaBuy.packages) {
    // Check for missing creatives
    if (pkg.format_ids_pending?.length > 0) {
      console.log(`Package ${pkg.package_id}: missing formats ${pkg.format_ids_pending.map(f => f.id).join(', ')}`);
    }

    // Check approval states
    for (const approval of pkg.creative_approvals ?? []) {
      if (approval.approval_status === 'rejected') {
        console.log(`Creative ${approval.creative_id} rejected: ${approval.rejection_reason}`);
      } else if (approval.approval_status === 'pending_review') {
        console.log(`Creative ${approval.creative_id} pending review`);
      }
    }
  }
}

Monitor delivery with snapshots

import { testAgent } from '@adcp/client/testing';
import { GetMediaBuysResponseSchema } from '@adcp/client';

const result = await testAgent.getMediaBuys({
  status_filter: 'active',
  include_snapshot: true
});

if (!result.success) {
  throw new Error(`Request failed: ${result.error}`);
}

const validated = GetMediaBuysResponseSchema.parse(result.data);

for (const mediaBuy of validated.media_buys) {
  for (const pkg of mediaBuy.packages) {
    const snap = pkg.snapshot;
    if (!snap) continue;

    if (snap.delivery_status === 'not_delivering') {
      console.log(`Package ${pkg.package_id}: zero delivery (data up to ${snap.staleness_seconds}s old)`);
    } else if (snap.pacing_index !== undefined && snap.pacing_index < 0.8) {
      console.log(`Package ${pkg.package_id}: underpacing at ${(snap.pacing_index * 100).toFixed(0)}%`);
    } else {
      console.log(`Package ${pkg.package_id}: ${snap.impressions.toLocaleString()} impressions, pacing ${snap.pacing_index?.toFixed(2)}`);
    }
  }
}

Campaign readiness check

import { testAgent } from '@adcp/client/testing';
import { GetMediaBuysResponseSchema } from '@adcp/client';

const result = await testAgent.getMediaBuys({
  media_buy_ids: ['mb_12345']
});

if (!result.success) {
  throw new Error(`Request failed: ${result.error}`);
}

const validated = GetMediaBuysResponseSchema.parse(result.data);
const [mediaBuy] = validated.media_buys;
const issues = [];

for (const pkg of mediaBuy.packages) {
  if (pkg.format_ids_pending?.length > 0) {
    issues.push(`Package ${pkg.package_id}: ${pkg.format_ids_pending.length} format(s) not yet uploaded`);
  }

  const rejected = (pkg.creative_approvals ?? []).filter(a => a.approval_status === 'rejected');
  if (rejected.length > 0) {
    issues.push(`Package ${pkg.package_id}: ${rejected.length} creative(s) rejected`);
  }
}

if (issues.length === 0) {
  console.log('Campaign ready to launch');
} else {
  console.log('Campaign has blocking issues:');
  issues.forEach(issue => console.log(`  - ${issue}`));
}

Snapshot vs. get_media_buy_delivery

get_media_buys (with snapshot)get_media_buy_delivery
PurposeOperational monitoringReporting and reconciliation
FreshnessMinutes (entity-level stats)Hours (batch report jobs)
AccuracyBest-effortAuthoritative, billing-grade
Date rangeAlways “since campaign start”Configurable period
Daily breakdownNoYes
Creative statusYesNo
Missing assetsYesNo
Use get_media_buys to answer “what is the current state of my campaigns?” and get_media_buy_delivery for “how did my campaigns perform over a period?” Status taxonomy is shared for lifecycle filters across both tasks (pending_activation, active, paused, completed). get_media_buy_delivery may additionally return reporting-only statuses (reporting_delayed, failed) in webhook contexts.

Data Freshness

Snapshot staleness_seconds varies by platform:
Platform typeTypical staleness_seconds
Entity-level stats (e.g., GAM LineItemService)900 (15 min)
Near-real-time insights API60–300
Batch-only reporting14400 (4 hr)
When the platform only has batch reporting, the seller agent should return the most recent cached data with the appropriate staleness_seconds. If include_snapshot: true and snapshot is omitted for a package, check snapshot_unavailable_reason:
  • SNAPSHOT_UNSUPPORTED: the seller does not support package snapshots for this integration
  • SNAPSHOT_TEMPORARILY_UNAVAILABLE: snapshot pipeline is delayed or degraded; retry later
  • SNAPSHOT_PERMISSION_DENIED: caller lacks permission to view snapshot metrics for that package

Pagination

Use cursor pagination for broad status queries to avoid large payloads:
  • Request: set pagination.max_results (1-100, default 50) and optional pagination.cursor
  • Response: read pagination.has_more; when true, pass pagination.cursor into the next request
  • ID-targeted queries (media_buy_ids) can omit pagination unless the ID set is very large

Error Handling

Error CodeDescriptionResolution
MEDIA_BUY_NOT_FOUNDMedia buy ID does not existVerify media_buy_id
CONTEXT_REQUIREDNo media buys found for the requested scopeProvide valid IDs/refs or broaden status_filter/pagination scope
AUTH_REQUIREDAuthentication neededProvide credentials

Next Steps

  • Upload missing creatives: Use sync_creatives for formats in format_ids_pending
  • Investigate zero delivery: Check delivery_status: "not_delivering" and start_time to confirm the flight is active, then use update_media_buy to adjust pricing or targeting
  • Detailed reporting: Use get_media_buy_delivery for date-range reporting and daily breakdowns
  • Optimize campaigns: Use provide_performance_feedback to share results with the seller