WIRESYNDICATEDocumentation

Godot SDK API Reference

This document outlines the programmatic interfaces for the WireSyndicate Godot SDK (WireSyndicate singleton and WSPlacementNode). The APIs reflect the v1.2.0 specification, which achieved feature parity with the Unity SDK.

Core Initialization

Before using any other SDK methods, you must initialize the edge connection with your valid Developer API Key.

WireSyndicate.authenticate(api_key: String)

Authenticates the client session with the Edge Delivery Node. This executes the Zero-Trust handshake required for subsequent payload requests and telemetry validation.

Parameters:

  • api_key (String): Your publisher Organization ID or Network Key.

Content Delivery & Caching (v1.2.0)

In v1.2.0, we introduced granular cache policies to optimize spatial payload delivery across multiple placement nodes in the same scene.

WireSyndicate.set_cache_policy(policy: int)

Defines how aggressively the SDK caches texture payloads in memory and on disk.

Parameters:

  • policy (int): An enum value representing the caching strategy.
    • 0: NO_CACHE - Every payload request bypasses the cache and forces a fresh network call.
    • 1: MEMORY_ONLY - Payloads are cached in memory for the duration of the session. Ideal for fast loads of repeated assets.
    • 2: MEMORY_AND_DISK - (Default) Payloads are cached to the OS's temporary user directory.

Geolocation (v1.2.0)

Geo-fenced campaigns require accurate coordinate data from the client device. The SDK natively supports injecting location context prior to fetching programmatic bids.

WireSyndicate.update_location(latitude: float, longitude: float)

Injects the client's current geospatial coordinates into the active session context. All subsequent placement node requests will evaluate bids against this location.

Parameters:

  • latitude (float): The WGS84 latitude.
  • longitude (float): The WGS84 longitude.

Privacy Note: Coordinate data is processed entirely ephemerally by the Edge Delivery Node and is never stored in our permanent databases, adhering strictly to global privacy frameworks.

Telemetry & Impressions

To securely credit your developer account for impressions, the SDK mandates dispatching cryptographically verifiable telemetry tokens.

WireSyndicate.dispatch_impression(token: String, placement_id: String, bid_id: String, dwell_time: float, coverage: float)

Transmits an impression validation event to the Edge Node.

Parameters:

  • token (String): A unique UUID v4 generated locally for this exact impression lifecycle.
  • placement_id (String): The ID of the placement surface.
  • bid_id (String): The active bid ID provided by the WSPlacementNode after a successful delivery.
  • dwell_time (float): The duration (in seconds) the asset was continuously visible on-screen.
  • coverage (float): The estimated percentage of the screen space occupied by the asset.

Enforcement Policy: The WireSyndicate DLP engine aggressively filters bot traffic and invisible impressions. Ensure you only dispatch telemetry when the asset passes rigorous on-screen visibility and occlusion tests.