Contents

AdAccount

The account-level resource within an organization that contains campaigns and advertising settings.

Declaration

object AdAccount

Properties

NameTypeDescription
idint64

System-assigned unique identifier for the ad account. Read-only.

namestring

The name of the ad account. Must be unique within the parent org. Mutable.

orgIdint64

The identifier of the parent organization. Read-only, inherited from the parent org.

timezonestring

The time zone for the ad account, inherited from the parent org at creation. Example: America/New_York. Read-only.

currencyAdAccount.Currency

The currency for the ad account. Supported values: USD, EUR, GBP, JPY, AUD, CAD, MXN, NZD, RUB, CNY, RMB, INR, BRL, IDR. See AdAccount.Currency. Read-only, inherited from the parent org.

paymentModelAdAccount.PaymentModel

The payment model for the ad account. LOC (line of credit) enables budget orders and is invoiced monthly. PAYG (pay as you go) is charged per campaign spend. See AdAccount.PaymentModel. Read-only, inherited from the parent org.

systemStatusAdAccount.SystemStatus

ACTIVE on successful creation. Transitions to INACTIVE if issues arise. See AdAccount.SystemStatus. Read-only.

systemStatusReasons[AdAccount.SystemStatusReasons]

Populated when systemStatus is INACTIVE. Possible values: TAX_VERIFICATION_PENDING, ORG_NO_PAYMENT_METHOD_ON_FILE, NO_PAYMENT_METHOD_ON_FILE, CHARGE_BACK_DISPUTED, CREDIT_CARD_SUSPENDED, ORG_PAYMENT_TYPE_DECLINED, FRAUD, INVALID_PAYMENT_PROFILE, MSA_EXPIRED, MSA_NOT_RECEIVED, PAYMENT_DECLINED, PAYMENT_METHOD_CANCELED, PAYMENT_METHOD_ON_HOLD, PAYMENT_PENDING_CHARGES, LOC_EXHAUSTED, POLICY_VIOLATION, TERM_NOT_ACCEPTED, USER_REQUESTED_ACCOUNT_SUSPENSION. See AdAccount.SystemStatusReasons. Read-only.

delegations[Delegation]

Delegated resources associated with this ad account (brands, content providers). See Delegation. Mutable.

productFeatures[ProductFeatures]

Defines whether the account is authorized for App Store or Apple Maps advertising. APPSTORE_APP_MANUAL enables App Store advertising. BUSINESS_BRAND_MANUAL enables Apple Maps. See ProductFeatures for details. Set at creation via AdAccountCreate (required).

creationTimedate-time

Timestamp when the ad account was created. Read-only.

modificationTimedate-time

Timestamp of the last modification to the ad account. Read-only.

Discussion

An AdAccount is the operational container for campaigns within an organization.

Each ad account is authorized for App Store or Apple Maps advertising, not both. You can’t combine the two on the same account.

The systemStatus field reflects operational readiness. If INACTIVE, check systemStatusReasons. Common causes include a missing payment method or pending tax verification.

Example

{
  "id": 123456789,
  "name": "AwayFinder Ad Account",
  "orgId": 987654321,
  "timezone": "America/New_York",
  "currency": "USD",
  "paymentModel": "PAYG",
  "systemStatus": "ACTIVE",
  "systemStatusReasons": [],
  "delegations": [
    {
      "resourceId": "12345678",
      "resourceType": "CONTENT_PROVIDER",
      "resourceName": "AwayFinder Apps"
    }
  ],
  "productFeatures": [
    "APPSTORE_APP_MANUAL"
  ],
  "creationTime": "2025-01-10T08:00:00.000",
  "modificationTime": "2025-01-10T08:00:00.000"
}

Topics

Type Aliases

See Also