ProxyUrlConfig
Configuration object that defines how a network request should be mapped to a proxy. The proxy behavior is determined by the selected strategy.
Parameters
The base URL of the publisher forward proxy (e.g., https://proxy.com).
Must be a valid absolute URL. SHOULD use HTTPS in production environments.
May include a custom port (e.g.,
https://proxy.com:8443).
Optional path appended to baseUrl to form the final proxy endpoint.
Defaults to an empty string. If provided, SHOULD begin with
/.
Example:
baseUrl = "https://proxy.com"
path = "/adswizz/sdk-proxy/v1/forward"Result:
https://proxy.com/adswizz/sdk-proxy/v1/forwardOptional headers appended to every proxied request.
Typically used for proxy authentication or routing metadata.
Values in this map override existing request headers with the same name.
Determines how the original destination URL is embedded into the proxied request.
Header name that can be used by all strategies to transmit the original request URL.
ProxyStrategy.HEADER_ORIGINAL_URL - the value MUST be non-empty, if it is empty or null, an exception will be raised.
ProxyStrategy.REWRITE_DOMAIN_ONLY - the header will not be present if the provided value is null or empty,
ProxyStrategy.QUERY_PARAM_ORIGINAL_URL - the header will not be present if the provided value is null or empty,
Default value: "X-Adswizz-Proxy-Original-URL"
The query parameter name used to embed the original request URL when using ProxyStrategy.QUERY_PARAM_ORIGINAL_URL.
Request URL becomes:
baseURL + path + ?target_uri=<urlEncoded(originalUrl)>Ignored for other strategies.
When using ProxyStrategy.QUERY_PARAM_ORIGINAL_URL, this value MUST be non-empty; if it is empty or null, an exception will be raised.
Default value: "target_uri".
Validation Recommendations
Implementations SHOULD validate:
baseUrl is a valid absolute URL.
path, if provided, starts with
/.originalUrlHeaderName is non-empty when using the HEADER_ORIGINAL_URL strategy.
originalUrlQueryParam is non-empty when using the QUERY_PARAM_ORIGINAL_URL strategy.
Changes to this configuration require SDK reinitialization.