@adcp/client 3.1.0 → 3.2.1

package/dist/lib/types/core.generated.d.ts

@@ -6,10 +6,6 @@ export type MediaBuyStatus = 'pending_activation' | 'active' | 'paused' | 'compl
  * Budget pacing strategy
  */
 export type Pacing = 'even' | 'asap' | 'front_loaded';
-/**
- * Status of a package
- */
-export type PackageStatus = 'draft' | 'active' | 'paused' | 'completed';
 /**
  * Represents a purchased advertising campaign
  */
@@ -47,6 +43,7 @@ export interface MediaBuy {
      * Last update timestamp
      */
     updated_at?: string;
+    ext?: ExtensionObject;
 }
 /**
  * A specific product within a media buy (line item)
@@ -90,7 +87,11 @@ export interface Package {
      * Format IDs that creative assets will be provided for this package
      */
     format_ids_to_provide?: FormatID[];
-    status: PackageStatus;
+    /**
+     * Whether this package is paused by the buyer. Paused packages do not deliver impressions. Defaults to false.
+     */
+    paused?: boolean;
+    ext?: ExtensionObject;
 }
 /**
  * Optional geographic refinements for media buys. Most targeting should be expressed in the brief and handled by the publisher. These fields are primarily for geographic restrictions (RCT testing, regulatory compliance).
@@ -151,7 +152,7 @@ export interface CreativeAssignment {
     placement_ids?: [string, ...string[]];
 }
 /**
- * Structured format identifier with agent URL and format name
+ * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
 export interface FormatID {
     /**
@@ -159,10 +160,70 @@ export interface FormatID {
      */
     agent_url: string;
     /**
-     * Format identifier within the agent's namespace (e.g., 'display_300x250', 'video_standard_30s')
+     * Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant.
      */
     id: string;
+    /**
+     * Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
+     */
+    width?: number;
+    /**
+     * Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
+     */
+    height?: number;
+    /**
+     * Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
+     */
+    duration_ms?: number;
 }
+/**
+ * Extension object for platform-specific, vendor-namespaced parameters. Extensions are always optional and must be namespaced under a vendor/platform key (e.g., ext.gam, ext.roku). Used for custom capabilities, partner-specific configuration, and features being proposed for standardization.
+ */
+export interface ExtensionObject {
+    [k: string]: unknown;
+}
+/**
+ * Image asset with URL and dimensions
+ */
+export type ImageAsset = Dimensions & {
+    /**
+     * URL to the image asset
+     */
+    url: string;
+    /**
+     * Image file format (jpg, png, gif, webp, etc.)
+     */
+    format?: string;
+    /**
+     * Alternative text for accessibility
+     */
+    alt_text?: string;
+};
+/**
+ * Video asset with URL and specifications
+ */
+export type VideoAsset = Dimensions & {
+    /**
+     * URL to the video asset
+     */
+    url: string;
+    /**
+     * Video duration in milliseconds
+     */
+    duration_ms?: number;
+    /**
+     * Video file format (mp4, webm, mov, etc.)
+     */
+    format?: string;
+    /**
+     * Video bitrate in kilobits per second
+     */
+    bitrate_kbps?: number;
+};
+/**
+ * JavaScript module type
+ */
+export type JavaScriptModuleType = 'esm' | 'commonjs' | 'script';
 /**
  * VAST (Video Ad Serving Template) tag for third-party video ad serving
  */
