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

    Function legacyReportUsageResponse

    • Parameters

      • data: {
            context?: Omit<Omit<{}, "bank">, "authentication"> & {
                authentication?: unknown;
            };
            governance_context?: string;
            accepted: number;
            errors?: {
                code: string;
                message: string;
                field?: string;
                suggestion?: string;
                retry_after?: number;
                issues?: {
                    pointer: string;
                    message: string;
                    keyword: string;
                    schemaPath?: string;
                    schema_id?: string;
                    discriminator?: {
                        property_name: string;
                        value: (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    }[];
                }[];
                details?: Omit<Omit<{}, "bank">, "authentication"> & {
                    authentication?: unknown;
                };
                recovery?: "transient"
                | "correctable"
                | "terminal";
                source?: "producer" | "sdk";
                sdk_id?: string;
            }[];
            sandbox?: boolean;
            ext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
                authentication?: unknown;
            };
        }
        • Optionalcontext?: Omit<Omit<{}, "bank">, "authentication"> & { authentication?: unknown }
        • Optionalgovernance_context?: string

          Opaque authorization context issued only by an approved check_governance decision. Buyers attach it to governed requests across protocol roles (media buys, rights acquisitions, signal activations, creative services); receiving services persist it and forward it on subsequent execution and lifecycle checks. The context is the authoritative plan binding at service boundaries, so a service MUST NOT require a separate plan_id.

          Governance agents MUST emit a compact JWS per the AdCP JWS profile. Verifiers validate standard authorization claims such as signature, issuer, audience, expiry, and replay protection, but intermediaries MUST NOT interpret embedded governance state for business logic. A conditions or denied verdict never carries an authorization context.

          This is the primary correlation key for audit and reporting across the governance lifecycle.

        • accepted: number

          Number of usage records successfully stored.

          0

        • Optionalerrors?: {
              code: string;
              message: string;
              field?: string;
              suggestion?: string;
              retry_after?: number;
              issues?: {
                  pointer: string;
                  message: string;
                  keyword: string;
                  schemaPath?: string;
                  schema_id?: string;
                  discriminator?: {
                      property_name: string;
                      value: (...) | (...) | (...) | (...) | (...);
                  }[];
              }[];
              details?: Omit<Omit<{}, "bank">, "authentication"> & {
                  authentication?: unknown;
              };
              recovery?: "transient"
              | "correctable"
              | "terminal";
              source?: "producer" | "sdk";
              sdk_id?: string;
          }[]

          Validation errors for individual records. The field property identifies which record failed (e.g., 'usage[1].pricing_option_id').

        • Optionalsandbox?: boolean

          When true, the account is a sandbox account and no billing occurred.

        • Optionalext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
              authentication?: unknown;
          }
      • Optionalsummary: string

      Returns McpToolResponse

      v6: createAdcpServerFromPlatform constructs wire responses from typed platform returns. Direct use is for v5 raw-handler adopters mid-migration only.

    Index

    Methods

    Methods

    • Shortcut for the common case: accept all rows in the request, optionally minus any errors[] the caller computed. Sets accepted = (request.usage?.length ?? 0) - errors.length.

      Use with honest errors — passing no errors when rows failed validation is lying to buyers and the audit trail.

      Parameters

      Returns McpToolResponse