@adcp/sdk 13.0.0-rc.2 → 13.0.0-rc.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -14
- package/dist/lib/index.d.mts +1 -1
- package/dist/lib/index.d.ts +1 -1
- package/dist/lib/index.d.ts.map +1 -1
- package/dist/lib/index.js.map +1 -1
- package/dist/lib/index.mjs.map +1 -1
- package/dist/lib/protocols/mcp-modern.d.ts.map +1 -1
- package/dist/lib/protocols/mcp-modern.js +14 -0
- package/dist/lib/protocols/mcp-modern.js.map +1 -1
- package/dist/lib/protocols/mcp-modern.mjs +14 -0
- package/dist/lib/protocols/mcp-modern.mjs.map +1 -1
- package/dist/lib/registry/index.d.mts +5 -25
- package/dist/lib/registry/index.d.ts +5 -25
- package/dist/lib/registry/index.d.ts.map +1 -1
- package/dist/lib/registry/index.js +5 -130
- package/dist/lib/registry/index.js.map +1 -1
- package/dist/lib/registry/index.mjs +5 -130
- package/dist/lib/registry/index.mjs.map +1 -1
- package/dist/lib/registry/sync.d.mts +8 -2
- package/dist/lib/registry/sync.d.ts +8 -2
- package/dist/lib/registry/sync.d.ts.map +1 -1
- package/dist/lib/registry/sync.js +8 -2
- package/dist/lib/registry/sync.js.map +1 -1
- package/dist/lib/registry/sync.mjs +8 -2
- package/dist/lib/registry/sync.mjs.map +1 -1
- package/dist/lib/registry/types.d.mts +15 -29
- package/dist/lib/registry/types.d.ts +15 -29
- package/dist/lib/registry/types.d.ts.map +1 -1
- package/dist/lib/registry/types.generated.d.mts +20 -5
- package/dist/lib/registry/types.generated.d.ts +20 -5
- package/dist/lib/registry/types.generated.d.ts.map +1 -1
- package/dist/lib/registry/types.generated.js.map +1 -1
- package/dist/lib/registry/types.js.map +1 -1
- package/dist/lib/schemas-data/v2.5/_provenance.json +1 -1
- package/dist/lib/testing/storyboard/runner.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/runner.js +40 -6
- package/dist/lib/testing/storyboard/runner.js.map +1 -1
- package/dist/lib/testing/storyboard/runner.mjs +40 -6
- package/dist/lib/testing/storyboard/runner.mjs.map +1 -1
- package/dist/lib/types/core.generated.d.mts +105 -58
- package/dist/lib/types/core.generated.d.ts +105 -58
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js.map +1 -1
- package/dist/lib/types/schemas.generated.d.mts +2352 -473
- package/dist/lib/types/schemas.generated.d.ts +2352 -473
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +78 -45
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/schemas.generated.mjs +71 -45
- package/dist/lib/types/schemas.generated.mjs.map +1 -1
- package/dist/lib/types/tools.generated.d.mts +48 -44
- package/dist/lib/types/tools.generated.d.ts +48 -44
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/types/tools.generated.js.map +1 -1
- package/dist/lib/version.d.mts +3 -3
- package/dist/lib/version.d.ts +3 -3
- package/dist/lib/version.js +3 -3
- package/dist/lib/version.js.map +1 -1
- package/dist/lib/version.mjs +3 -3
- package/dist/lib/version.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -14387,37 +14387,37 @@ export type TasksGetResponse = ProtocolEnvelope & {
|
|
|
14387
14387
|
* Valid country-local postal system pairing. Registered countries only accept their registered local systems; countries without a registered local system use postal_code or custom.
|
|
14388
14388
|
*/
|
|
14389
14389
|
export type PostalCountrySystem = {
|
|
14390
|
-
country
|
|
14391
|
-
system
|
|
14390
|
+
country: 'US';
|
|
14391
|
+
system: 'zip' | 'zip_plus_four';
|
|
14392
14392
|
} | {
|
|
14393
|
-
country
|
|
14394
|
-
system
|
|
14393
|
+
country: 'GB';
|
|
14394
|
+
system: 'outward' | 'full';
|
|
14395
14395
|
} | {
|
|
14396
|
-
country
|
|
14397
|
-
system
|
|
14396
|
+
country: 'CA';
|
|
14397
|
+
system: 'fsa' | 'full';
|
|
14398
14398
|
} | {
|
|
14399
|
-
country
|
|
14400
|
-
system
|
|
14399
|
+
country: 'DE' | 'CH' | 'AT';
|
|
14400
|
+
system: 'plz';
|
|
14401
14401
|
} | {
|
|
14402
|
-
country
|
|
14403
|
-
system
|
|
14402
|
+
country: 'FR';
|
|
14403
|
+
system: 'code_postal';
|
|
14404
14404
|
} | {
|
|
14405
|
-
country
|
|
14406
|
-
system
|
|
14405
|
+
country: 'AU';
|
|
14406
|
+
system: 'postcode';
|
|
14407
14407
|
} | {
|
|
14408
|
-
country
|
|
14409
|
-
system
|
|
14408
|
+
country: 'BR';
|
|
14409
|
+
system: 'cep';
|
|
14410
14410
|
} | {
|
|
14411
|
-
country
|
|
14412
|
-
system
|
|
14411
|
+
country: 'IN';
|
|
14412
|
+
system: 'pin';
|
|
14413
14413
|
} | {
|
|
14414
|
-
country
|
|
14415
|
-
system
|
|
14414
|
+
country: 'ZA';
|
|
14415
|
+
system: 'postal_code';
|
|
14416
14416
|
} | {
|
|
14417
|
-
country
|
|
14417
|
+
country: {
|
|
14418
14418
|
[k: string]: unknown | undefined;
|
|
14419
14419
|
};
|
|
14420
|
-
system
|
|
14420
|
+
system: 'postal_code' | 'custom';
|
|
14421
14421
|
};
|
|
14422
14422
|
/**
|
|
14423
14423
|
* Re-export of `PostalArea` under the legacy codegen artifact name.
|
|
@@ -18148,7 +18148,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18148
18148
|
/**
|
|
18149
18149
|
* Delivery by catalog item within this package. Available for catalog-driven packages when the seller supports item-level reporting.
|
|
18150
18150
|
*/
|
|
18151
|
-
by_catalog_item?:
|
|
18151
|
+
by_catalog_item?: GetMediaBuyDeliveryCatalogItemMetrics[];
|
|
18152
18152
|
/**
|
|
18153
18153
|
* Metrics broken down by creative within this package. Available when the seller supports creative-level reporting.
|
|
18154
18154
|
*/
|
|
@@ -18156,11 +18156,11 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18156
18156
|
/**
|
|
18157
18157
|
* Metrics broken down by keyword within this package. One row per (keyword, match_type) pair — the same keyword with different match types appears as separate rows. Keyword-grain only: rows reflect aggregate performance of each targeted keyword, not individual search queries. Rows may not sum to package totals when a single impression is attributed to the triggering keyword only. Available for search and retail media packages when the seller supports keyword-level reporting.
|
|
18158
18158
|
*/
|
|
18159
|
-
by_keyword?:
|
|
18159
|
+
by_keyword?: GetMediaBuyDeliveryKeywordMetrics[];
|
|
18160
18160
|
/**
|
|
18161
18161
|
* Delivery by geographic area within this package. Available when the buyer requests geo breakdown via reporting_dimensions and the seller supports it. Each dimension's rows are independent slices that should sum to the package total.
|
|
18162
18162
|
*/
|
|
18163
|
-
by_geo?:
|
|
18163
|
+
by_geo?: GetMediaBuyDeliveryGeoMetrics[];
|
|
18164
18164
|
/**
|
|
18165
18165
|
* Whether by_geo was truncated due to the requested limit or a seller-imposed maximum. Sellers MUST return this flag whenever by_geo is present (false means the list is complete).
|
|
18166
18166
|
*/
|
|
@@ -18168,9 +18168,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18168
18168
|
/**
|
|
18169
18169
|
* Delivery by device form factor within this package. Available when the buyer requests device_type breakdown via reporting_dimensions and the seller supports it.
|
|
18170
18170
|
*/
|
|
18171
|
-
by_device_type?:
|
|
18172
|
-
device_type?: DeviceType;
|
|
18173
|
-
})[];
|
|
18171
|
+
by_device_type?: GetMediaBuyDeliveryDeviceTypeMetrics[];
|
|
18174
18172
|
/**
|
|
18175
18173
|
* Whether by_device_type was truncated. Sellers MUST return this flag whenever by_device_type is present (false means the list is complete).
|
|
18176
18174
|
*/
|
|
@@ -18178,9 +18176,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18178
18176
|
/**
|
|
18179
18177
|
* Delivery by operating system within this package. Available when the buyer requests device_platform breakdown via reporting_dimensions and the seller supports it. Useful for CTV campaigns where tvOS vs Roku OS vs Fire OS matters.
|
|
18180
18178
|
*/
|
|
18181
|
-
by_device_platform?:
|
|
18182
|
-
device_platform?: DevicePlatform;
|
|
18183
|
-
})[];
|
|
18179
|
+
by_device_platform?: GetMediaBuyDeliveryDevicePlatformMetrics[];
|
|
18184
18180
|
/**
|
|
18185
18181
|
* Whether by_device_platform was truncated. Sellers MUST return this flag whenever by_device_platform is present (false means the list is complete).
|
|
18186
18182
|
*/
|
|
@@ -18188,17 +18184,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18188
18184
|
/**
|
|
18189
18185
|
* Delivery by audience segment within this package. Available when the buyer requests audience breakdown via reporting_dimensions and the seller supports it. Only 'synced' audiences are directly targetable via the targeting overlay; other sources are informational.
|
|
18190
18186
|
*/
|
|
18191
|
-
by_audience?:
|
|
18192
|
-
/**
|
|
18193
|
-
* Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
|
|
18194
|
-
*/
|
|
18195
|
-
audience_id?: string;
|
|
18196
|
-
audience_source?: AudienceSource;
|
|
18197
|
-
/**
|
|
18198
|
-
* Human-readable audience segment name
|
|
18199
|
-
*/
|
|
18200
|
-
audience_name?: string;
|
|
18201
|
-
})[];
|
|
18187
|
+
by_audience?: GetMediaBuyDeliveryAudienceMetrics[];
|
|
18202
18188
|
/**
|
|
18203
18189
|
* Whether by_audience was truncated. Sellers MUST return this flag whenever by_audience is present (false means the list is complete).
|
|
18204
18190
|
*/
|
|
@@ -18206,21 +18192,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18206
18192
|
/**
|
|
18207
18193
|
* Delivery by placement within this package. Available when the buyer requests placement breakdown via reporting_dimensions and the seller supports it. Placement IDs reference the product's placements array.
|
|
18208
18194
|
*/
|
|
18209
|
-
by_placement?:
|
|
18210
|
-
/**
|
|
18211
|
-
* Placement identifier from the product's placements array
|
|
18212
|
-
*/
|
|
18213
|
-
placement_id?: string;
|
|
18214
|
-
/**
|
|
18215
|
-
* Human-readable placement name
|
|
18216
|
-
*/
|
|
18217
|
-
placement_name?: string;
|
|
18218
|
-
/**
|
|
18219
|
-
* Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
|
|
18220
|
-
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
18221
|
-
*/
|
|
18222
|
-
publisher_domain?: string;
|
|
18223
|
-
})[];
|
|
18195
|
+
by_placement?: GetMediaBuyDeliveryPlacementMetrics[];
|
|
18224
18196
|
/**
|
|
18225
18197
|
* Whether by_placement was truncated. Sellers MUST return this flag whenever by_placement is present (false means the list is complete).
|
|
18226
18198
|
*/
|
|
@@ -18465,7 +18437,7 @@ export type MissingMetric = {
|
|
|
18465
18437
|
/**
|
|
18466
18438
|
* Delivery metrics row for one catalog item within a package.
|
|
18467
18439
|
*/
|
|
18468
|
-
export type
|
|
18440
|
+
export type GetMediaBuyDeliveryCatalogItemMetrics = DeliveryMetrics & {
|
|
18469
18441
|
/**
|
|
18470
18442
|
* Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
|
|
18471
18443
|
*/
|
|
@@ -18490,7 +18462,7 @@ export type CreativeDeliveryMetrics = DeliveryMetrics & {
|
|
|
18490
18462
|
/**
|
|
18491
18463
|
* Delivery metrics row for one keyword and match-type pair within a package.
|
|
18492
18464
|
*/
|
|
18493
|
-
export type
|
|
18465
|
+
export type GetMediaBuyDeliveryKeywordMetrics = DeliveryMetrics & {
|
|
18494
18466
|
/**
|
|
18495
18467
|
* The targeted keyword
|
|
18496
18468
|
*/
|
|
@@ -18500,7 +18472,7 @@ export type KeywordDeliveryMetrics = DeliveryMetrics & {
|
|
|
18500
18472
|
/**
|
|
18501
18473
|
* Delivery metrics row for one geographic area within a package.
|
|
18502
18474
|
*/
|
|
18503
|
-
export type
|
|
18475
|
+
export type GetMediaBuyDeliveryGeoMetrics = DeliveryMetrics & {
|
|
18504
18476
|
geo_level?: GeographicTargetingLevel;
|
|
18505
18477
|
/**
|
|
18506
18478
|
* Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
|
|
@@ -18520,6 +18492,38 @@ export type GeoDeliveryMetrics = DeliveryMetrics & {
|
|
|
18520
18492
|
*/
|
|
18521
18493
|
geo_name?: string;
|
|
18522
18494
|
};
|
|
18495
|
+
export type GetMediaBuyDeliveryDeviceTypeMetrics = DeliveryMetrics & {
|
|
18496
|
+
device_type?: DeviceType;
|
|
18497
|
+
};
|
|
18498
|
+
export type GetMediaBuyDeliveryDevicePlatformMetrics = DeliveryMetrics & {
|
|
18499
|
+
device_platform?: DevicePlatform;
|
|
18500
|
+
};
|
|
18501
|
+
export type GetMediaBuyDeliveryAudienceMetrics = DeliveryMetrics & {
|
|
18502
|
+
/**
|
|
18503
|
+
* Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
|
|
18504
|
+
*/
|
|
18505
|
+
audience_id?: string;
|
|
18506
|
+
audience_source?: AudienceSource;
|
|
18507
|
+
/**
|
|
18508
|
+
* Human-readable audience segment name
|
|
18509
|
+
*/
|
|
18510
|
+
audience_name?: string;
|
|
18511
|
+
};
|
|
18512
|
+
export type GetMediaBuyDeliveryPlacementMetrics = DeliveryMetrics & {
|
|
18513
|
+
/**
|
|
18514
|
+
* Placement identifier from the product's placements array
|
|
18515
|
+
*/
|
|
18516
|
+
placement_id?: string;
|
|
18517
|
+
/**
|
|
18518
|
+
* Human-readable placement name
|
|
18519
|
+
*/
|
|
18520
|
+
placement_name?: string;
|
|
18521
|
+
/**
|
|
18522
|
+
* Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
|
|
18523
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
18524
|
+
*/
|
|
18525
|
+
publisher_domain?: string;
|
|
18526
|
+
};
|
|
18523
18527
|
/**
|
|
18524
18528
|
* Request parameters for retrieving media buy status, creative approval state, and optional delivery snapshots
|
|
18525
18529
|
*/
|
|
@@ -24182,6 +24186,16 @@ export interface CanonicalProjectionSlotOverride {
|
|
|
24182
24186
|
*/
|
|
24183
24187
|
consumed_for_production?: boolean;
|
|
24184
24188
|
}
|
|
24189
|
+
/**
|
|
24190
|
+
* Delivery metrics row for one catalog item within a package.
|
|
24191
|
+
*/
|
|
24192
|
+
export type CatalogItemDeliveryMetrics = DeliveryMetrics & {
|
|
24193
|
+
/**
|
|
24194
|
+
* Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
|
|
24195
|
+
*/
|
|
24196
|
+
content_id: string;
|
|
24197
|
+
content_id_type?: ContentIDType;
|
|
24198
|
+
};
|
|
24185
24199
|
/**
|
|
24186
24200
|
* A catchment area definition for a store or location. Defines the geographic area from which a store draws customers. Three methods are supported: isochrone inputs (travel time + transport mode, platform resolves the shape), simple radius (distance from location), or pre-computed GeoJSON geometry (buyer provides the exact boundary). Provide exactly one method per catchment.
|
|
24187
24201
|
*/
|
|
@@ -25278,6 +25292,29 @@ export interface BaseGroupAsset {
|
|
|
25278
25292
|
*/
|
|
25279
25293
|
overlays?: Overlay[];
|
|
25280
25294
|
}
|
|
25295
|
+
/**
|
|
25296
|
+
* Delivery metrics row for one geographic area within a package.
|
|
25297
|
+
*/
|
|
25298
|
+
export type GeoDeliveryMetrics = DeliveryMetrics & {
|
|
25299
|
+
geo_level: GeographicTargetingLevel;
|
|
25300
|
+
/**
|
|
25301
|
+
* Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
|
|
25302
|
+
*/
|
|
25303
|
+
system?: string;
|
|
25304
|
+
/**
|
|
25305
|
+
* ISO 3166-1 alpha-2 country code for native postal_area rows.
|
|
25306
|
+
* @pattern ^[A-Z]{2}$
|
|
25307
|
+
*/
|
|
25308
|
+
country?: string;
|
|
25309
|
+
/**
|
|
25310
|
+
* Geographic code within the level and system. Country: ISO 3166-1 alpha-2 ('US'). Region: ISO 3166-2 with country prefix ('US-CA'). Metro/postal: system-specific code ('501', '10001').
|
|
25311
|
+
*/
|
|
25312
|
+
geo_code: string;
|
|
25313
|
+
/**
|
|
25314
|
+
* Human-readable geographic name (e.g., 'United States', 'California', 'New York DMA')
|
|
25315
|
+
*/
|
|
25316
|
+
geo_name?: string;
|
|
25317
|
+
};
|
|
25281
25318
|
/**
|
|
25282
25319
|
* A hotel or lodging property within a hotel-type catalog. Carries the property data that platforms use for hotel ads, dynamic remarketing, and travel campaign creatives. Maps to Google Hotel Center feeds, Meta hotel catalogs, and similar platform-native formats.
|
|
25283
25320
|
*/
|
|
@@ -25478,6 +25515,16 @@ export interface JobItem {
|
|
|
25478
25515
|
assets?: OfferingAssetGroup[];
|
|
25479
25516
|
ext?: ExtensionObject;
|
|
25480
25517
|
}
|
|
25518
|
+
/**
|
|
25519
|
+
* Delivery metrics row for one keyword and match-type pair within a package.
|
|
25520
|
+
*/
|
|
25521
|
+
export type KeywordDeliveryMetrics = DeliveryMetrics & {
|
|
25522
|
+
/**
|
|
25523
|
+
* The targeted keyword
|
|
25524
|
+
*/
|
|
25525
|
+
keyword: string;
|
|
25526
|
+
match_type: MatchType;
|
|
25527
|
+
};
|
|
25481
25528
|
/**
|
|
25482
25529
|
* A promotable offering from a brand. Can represent a campaign, product promotion, service, or any other thing the brand wants to make available. Offerings carry structured asset groups for creative assembly and can be promoted via traditional creatives or conversational SI experiences (via the brand's SI agent).
|
|
25483
25530
|
*/
|
|
@@ -14387,37 +14387,37 @@ export type TasksGetResponse = ProtocolEnvelope & {
|
|
|
14387
14387
|
* Valid country-local postal system pairing. Registered countries only accept their registered local systems; countries without a registered local system use postal_code or custom.
|
|
14388
14388
|
*/
|
|
14389
14389
|
export type PostalCountrySystem = {
|
|
14390
|
-
country
|
|
14391
|
-
system
|
|
14390
|
+
country: 'US';
|
|
14391
|
+
system: 'zip' | 'zip_plus_four';
|
|
14392
14392
|
} | {
|
|
14393
|
-
country
|
|
14394
|
-
system
|
|
14393
|
+
country: 'GB';
|
|
14394
|
+
system: 'outward' | 'full';
|
|
14395
14395
|
} | {
|
|
14396
|
-
country
|
|
14397
|
-
system
|
|
14396
|
+
country: 'CA';
|
|
14397
|
+
system: 'fsa' | 'full';
|
|
14398
14398
|
} | {
|
|
14399
|
-
country
|
|
14400
|
-
system
|
|
14399
|
+
country: 'DE' | 'CH' | 'AT';
|
|
14400
|
+
system: 'plz';
|
|
14401
14401
|
} | {
|
|
14402
|
-
country
|
|
14403
|
-
system
|
|
14402
|
+
country: 'FR';
|
|
14403
|
+
system: 'code_postal';
|
|
14404
14404
|
} | {
|
|
14405
|
-
country
|
|
14406
|
-
system
|
|
14405
|
+
country: 'AU';
|
|
14406
|
+
system: 'postcode';
|
|
14407
14407
|
} | {
|
|
14408
|
-
country
|
|
14409
|
-
system
|
|
14408
|
+
country: 'BR';
|
|
14409
|
+
system: 'cep';
|
|
14410
14410
|
} | {
|
|
14411
|
-
country
|
|
14412
|
-
system
|
|
14411
|
+
country: 'IN';
|
|
14412
|
+
system: 'pin';
|
|
14413
14413
|
} | {
|
|
14414
|
-
country
|
|
14415
|
-
system
|
|
14414
|
+
country: 'ZA';
|
|
14415
|
+
system: 'postal_code';
|
|
14416
14416
|
} | {
|
|
14417
|
-
country
|
|
14417
|
+
country: {
|
|
14418
14418
|
[k: string]: unknown | undefined;
|
|
14419
14419
|
};
|
|
14420
|
-
system
|
|
14420
|
+
system: 'postal_code' | 'custom';
|
|
14421
14421
|
};
|
|
14422
14422
|
/**
|
|
14423
14423
|
* Re-export of `PostalArea` under the legacy codegen artifact name.
|
|
@@ -18148,7 +18148,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18148
18148
|
/**
|
|
18149
18149
|
* Delivery by catalog item within this package. Available for catalog-driven packages when the seller supports item-level reporting.
|
|
18150
18150
|
*/
|
|
18151
|
-
by_catalog_item?:
|
|
18151
|
+
by_catalog_item?: GetMediaBuyDeliveryCatalogItemMetrics[];
|
|
18152
18152
|
/**
|
|
18153
18153
|
* Metrics broken down by creative within this package. Available when the seller supports creative-level reporting.
|
|
18154
18154
|
*/
|
|
@@ -18156,11 +18156,11 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18156
18156
|
/**
|
|
18157
18157
|
* Metrics broken down by keyword within this package. One row per (keyword, match_type) pair — the same keyword with different match types appears as separate rows. Keyword-grain only: rows reflect aggregate performance of each targeted keyword, not individual search queries. Rows may not sum to package totals when a single impression is attributed to the triggering keyword only. Available for search and retail media packages when the seller supports keyword-level reporting.
|
|
18158
18158
|
*/
|
|
18159
|
-
by_keyword?:
|
|
18159
|
+
by_keyword?: GetMediaBuyDeliveryKeywordMetrics[];
|
|
18160
18160
|
/**
|
|
18161
18161
|
* Delivery by geographic area within this package. Available when the buyer requests geo breakdown via reporting_dimensions and the seller supports it. Each dimension's rows are independent slices that should sum to the package total.
|
|
18162
18162
|
*/
|
|
18163
|
-
by_geo?:
|
|
18163
|
+
by_geo?: GetMediaBuyDeliveryGeoMetrics[];
|
|
18164
18164
|
/**
|
|
18165
18165
|
* Whether by_geo was truncated due to the requested limit or a seller-imposed maximum. Sellers MUST return this flag whenever by_geo is present (false means the list is complete).
|
|
18166
18166
|
*/
|
|
@@ -18168,9 +18168,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18168
18168
|
/**
|
|
18169
18169
|
* Delivery by device form factor within this package. Available when the buyer requests device_type breakdown via reporting_dimensions and the seller supports it.
|
|
18170
18170
|
*/
|
|
18171
|
-
by_device_type?:
|
|
18172
|
-
device_type?: DeviceType;
|
|
18173
|
-
})[];
|
|
18171
|
+
by_device_type?: GetMediaBuyDeliveryDeviceTypeMetrics[];
|
|
18174
18172
|
/**
|
|
18175
18173
|
* Whether by_device_type was truncated. Sellers MUST return this flag whenever by_device_type is present (false means the list is complete).
|
|
18176
18174
|
*/
|
|
@@ -18178,9 +18176,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18178
18176
|
/**
|
|
18179
18177
|
* Delivery by operating system within this package. Available when the buyer requests device_platform breakdown via reporting_dimensions and the seller supports it. Useful for CTV campaigns where tvOS vs Roku OS vs Fire OS matters.
|
|
18180
18178
|
*/
|
|
18181
|
-
by_device_platform?:
|
|
18182
|
-
device_platform?: DevicePlatform;
|
|
18183
|
-
})[];
|
|
18179
|
+
by_device_platform?: GetMediaBuyDeliveryDevicePlatformMetrics[];
|
|
18184
18180
|
/**
|
|
18185
18181
|
* Whether by_device_platform was truncated. Sellers MUST return this flag whenever by_device_platform is present (false means the list is complete).
|
|
18186
18182
|
*/
|
|
@@ -18188,17 +18184,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18188
18184
|
/**
|
|
18189
18185
|
* Delivery by audience segment within this package. Available when the buyer requests audience breakdown via reporting_dimensions and the seller supports it. Only 'synced' audiences are directly targetable via the targeting overlay; other sources are informational.
|
|
18190
18186
|
*/
|
|
18191
|
-
by_audience?:
|
|
18192
|
-
/**
|
|
18193
|
-
* Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
|
|
18194
|
-
*/
|
|
18195
|
-
audience_id?: string;
|
|
18196
|
-
audience_source?: AudienceSource;
|
|
18197
|
-
/**
|
|
18198
|
-
* Human-readable audience segment name
|
|
18199
|
-
*/
|
|
18200
|
-
audience_name?: string;
|
|
18201
|
-
})[];
|
|
18187
|
+
by_audience?: GetMediaBuyDeliveryAudienceMetrics[];
|
|
18202
18188
|
/**
|
|
18203
18189
|
* Whether by_audience was truncated. Sellers MUST return this flag whenever by_audience is present (false means the list is complete).
|
|
18204
18190
|
*/
|
|
@@ -18206,21 +18192,7 @@ export type GetMediaBuyDeliveryResponse = ProtocolEnvelope & {
|
|
|
18206
18192
|
/**
|
|
18207
18193
|
* Delivery by placement within this package. Available when the buyer requests placement breakdown via reporting_dimensions and the seller supports it. Placement IDs reference the product's placements array.
|
|
18208
18194
|
*/
|
|
18209
|
-
by_placement?:
|
|
18210
|
-
/**
|
|
18211
|
-
* Placement identifier from the product's placements array
|
|
18212
|
-
*/
|
|
18213
|
-
placement_id?: string;
|
|
18214
|
-
/**
|
|
18215
|
-
* Human-readable placement name
|
|
18216
|
-
*/
|
|
18217
|
-
placement_name?: string;
|
|
18218
|
-
/**
|
|
18219
|
-
* Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
|
|
18220
|
-
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
18221
|
-
*/
|
|
18222
|
-
publisher_domain?: string;
|
|
18223
|
-
})[];
|
|
18195
|
+
by_placement?: GetMediaBuyDeliveryPlacementMetrics[];
|
|
18224
18196
|
/**
|
|
18225
18197
|
* Whether by_placement was truncated. Sellers MUST return this flag whenever by_placement is present (false means the list is complete).
|
|
18226
18198
|
*/
|
|
@@ -18465,7 +18437,7 @@ export type MissingMetric = {
|
|
|
18465
18437
|
/**
|
|
18466
18438
|
* Delivery metrics row for one catalog item within a package.
|
|
18467
18439
|
*/
|
|
18468
|
-
export type
|
|
18440
|
+
export type GetMediaBuyDeliveryCatalogItemMetrics = DeliveryMetrics & {
|
|
18469
18441
|
/**
|
|
18470
18442
|
* Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
|
|
18471
18443
|
*/
|
|
@@ -18490,7 +18462,7 @@ export type CreativeDeliveryMetrics = DeliveryMetrics & {
|
|
|
18490
18462
|
/**
|
|
18491
18463
|
* Delivery metrics row for one keyword and match-type pair within a package.
|
|
18492
18464
|
*/
|
|
18493
|
-
export type
|
|
18465
|
+
export type GetMediaBuyDeliveryKeywordMetrics = DeliveryMetrics & {
|
|
18494
18466
|
/**
|
|
18495
18467
|
* The targeted keyword
|
|
18496
18468
|
*/
|
|
@@ -18500,7 +18472,7 @@ export type KeywordDeliveryMetrics = DeliveryMetrics & {
|
|
|
18500
18472
|
/**
|
|
18501
18473
|
* Delivery metrics row for one geographic area within a package.
|
|
18502
18474
|
*/
|
|
18503
|
-
export type
|
|
18475
|
+
export type GetMediaBuyDeliveryGeoMetrics = DeliveryMetrics & {
|
|
18504
18476
|
geo_level?: GeographicTargetingLevel;
|
|
18505
18477
|
/**
|
|
18506
18478
|
* Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
|
|
@@ -18520,6 +18492,38 @@ export type GeoDeliveryMetrics = DeliveryMetrics & {
|
|
|
18520
18492
|
*/
|
|
18521
18493
|
geo_name?: string;
|
|
18522
18494
|
};
|
|
18495
|
+
export type GetMediaBuyDeliveryDeviceTypeMetrics = DeliveryMetrics & {
|
|
18496
|
+
device_type?: DeviceType;
|
|
18497
|
+
};
|
|
18498
|
+
export type GetMediaBuyDeliveryDevicePlatformMetrics = DeliveryMetrics & {
|
|
18499
|
+
device_platform?: DevicePlatform;
|
|
18500
|
+
};
|
|
18501
|
+
export type GetMediaBuyDeliveryAudienceMetrics = DeliveryMetrics & {
|
|
18502
|
+
/**
|
|
18503
|
+
* Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
|
|
18504
|
+
*/
|
|
18505
|
+
audience_id?: string;
|
|
18506
|
+
audience_source?: AudienceSource;
|
|
18507
|
+
/**
|
|
18508
|
+
* Human-readable audience segment name
|
|
18509
|
+
*/
|
|
18510
|
+
audience_name?: string;
|
|
18511
|
+
};
|
|
18512
|
+
export type GetMediaBuyDeliveryPlacementMetrics = DeliveryMetrics & {
|
|
18513
|
+
/**
|
|
18514
|
+
* Placement identifier from the product's placements array
|
|
18515
|
+
*/
|
|
18516
|
+
placement_id?: string;
|
|
18517
|
+
/**
|
|
18518
|
+
* Human-readable placement name
|
|
18519
|
+
*/
|
|
18520
|
+
placement_name?: string;
|
|
18521
|
+
/**
|
|
18522
|
+
* Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
|
|
18523
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
18524
|
+
*/
|
|
18525
|
+
publisher_domain?: string;
|
|
18526
|
+
};
|
|
18523
18527
|
/**
|
|
18524
18528
|
* Request parameters for retrieving media buy status, creative approval state, and optional delivery snapshots
|
|
18525
18529
|
*/
|
|
@@ -24182,6 +24186,16 @@ export interface CanonicalProjectionSlotOverride {
|
|
|
24182
24186
|
*/
|
|
24183
24187
|
consumed_for_production?: boolean;
|
|
24184
24188
|
}
|
|
24189
|
+
/**
|
|
24190
|
+
* Delivery metrics row for one catalog item within a package.
|
|
24191
|
+
*/
|
|
24192
|
+
export type CatalogItemDeliveryMetrics = DeliveryMetrics & {
|
|
24193
|
+
/**
|
|
24194
|
+
* Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
|
|
24195
|
+
*/
|
|
24196
|
+
content_id: string;
|
|
24197
|
+
content_id_type?: ContentIDType;
|
|
24198
|
+
};
|
|
24185
24199
|
/**
|
|
24186
24200
|
* A catchment area definition for a store or location. Defines the geographic area from which a store draws customers. Three methods are supported: isochrone inputs (travel time + transport mode, platform resolves the shape), simple radius (distance from location), or pre-computed GeoJSON geometry (buyer provides the exact boundary). Provide exactly one method per catchment.
|
|
24187
24201
|
*/
|
|
@@ -25278,6 +25292,29 @@ export interface BaseGroupAsset {
|
|
|
25278
25292
|
*/
|
|
25279
25293
|
overlays?: Overlay[];
|
|
25280
25294
|
}
|
|
25295
|
+
/**
|
|
25296
|
+
* Delivery metrics row for one geographic area within a package.
|
|
25297
|
+
*/
|
|
25298
|
+
export type GeoDeliveryMetrics = DeliveryMetrics & {
|
|
25299
|
+
geo_level: GeographicTargetingLevel;
|
|
25300
|
+
/**
|
|
25301
|
+
* Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
|
|
25302
|
+
*/
|
|
25303
|
+
system?: string;
|
|
25304
|
+
/**
|
|
25305
|
+
* ISO 3166-1 alpha-2 country code for native postal_area rows.
|
|
25306
|
+
* @pattern ^[A-Z]{2}$
|
|
25307
|
+
*/
|
|
25308
|
+
country?: string;
|
|
25309
|
+
/**
|
|
25310
|
+
* Geographic code within the level and system. Country: ISO 3166-1 alpha-2 ('US'). Region: ISO 3166-2 with country prefix ('US-CA'). Metro/postal: system-specific code ('501', '10001').
|
|
25311
|
+
*/
|
|
25312
|
+
geo_code: string;
|
|
25313
|
+
/**
|
|
25314
|
+
* Human-readable geographic name (e.g., 'United States', 'California', 'New York DMA')
|
|
25315
|
+
*/
|
|
25316
|
+
geo_name?: string;
|
|
25317
|
+
};
|
|
25281
25318
|
/**
|
|
25282
25319
|
* A hotel or lodging property within a hotel-type catalog. Carries the property data that platforms use for hotel ads, dynamic remarketing, and travel campaign creatives. Maps to Google Hotel Center feeds, Meta hotel catalogs, and similar platform-native formats.
|
|
25283
25320
|
*/
|
|
@@ -25478,6 +25515,16 @@ export interface JobItem {
|
|
|
25478
25515
|
assets?: OfferingAssetGroup[];
|
|
25479
25516
|
ext?: ExtensionObject;
|
|
25480
25517
|
}
|
|
25518
|
+
/**
|
|
25519
|
+
* Delivery metrics row for one keyword and match-type pair within a package.
|
|
25520
|
+
*/
|
|
25521
|
+
export type KeywordDeliveryMetrics = DeliveryMetrics & {
|
|
25522
|
+
/**
|
|
25523
|
+
* The targeted keyword
|
|
25524
|
+
*/
|
|
25525
|
+
keyword: string;
|
|
25526
|
+
match_type: MatchType;
|
|
25527
|
+
};
|
|
25481
25528
|
/**
|
|
25482
25529
|
* A promotable offering from a brand. Can represent a campaign, product promotion, service, or any other thing the brand wants to make available. Offerings carry structured asset groups for creative assembly and can be promoted via traditional creatives or conversational SI experiences (via the brand's SI agent).
|
|
25483
25530
|
*/
|