@@ -175,10 +236,7 @@ export type VASTAsset = {
      * URL endpoint that returns VAST XML
      */
     url: string;
-    /**
-     * VAST specification version
-     */
-    vast_version?: '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
+    vast_version?: VASTVersion;
     /**
      * Whether VPAID (Video Player-Ad Interface Definition) is supported
      */
@@ -190,7 +248,7 @@ export type VASTAsset = {
     /**
      * Tracking events supported by this VAST tag
      */
-    tracking_events?: ('start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'click' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute' | 'fullscreen' | 'exitFullscreen' | 'playerExpand' | 'playerCollapse')[];
+    tracking_events?: VASTTrackingEvent[];
 } | {
     /**
      * Discriminator indicating VAST is delivered as inline XML content
@@ -200,10 +258,7 @@ export type VASTAsset = {
      * Inline VAST XML content
      */
     content: string;
-    /**
-     * VAST specification version
-     */
-    vast_version?: '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
+    vast_version?: VASTVersion1;
     /**
      * Whether VPAID (Video Player-Ad Interface Definition) is supported
      */
@@ -215,8 +270,20 @@ export type VASTAsset = {
     /**
      * Tracking events supported by this VAST tag
      */
-    tracking_events?: ('start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'click' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute' | 'fullscreen' | 'exitFullscreen' | 'playerExpand' | 'playerCollapse')[];
+    tracking_events?: VASTTrackingEvent[];
 };
+/**
+ * VAST specification version
+ */
+export type VASTVersion = '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
+/**
+ * Standard VAST tracking events for video ad playback and interaction
+ */
+export type VASTTrackingEvent = 'start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'click' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute' | 'fullscreen' | 'exitFullscreen' | 'playerExpand' | 'playerCollapse';
+/**
+ * VAST specification version
+ */
+export type VASTVersion1 = '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
 /**
  * DAAST (Digital Audio Ad Serving Template) tag for third-party audio ad serving
  */
@@ -229,10 +296,7 @@ export type DAASTAsset = {
      * URL endpoint that returns DAAST XML
      */
     url: string;
-    /**
-     * DAAST specification version
-     */
-    daast_version?: '1.0' | '1.1';
+    daast_version?: DAASTVersion;
     /**
      * Expected audio duration in milliseconds (if known)
      */
@@ -240,7 +304,7 @@ export type DAASTAsset = {
     /**
      * Tracking events supported by this DAAST tag
      */
-    tracking_events?: ('start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute')[];
+    tracking_events?: DAASTTrackingEvent[];
     /**
      * Whether companion display ads are included
      */
@@ -254,10 +318,7 @@ export type DAASTAsset = {
      * Inline DAAST XML content
      */
     content: string;
-    /**
-     * DAAST specification version
-     */
-    daast_version?: '1.0' | '1.1';
+    daast_version?: DAASTVersion1;
     /**
      * Expected audio duration in milliseconds (if known)
      */
@@ -265,12 +326,24 @@ export type DAASTAsset = {
     /**
      * Tracking events supported by this DAAST tag
      */
-    tracking_events?: ('start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute')[];
+    tracking_events?: DAASTTrackingEvent[];
     /**
      * Whether companion display ads are included
      */
     companion_ads?: boolean;
 };
+/**
+ * DAAST specification version
+ */
+export type DAASTVersion = '1.0' | '1.1';
+/**
+ * Standard DAAST tracking events for audio ad playback and interaction
+ */
+export type DAASTTrackingEvent = 'start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute';
+/**
+ * DAAST specification version
+ */
+export type DAASTVersion1 = '1.0' | '1.1';
 /**
  * Brand information manifest containing assets, themes, and guidelines. Can be provided inline or as a URL reference to a hosted manifest.
  */
@@ -279,6 +352,10 @@ export type BrandManifestReference = BrandManifest | string;
  * Type of asset. Note: Brand manifests typically contain basic media assets (image, video, audio, text). Code assets (html, javascript, css) and ad markup (vast, daast) are usually not part of brand asset libraries.
  */
 export type AssetContentType = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
+/**
+ * Type of URL asset: 'clickthrough' for user click destination (landing page), 'tracker_pixel' for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), 'tracker_script' for measurement SDKs that must load as <script> tag (OMID verification, native event trackers using method:2)
+ */
+export type URLAssetType = 'clickthrough' | 'tracker_pixel' | 'tracker_script';
 /**
  * Creative asset for upload to library - supports static assets, generative formats, and third-party snippets
  */
@@ -329,73 +406,29 @@ export interface CreativeAsset {
      * For generative creatives: set to true to approve and finalize, false to request regeneration with updated assets/message. Omit for non-generative creatives.
      */
     approved?: boolean;
-}
-/**
- * Format identifier specifying which format this creative conforms to
- */
-export interface FormatID {
     /**
-     * URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)
-     */
-    agent_url: string;
-    /**
-     * Format identifier within the agent's namespace (e.g., 'display_300x250', 'video_standard_30s')
-     */
-    id: string;
-}
-/**
- * Image asset with URL and dimensions
- */
-export interface ImageAsset {
-    /**
-     * URL to the image asset
-     */
-    url: string;
-    /**
-     * Image width in pixels
+     * Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.
      */
-    width?: number;
-    /**
-     * Image height in pixels
-     */
-    height?: number;
-    /**
-     * Image file format (jpg, png, gif, webp, etc.)
-     */
-    format?: string;
+    weight?: number;
     /**
-     * Alternative text for accessibility
+     * Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.
+     *
+     * @minItems 1
      */
-    alt_text?: string;
+    placement_ids?: [string, ...string[]];
 }
 /**
- * Video asset with URL and specifications
+ * Format identifier specifying which format this creative conforms to. Can be: (1) concrete format_id referencing a format with fixed dimensions, (2) template format_id referencing a template format, or (3) parameterized format_id with dimensions/duration parameters for template formats.
  */
-export interface VideoAsset {
-    /**
-     * URL to the video asset
-     */
-    url: string;
+export interface Dimensions {
     /**
-     * Video width in pixels
+     * Width in pixels
      */
-    width?: number;
+    width: number;
     /**
-     * Video height in pixels
+     * Height in pixels
      */
-    height?: number;
-    /**
-     * Video duration in milliseconds
-     */
-    duration_ms?: number;
-    /**
-     * Video file format (mp4, webm, mov, etc.)
-     */
-    format?: string;
-    /**
-     * Video bitrate in kilobits per second
-     */
-    bitrate_kbps?: number;
+    height: number;
 }
 /**
  * Audio asset with URL and specifications
@@ -465,10 +498,7 @@ export interface JavaScriptAsset {
      * JavaScript content
      */
     content: string;
-    /**
-     * JavaScript module type
-     */
-    module_type?: 'esm' | 'commonjs' | 'script';
+    module_type?: JavaScriptModuleType;
 }
 /**
  * Complete offering specification combining brand manifest, product selectors, and asset filters. Provides all context needed for creative generation about what is being promoted.
@@ -758,10 +788,7 @@ export interface URLAsset {
      * URL reference
      */
     url: string;
-    /**
-     * Type of URL asset: 'clickthrough' for user click destination (landing page), 'tracker_pixel' for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), 'tracker_script' for measurement SDKs that must load as <script> tag (OMID verification, native event trackers using method:2)
-     */
-    url_type?: 'clickthrough' | 'tracker_pixel' | 'tracker_script';
+    url_type?: URLAssetType;
     /**
      * Description of what this URL points to
      */
@@ -793,7 +820,7 @@ export type PublisherPropertySelector = {
      *
      * @minItems 1
      */
-    property_ids: [string, ...string[]];
+    property_ids: [PropertyID, ...PropertyID[]];
 } | {
     /**
      * Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
@@ -808,8 +835,16 @@ export type PublisherPropertySelector = {
      *
      * @minItems 1
      */
-    property_tags: [string, ...string[]];
+    property_tags: [PropertyTag, ...PropertyTag[]];
 };
+/**
+ * Identifier for a publisher property. Must be lowercase alphanumeric with underscores only.
+ */
+export type PropertyID = string;
+/**
+ * Tag for categorizing publisher properties. Must be lowercase alphanumeric with underscores only.
+ */
+export type PropertyTag = string;
 /**
  * Type of inventory delivery
  */
@@ -818,6 +853,22 @@ export type DeliveryType = 'guaranteed' | 'non_guaranteed';
  * A pricing model option offered by a publisher for a product. Each pricing model has its own schema with model-specific requirements.
  */
 export type PricingOption = CPMFixedRatePricingOption | CPMAuctionPricingOption | VCPMFixedRatePricingOption | VCPMAuctionPricingOption | CPCPricingOption | CPCVPricingOption | CPVPricingOption | CPPPricingOption | FlatRatePricingOption;
+/**
+ * Available frequencies for delivery reports and metrics updates
+ */
+export type ReportingFrequency = 'hourly' | 'daily' | 'monthly';
+/**
+ * Standard delivery and performance metrics available for reporting
+ */
+export type AvailableMetric = 'impressions' | 'spend' | 'clicks' | 'ctr' | 'video_completions' | 'completion_rate' | 'conversions' | 'viewability' | 'engagement_rate';
+/**
+ * Co-branding requirement
+ */
+export type CoBrandingRequirement = 'required' | 'optional' | 'none';
+/**
+ * Landing page requirements
+ */
+export type LandingPageRequirement = 'any' | 'retailer_site_only' | 'must_include_retailer';
 /**
  * Represents available advertising inventory
  */
@@ -909,22 +960,10 @@ export interface Product {
          */
         manifest: {};
     };
+    ext?: ExtensionObject;
 }
 /**
- * Structured format identifier with agent URL and format name
- */
-export interface FormatID {
-    /**
-     * URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)
-     */
-    agent_url: string;
-    /**
-     * Format identifier within the agent's namespace (e.g., 'display_300x250', 'video_standard_30s')
-     */
-    id: string;
-}
-/**
- * Represents a specific ad placement within a product's inventory
+ * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
 export interface Placement {
     /**
@@ -940,7 +979,7 @@ export interface Placement {
      */
     description?: string;
     /**
-     * Format IDs supported by this specific placement (subset of product's formats)
+     * Format IDs supported by this specific placement. Can include: (1) concrete format_ids (fixed dimensions), (2) template format_ids without parameters (accepts any dimensions/duration), or (3) parameterized format_ids (specific dimension/duration constraints).
      *
      * @minItems 1
      */
@@ -1336,7 +1375,7 @@ export interface ReportingCapabilities {
      *
      * @minItems 1
      */
-    available_reporting_frequencies: ['hourly' | 'daily' | 'monthly', ...('hourly' | 'daily' | 'monthly')[]];
+    available_reporting_frequencies: [ReportingFrequency, ...ReportingFrequency[]];
     /**
      * Expected delay in minutes before reporting data becomes available (e.g., 240 for 4-hour delay)
      */
@@ -1352,27 +1391,21 @@ export interface ReportingCapabilities {
     /**
      * Metrics available in reporting. Impressions and spend are always implicitly included.
      */
-    available_metrics: ('impressions' | 'spend' | 'clicks' | 'ctr' | 'video_completions' | 'completion_rate' | 'conversions' | 'viewability' | 'engagement_rate')[];
+    available_metrics: AvailableMetric[];
 }
 /**
  * Creative requirements and restrictions for a product
  */
 export interface CreativePolicy {
-    /**
-     * Co-branding requirement
-     */
-    co_branding: 'required' | 'optional' | 'none';
-    /**
-     * Landing page requirements
-     */
-    landing_page: 'any' | 'retailer_site_only' | 'must_include_retailer';
+    co_branding: CoBrandingRequirement;
+    landing_page: LandingPageRequirement;
     /**
      * Whether creative templates are provided
      */
     templates_available: boolean;
 }
 /**
- * Structured format identifier with agent URL and format name
+ * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
 export interface FormatID1 {
     /**
@@ -1380,78 +1413,67 @@ export interface FormatID1 {
      */
     agent_url: string;
     /**
-     * Format identifier within the agent's namespace (e.g., 'display_300x250', 'video_standard_30s')
+     * Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant.
      */
     id: string;
-}
-/**
- * Structured format identifier with agent URL and format name
- */
-export interface FormatID2 {
     /**
-     * URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)
+     * Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
      */
-    agent_url: string;
+    width?: number;
     /**
-     * Format identifier within the agent's namespace (e.g., 'display_300x250', 'video_standard_30s')
+     * Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
      */
-    id: string;
+    height?: number;
+    /**
+     * Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
+     */
+    duration_ms?: number;
 }
 /**
- * Optional geographic refinements for media buys. Most targeting should be expressed in the brief and handled by the publisher. These fields are primarily for geographic restrictions (RCT testing, regulatory compliance).
+ * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
-export interface TargetingOverlay {
-    /**
-     * Restrict delivery to specific countries (ISO codes). Use for regulatory compliance or RCT testing.
-     */
-    geo_country_any_of?: string[];
+export interface FormatID2 {
     /**
-     * Restrict delivery to specific regions/states. Use for regulatory compliance or RCT testing.
+     * URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)
      */
-    geo_region_any_of?: string[];
+    agent_url: string;
     /**
-     * Restrict delivery to specific metro areas (DMA codes). Use for regulatory compliance or RCT testing.
+     * Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant.
      */
-    geo_metro_any_of?: string[];
+    id: string;
     /**
-     * Restrict delivery to specific postal/ZIP codes. Use for regulatory compliance or RCT testing.
+     * Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
      */
-    geo_postal_code_any_of?: string[];
+    width?: number;
     /**
-     * AXE segment ID to include for targeting
+     * Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
      */
-    axe_include_segment?: string;
+    height?: number;
     /**
-     * AXE segment ID to exclude from targeting
+     * Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
      */
-    axe_exclude_segment?: string;
-    frequency_cap?: FrequencyCap;
+    duration_ms?: number;
 }
 /**
- * Frequency capping settings for package-level application
+ * Extension object for platform-specific, vendor-namespaced parameters. Extensions are always optional and must be namespaced under a vendor/platform key (e.g., ext.gam, ext.roku). Used for custom capabilities, partner-specific configuration, and features being proposed for standardization.
  */
-export interface FrequencyCap {
-    /**
-     * Minutes to suppress after impression
-     */
-    suppress_minutes: number;
-}
+/**
+ * Optional geographic refinements for media buys. Most targeting should be expressed in the brief and handled by the publisher. These fields are primarily for geographic restrictions (RCT testing, regulatory compliance).
+ */
+/**
+ * Unique identifier for this property (optional). Enables referencing properties by ID instead of repeating full objects.
+ */
+export type PropertyType = 'website' | 'mobile_app' | 'ctv_app' | 'dooh' | 'podcast' | 'radio' | 'streaming_audio';
 /**
  * Type of identifier for this property
  */
 export type PropertyIdentifierTypes = 'domain' | 'subdomain' | 'network_id' | 'ios_bundle' | 'android_package' | 'apple_app_store_id' | 'google_play_id' | 'roku_store_id' | 'fire_tv_asin' | 'samsung_app_id' | 'apple_tv_bundle' | 'bundle_id' | 'venue_id' | 'screen_id' | 'openooh_venue_type' | 'rss_url' | 'apple_podcast_id' | 'spotify_show_id' | 'podcast_guid';
 /**
- * An advertising property that can be validated via adagents.json
+ * Tag for categorizing publisher properties. Must be lowercase alphanumeric with underscores only.
  */
 export interface Property {
-    /**
-     * Unique identifier for this property (optional). Enables referencing properties by ID instead of repeating full objects. Recommended format: lowercase with underscores (e.g., 'cnn_ctv_app', 'instagram_mobile')
-     */
-    property_id?: string;
-    /**
-     * Type of advertising property
-     */
-    property_type: 'website' | 'mobile_app' | 'ctv_app' | 'dooh' | 'podcast' | 'radio' | 'streaming_audio';
+    property_id?: PropertyID;
+    property_type: PropertyType;
     /**
      * Human-readable property name
      */
@@ -1480,7 +1502,7 @@ export interface Property {
     /**
      * Tags for categorization and grouping (e.g., network membership, content categories)
      */
-    tags?: string[];
+    tags?: PropertyTag[];
     /**
      * Domain where adagents.json should be checked for authorization validation. Required for list_authorized_properties response. Optional in adagents.json (file location implies domain).
      */