@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Type Alias AccountReference

    AccountReference:
        | { account_id: string }
        | {
            brand: BrandReference;
            operator: string;
            operator_unit?: OperatorUnit;
            currency?: string;
            timezone?: string;
            sandbox?: boolean;
        }

    Account that owns the list. Required when the authenticated agent has access to multiple accounts; optional otherwise.

    Type Declaration

    • { account_id: string }
      • account_id: string

        Seller-assigned account identifier. For upstream-managed account namespaces, this value comes from list_accounts; for seller-defined namespaces without a list_accounts surface, it is supplied out-of-band. Buyer-declared account sellers MAY echo account_id from sync_accounts as an internal handle, but they MUST continue accepting the account's current natural-key AccountRef on subsequent calls. A former key tombstoned by identity reconciliation returns ACCOUNT_MOVED to authorized callers.

    • {
          brand: BrandReference;
          operator: string;
          operator_unit?: OperatorUnit;
          currency?: string;
          timezone?: string;
          sandbox?: boolean;
      }
      • brand: BrandReference
      • operator: string

        Domain of the entity operating on the brand's behalf. When the brand operates directly, this is the brand's domain.

      • Optionaloperator_unit?: OperatorUnit
      • Optionalcurrency?: string

        Immutable ISO 4217 transaction currency when the seller's advertiser object is currency-bound. When present, this is part of the natural account key and media buys on the account MUST use it. Omit when currency is selected independently per media buy.

      • Optionaltimezone?: string

        Immutable account timezone. Include it in the natural key when get_adcp_capabilities.account.timezone declares account_fixed with buyer_selected; omit it for seller_fixed or seller_assigned accounts.

      • Optionalsandbox?: boolean

        When true, references the sandbox account for this brand/operator pair. Defaults to false (production account).