Skip to main content

AdAccount

One advertising account, on one platform. A merchant may hold SEVERAL accounts on the same platform — a Meta merchant typically has Facebook, Instagram and WhatsApp Business — so do not key a collection of these by provider. An account is listed here even on a platform the merchant has not connected yet; read status and platform { connected } rather than inferring either from the account’s presence.

type AdAccount {
  id: ID!
  provider: AdProvider!
  platform: AdPlatform
  name: String!
  brand: String
  currency: CurrencyCode!
  status: AdAccountStatus!
  countsTowardsBlended: Boolean!
  monthly: AdMonthlyTotals
  weeklySeries: [AdWeeklyPoint!]!
}

Fields​

AdAccount.id ● ID! non-null scalar​

The opaque identifier of this ad account, unique across the whole platform. Treat it as a string with no parts to read.

AdAccount.provider ● AdProvider! non-null enum​

The advertising platform this account lives on.

AdAccount.platform ● AdPlatform object​

The advertising platform this account lives on, with what that platform reports and how well it is set up. Null for an account whose platform is not described here — read provider when only the name of the channel is needed.

AdAccount.name ● String! non-null scalar​

The account’s name as the merchant sees it in the provider’s own console, so the two can be matched up by eye.

AdAccount.brand ● String scalar​

A stable key for the brand mark this account is shown under, which is not always its platform’s: a Meta account is branded Facebook, Instagram or WhatsApp Business. Null when the account is shown under its platform’s own mark.

AdAccount.currency ● CurrencyCode! non-null enum​

The currency this account bills and reports in. Every Money value on its campaigns is denominated in it.

AdAccount.status ● AdAccountStatus! non-null enum​

Whether the platform is still syncing this account.

AdAccount.countsTowardsBlended ● Boolean! non-null scalar​

Whether this account’s figures are inside the merchant’s blended totals, or reported alongside them.

AdAccount.monthly ● AdMonthlyTotals object​

What this account reports for the merchant’s current month. Null when no month has been reported for it yet — which is not a month of zero.

AdAccount.weeklySeries ● [AdWeeklyPoint!]! non-null object​

Week by week over the platform’s reporting window, oldest first. Empty when no week has been reported yet; a client should draw nothing rather than a flat line at zero. This is a plain list and not a cursor connection — deliberately, because a window is read as a unit and never sliced — so it carries a hard ceiling instead of a page size: **at most 53 points**, a year of weeks, enforced in storage. Twelve is what it holds today.

Member Of​

AdAccountConnection object ● AdAccountEdge object ● Campaign object