@trillboards/api-client 3.2.20 → 3.2.22

package/dist/generated.d.mts

@@ -746,6 +746,8 @@ type DataApi_AdSightingRecord = {
     cab_lat: number | null;
     cab_lon: number | null;
     capture_mode: string | null;
+    /** The resolved brand's IAB tier-1 category (brand_knowledge_graph.iab_category: its vote over the brand's reads), the code the history's category slice keys by (IAB8 is Food & Drink). Null where the brand has no vote or the record names no resolved brand. */
+    category: string | null;
     confidence: number | null;
     face_lat: number | null;
     face_lon: number | null;
@@ -809,13 +811,13 @@ type DataApi_AdSightingRecord = {
 type DataApi_AdSightingsHistoryResponse = {
     data: {
         next_cursor: string | null;
-        /** One row per month, market and brand (creative_brand_history): flights active and started, creatives launched and confirmed, board faces and points, share of voice over every ad flight in the market (by flights, by faces and by face-days, with its standard error), the market vacancy, face-days, the floor-priced media value and the attention on the brand's registered flights, each with the count it is taken over. */
+        /** One row per month (or week, or the window), market and brand (creative_brand_history), and per slice when the request names dimensions: flights active and started, creatives launched and confirmed, board faces and points, share of voice over every ad flight in the market or slice (by flights, by faces and by face-days, with its standard error), the market vacancy, face-days, the floor-priced media value and the attention on the brand's registered flights, each with the count it is taken over. A row carries the keys of the slices asked for. */
         rows: Array<DataApi_CreativeBrandHistoryRow>;
     };
     meta: {
-        /** The markets and brand ids applied. */
+        /** The markets, brand ids, dimensions and slice filters applied (null: not narrowed). */
         filters: Record<string, unknown> | null;
-        /** market_month or fleet_month. */
+        /** market_month, fleet_month, market_week, fleet_week, market_window or fleet_window. */
         grain: string | null;
         metric: "creative_brand_history";
         product: "ad_sightings";
@@ -851,6 +853,8 @@ type DataApi_CreativeBrandHistoryRow = {
         measure: string;
         reason: string;
     }>;
+    /** One of the brand's agencies of record as Winmo carries them, on an agency slice: a brand with several is on a row per agency. Null where none links (absent: no_agency_linked). */
+    agency?: string | null;
     /** The brand's flights on registered faces that started in the period with a completion: the flights whose passes the attention columns sum, each once. Unit: flights. */
     attention_flights: number;
     /** The board passes past those flights (inside each read span, +/- 600 s). Unit: passes. Null when attention_flights is 0. */
@@ -869,14 +873,24 @@ type DataApi_CreativeBrandHistoryRow = {
     brand_id: string | null;
     /** Brand name. */
     brand_label: string | null;
+    /** The brand's IAB tier-1 category on a category slice (its vote, stamped on the ledger). Null without one (absent: no_category). */
+    category?: string | null;
+    /** The Census CBSA (Metropolitan or Micropolitan Statistical Area, OMB's July 2023 delineation) of the faces the row counts, on a cbsa slice. Null outside every CBSA and outside the US (absent: no_cbsa). */
+    cbsa_code?: string | null;
+    /** The CBSA's title (Las Vegas-Henderson-North Las Vegas, NV). */
+    cbsa_name?: string | null;
     /** The brand's creatives whose first flight in the market (the fleet, on a fleet grain) began in the period. Unit: creatives. */
     creatives_launched: number;
     /** Of creatives_launched, those whose first flight's earlier looks would have caught it: the completion's miss_before <= 0.05. Unit: creatives. */
     creatives_launched_confirmed: number;
+    /** The face on a board slice: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point). */
+    face_key?: string | null;
     /** The brand's flights overlapping the period: one creative's run on one registered face or unregistered board point. Unit: flights. */
     flights_active: number;
     /** Of those, the flights that began in the period. Unit: flights. */
     flights_started: number;
+    /** static or digital on a format slice. Null where no read typed the face (absent: face_type_unknown). */
+    format?: string | null;
     /** Eye-gaze legible seconds (gaze_fl) over those passes. Unit: seconds. Null when attention_flights is 0. */
     gaze_legible_s: number | null;
     /** Eye-gaze looked seconds (gaze_fl) over those passes. Unit: seconds. Null when attention_flights is 0. */
@@ -887,7 +901,7 @@ type DataApi_CreativeBrandHistoryRow = {
     head_looked_s: number | null;
     /** Every ad flight's face-days in the market and period: the face-day share's denominator. Unit: face_days. Null when market_ad_flights is 0. */
     market_ad_face_days: number | null;
-    /** Every ad flight active in the market and period: registered faces and unregistered points, named or not. The share of voice denominator. Unit: flights. */
+    /** Every ad flight active in the market and period: registered faces and unregistered points, named or not. The share of voice denominator. Under slices, every ad flight of the row's slice: its period and geography cut by every slice the request names, and narrowed by every slice filter; every market_* count is the slice's. Unit: flights. */
     market_ad_flights: number;
     /** US DMA or CA CMA code. Null on a fleet row. */
     market_code: string | null;
@@ -903,7 +917,7 @@ type DataApi_CreativeBrandHistoryRow = {
     market_name: string | null;
     /** Of the market's ad flights, those of a named brand: the named share's denominator, steady as label coverage grows. Unit: flights. */
     market_named_flights: number;
-    /** Every still-reader sighting in the market and period: the vacancy denominator (creative_vacancy_rate's own count, rolled to the period). NULL where board_creative_sighting (400-day TTL) holds none of the period. Unit: sightings. Null when market_sightings is 0. */
+    /** Every still-reader sighting in the market and period: the vacancy denominator (creative_vacancy_rate's own count, rolled to the period). NULL where board_creative_sighting (400-day TTL) holds none of the period. Under slices, the vacancy is cut by where-it-ran slices only (a vacant face has no brand): each sighting placed by its read's face. Unit: sightings. Null when market_sightings is 0. */
     market_sightings: number | null;
     /** market_vacant_face_days / market_face_days: the market's vacancy in face-days, beside the sighting vacancy, never in place of it. Unit: share. market_vacant_face_days / market_face_days; null when market_face_days is 0. */
     market_vacancy_face_day_share: number | null;
@@ -923,12 +937,18 @@ type DataApi_CreativeBrandHistoryRow = {
     market_vacant_flights: number;
     /** The market's drawn sightings weighted by 1 / inclusion_probability. Unit: sightings. Null when market_drawn_sightings is 0. */
     market_weighted_sightings: number | null;
+    /** The faces' registry owner on a media_owner slice: a programmatic face's publisher, a permit layer's owner of record. Null on an unregistered board point (absent: no_registered_owner). */
+    media_owner?: string | null;
     /** Floor-priced media value: floor CPM / 1000 x modelled daily impressions per face-day, each face-day split among the flights estimated on the face that day, never fewer than its interleave set nor, on a digital face, the creatives read on it in the period, over the brand's flights on faces with a floor and impressions as of the flight's first day. An asking price, never a cleared one. Unit: usd. Null when media_value_priced_faces is 0. */
     media_value_floor_usd: number | null;
     /** The faces the floor-priced value is priced on. Unit: board_faces. */
     media_value_priced_faces: number;
     /** The month (its first day, YYYY-MM-DD). */
     month: string | null;
+    /** The brand's parent company on a parent slice: the brand graph id of the parent's Wikidata family. Null where the graph names none (absent: no_parent_named). */
+    parent_id?: string | null;
+    /** The parent company's name. */
+    parent_label?: string | null;
     /** flights_active / market_named_flights: the brand's share of the named brands' flights in the market and period (creative_share_of_voice's named denominator, over flights on faces and points). NULL on the unnamed row. Unit: share. named_flights_active / market_named_flights; null when market_named_flights is 0. */
     share_of_named_voice: number | null;
     /** flights_active / market_ad_flights: the brand's share of every ad flight in the market and period, on registered faces AND unregistered points (creative_share_of_voice counts sightings on registered faces only). Unit: share. flights_active / market_ad_flights; null when market_ad_flights is 0. */
@@ -939,6 +959,10 @@ type DataApi_CreativeBrandHistoryRow = {
     share_of_voice_face_days_se: number | null;
     /** brand_face_share / market_face_share: the share of voice with a digital loop's flights weighted by their share of its reads. Never mixed into share_of_voice. Unit: share. brand_face_share / market_face_share; null when market_face_share is 0. */
     share_of_voice_face_weighted: number | null;
+    /** The reader surface the face's held reads named most, on a surface slice: billboard, digital_board, bus_shelter or kiosk. Null where none named one (absent: no_reader_surface). */
+    surface?: string | null;
+    /** The ISO week on a week grain: its Monday, YYYY-MM-DD. */
+    week?: string | null;
 };
 type DataApi_DataProducts_AudienceRow = {
     /** Interval upper bound. */
@@ -1801,8 +1825,12 @@ type DataApi_DataProducts_Geometry = {
 type DataApi_DataProducts_MeasurementError = {
     /** Machine-readable reason, e.g. invalid_bbox, board_not_found, not_entitled, quota, measurement_unavailable. */
     code: string;
+    /** Owner upload refusals (sheet_refused, sheet_empty, log_refused, ssp_venue_conflict, write_failed): the plan or load report the refusal is about, with rows read, refused lines and their reasons, unmatched and ambiguous faces, and for ssp_venue_conflict the `conflicts`. */
+    data?: Record<string, unknown>;
     /** What was refused and how to ask again. */
     message: string;
+    /** The scopes the key must hold (INSUFFICIENT_SCOPE on the owner upload routes, which need `measurement:write`). */
+    required_scopes?: Array<string>;
     status: false;
 };
 type DataApi_DataProducts_Method = {
@@ -6218,6 +6246,8 @@ interface listAdSightingsInPortalOperation {
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. Combined with `brand` as either-or. */
         brand_id?: Array<string> | null;
+        /** The brand's IAB tier-1 category (IAB1..IAB25), repeatable: the records whose resolved brand votes in it (brand_knowledge_graph.iab_category, the `category` field). */
+        category?: Array<string> | null;
         /** A sighted creative (the campaign artwork), repeatable. */
         creative_id?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
@@ -6230,6 +6260,8 @@ interface listAdSightingsInPortalOperation {
         limit?: number;
         /** A market as COUNTRY:CODE (US DMA or CA CMA), repeatable. */
         market?: Array<string> | null;
+        /** A media owner, repeatable: the records matched to a face whose owner (`publisher_name`, the registry's) holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)). */
+        media_owner?: Array<string> | null;
         /** The surface kind as read (billboard, storefront, bus_shelter, ...), repeatable. */
         surface?: Array<string> | null;
         /** End (exclusive). Default: now. The span is at most 400 days. */
@@ -6247,20 +6279,38 @@ interface listAdSightingHistoryInPortalOperation {
     request: never;
     params: Record<string, unknown>;
     query: {
+        /** Narrow to brands this agency holds as agency of record (Winmo), by name in any case, repeatable. */
+        agency?: Array<string> | null;
+        /** Narrow to faces by face key, repeatable for a set of boards: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point), the `face_key` a board slice answers with. */
+        board?: Array<string> | null;
         /** A brand by name, repeatable (competitors). Resolved to its brand id the way the brand search does. */
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. */
         brand_id?: Array<string> | null;
+        /** Narrow to brands of an IAB tier-1 category (IAB1..IAB25), repeatable. A slice filter narrows the denominators with the rows: the shares are within the categories named. */
+        category?: Array<string> | null;
+        /** Narrow to faces in a Census CBSA (5-digit code, OMB July 2023 delineation), repeatable. */
+        cbsa?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
         cursor?: string;
+        /** A slice the rows are cut by, repeatable: category, parent, agency (what the brand is), media_owner, format, surface, board, cbsa (where it ran). Each row is a brand within its slice, and every share is over its slice: a slice recomputes every denominator, and every distinct count is counted within it. The market vacancy is cut by where-it-ran slices only. */
+        dimension?: Array<string> | null;
+        /** Narrow to static or digital faces, repeatable. */
+        format?: Array<string> | null;
         /** First month (YYYY-MM) or day. Default: 12 months before `to`. */
         from?: string;
-        /** market_month (default) or fleet_month. */
-        grain?: "market_month" | "fleet_month";
+        /** market_month (default) or fleet_month; market_week or fleet_week (ISO weeks from their Monday, each counted whole, every week the from..to span touches); market_window or fleet_window (the from..to span as one period). A fleet grain drops the market: with dimension=cbsa it is the CBSA geography. */
+        grain?: "market_month" | "fleet_month" | "market_week" | "fleet_week" | "market_window" | "fleet_window";
         /** Rows per page, 1..500 (default 100). The page limit is reserved; the rows returned are billed. */
         limit?: number;
         /** A market as COUNTRY:CODE, repeatable. */
         market?: Array<string> | null;
+        /** Narrow to faces whose registry owner holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)), repeatable. */
+        media_owner?: Array<string> | null;
+        /** Narrow to brands whose parent company is in this brand graph id's family (the `parent_id` a parent slice answers with), repeatable. */
+        parent?: Array<string> | null;
+        /** Narrow to faces of a reader surface (billboard, digital_board, bus_shelter, kiosk), repeatable. */
+        surface?: Array<string> | null;
         /** Last month (YYYY-MM, inclusive) or day. Default: this month. */
         to?: string;
     };
@@ -6601,30 +6651,46 @@ interface getApprovedMetricOperation {
         metric: "camera_people_per_screen_hour" | "camera_dwell_capped_ms" | "camera_head_pose_index" | "camera_gaze_pct" | "demographic_share" | "sensing_census" | "board_measured_impressions_per_spot" | "board_pass_audience" | "same_panel_index" | "radio_identifiers_per_person" | "creative_sightings" | "creative_share_of_voice" | "creative_street_presence" | "creative_vacancy_rate" | "creative_brand_history" | "seatbelt_compliance" | "seatbelt_unbuckled_ride_rate";
     };
     query: {
+        /** Agency names, |-separated (or repeated): the brands one of them holds as agency of record (Winmo), any case. Taken by: creative_brand_history. */
+        agencies?: string;
         /** Board face id (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
         board_id?: string;
+        /** Face keys, |-separated (or repeated): f:<board id>:<face index> or p:<point id>. Taken by: creative_brand_history. */
+        boards?: string;
         /** Comma-separated resolved brand ids. Taken by: creative_brand_history. */
         brands?: string;
         /** Condition scope (board metrics): daypart, light, weather or speed. Taken by: board_measured_impressions_per_spot. */
         by?: string;
+        /** Comma-separated IAB tier-1 codes (IAB1..IAB25): the brands of those categories. A slice filter narrows the denominators with the rows. Taken by: creative_brand_history. */
+        categories?: string;
+        /** Comma-separated 5-digit Census CBSA codes (OMB July 2023 delineation). Taken by: creative_brand_history. */
+        cbsas?: string;
         /** One day (YYYY-MM-DD). Give day or window; neither is the last settled day. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, sensing_census, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         day?: string;
         /** Daypart filter (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
         daypart?: string;
-        /** Comma-separated audience dimensions (dimension= is the one-value spelling). Taken by: demographic_share. */
+        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. Taken by: demographic_share, creative_brand_history. */
         dimensions?: string;
+        /** Comma-separated face formats: static, digital. Taken by: creative_brand_history. */
+        formats?: string;
         /** Camera evidence grade: face_backed or person_backed. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct. */
         grade?: string;
         /** The answer grain (screen_hour, screen_day, fleet_day, market_day, market_month, ...): one of the metric's grains. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, sensing_census, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         grain?: string;
         /** Comma-separated markets as COUNTRY:CODE (US DMA, CA CMA). Taken by: creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         markets?: string;
+        /** Media owner names, |-separated (or repeated): the faces whose registry owner holds a name's letters and digits, any case and punctuation. Taken by: creative_brand_history. */
+        media_owners?: string;
+        /** Comma-separated brand graph ids: the brands whose parent company is in one of those Wikidata families. Taken by: creative_brand_history. */
+        parents?: string;
         /** The population the shares are over. Taken by: sensing_census, same_panel_index. */
         population?: string;
         /** Comma-separated 24-hex screen ids, up to the metric's max_screens. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         screens?: string;
         /** Comma-separated statistics (mean, p50, ...), from the metric's allowed stats. Taken by: camera_people_per_screen_hour, camera_head_pose_index. */
         stats?: string;
+        /** Comma-separated reader surfaces: billboard, digital_board, bus_shelter, kiosk. Taken by: creative_brand_history. */
+        surfaces?: string;
         /** An inclusive span, YYYY-MM-DD..YYYY-MM-DD, up to the metric's max_window_days. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         window?: string;
         /** Currency window end (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
@@ -6726,6 +6792,8 @@ interface dataApiAdSightingsOperation {
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. Combined with `brand` as either-or. */
         brand_id?: Array<string> | null;
+        /** The brand's IAB tier-1 category (IAB1..IAB25), repeatable: the records whose resolved brand votes in it (brand_knowledge_graph.iab_category, the `category` field). */
+        category?: Array<string> | null;
         /** A sighted creative (the campaign artwork), repeatable. */
         creative_id?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
@@ -6738,6 +6806,8 @@ interface dataApiAdSightingsOperation {
         limit?: number;
         /** A market as COUNTRY:CODE (US DMA or CA CMA), repeatable. */
         market?: Array<string> | null;
+        /** A media owner, repeatable: the records matched to a face whose owner (`publisher_name`, the registry's) holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)). */
+        media_owner?: Array<string> | null;
         /** The surface kind as read (billboard, storefront, bus_shelter, ...), repeatable. */
         surface?: Array<string> | null;
         /** End (exclusive). Default: now. The span is at most 400 days. */
@@ -6755,20 +6825,38 @@ interface dataApiAdSightingsHistoryOperation {
     request: never;
     params: Record<string, unknown>;
     query: {
+        /** Narrow to brands this agency holds as agency of record (Winmo), by name in any case, repeatable. */
+        agency?: Array<string> | null;
+        /** Narrow to faces by face key, repeatable for a set of boards: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point), the `face_key` a board slice answers with. */
+        board?: Array<string> | null;
         /** A brand by name, repeatable (competitors). Resolved to its brand id the way the brand search does. */
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. */
         brand_id?: Array<string> | null;
+        /** Narrow to brands of an IAB tier-1 category (IAB1..IAB25), repeatable. A slice filter narrows the denominators with the rows: the shares are within the categories named. */
+        category?: Array<string> | null;
+        /** Narrow to faces in a Census CBSA (5-digit code, OMB July 2023 delineation), repeatable. */
+        cbsa?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
         cursor?: string;
+        /** A slice the rows are cut by, repeatable: category, parent, agency (what the brand is), media_owner, format, surface, board, cbsa (where it ran). Each row is a brand within its slice, and every share is over its slice: a slice recomputes every denominator, and every distinct count is counted within it. The market vacancy is cut by where-it-ran slices only. */
+        dimension?: Array<string> | null;
+        /** Narrow to static or digital faces, repeatable. */
+        format?: Array<string> | null;
         /** First month (YYYY-MM) or day. Default: 12 months before `to`. */
         from?: string;
-        /** market_month (default) or fleet_month. */
-        grain?: "market_month" | "fleet_month";
+        /** market_month (default) or fleet_month; market_week or fleet_week (ISO weeks from their Monday, each counted whole, every week the from..to span touches); market_window or fleet_window (the from..to span as one period). A fleet grain drops the market: with dimension=cbsa it is the CBSA geography. */
+        grain?: "market_month" | "fleet_month" | "market_week" | "fleet_week" | "market_window" | "fleet_window";
         /** Rows per page, 1..500 (default 100). The page limit is reserved; the rows returned are billed. */
         limit?: number;
         /** A market as COUNTRY:CODE, repeatable. */
         market?: Array<string> | null;
+        /** Narrow to faces whose registry owner holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)), repeatable. */
+        media_owner?: Array<string> | null;
+        /** Narrow to brands whose parent company is in this brand graph id's family (the `parent_id` a parent slice answers with), repeatable. */
+        parent?: Array<string> | null;
+        /** Narrow to faces of a reader surface (billboard, digital_board, bus_shelter, kiosk), repeatable. */
+        surface?: Array<string> | null;
         /** Last month (YYYY-MM, inclusive) or day. Default: this month. */
         to?: string;
     };

package/dist/generated.d.ts

@@ -746,6 +746,8 @@ type DataApi_AdSightingRecord = {
     cab_lat: number | null;
     cab_lon: number | null;
     capture_mode: string | null;
+    /** The resolved brand's IAB tier-1 category (brand_knowledge_graph.iab_category: its vote over the brand's reads), the code the history's category slice keys by (IAB8 is Food & Drink). Null where the brand has no vote or the record names no resolved brand. */
+    category: string | null;
     confidence: number | null;
     face_lat: number | null;
     face_lon: number | null;
@@ -809,13 +811,13 @@ type DataApi_AdSightingRecord = {
 type DataApi_AdSightingsHistoryResponse = {
     data: {
         next_cursor: string | null;
-        /** One row per month, market and brand (creative_brand_history): flights active and started, creatives launched and confirmed, board faces and points, share of voice over every ad flight in the market (by flights, by faces and by face-days, with its standard error), the market vacancy, face-days, the floor-priced media value and the attention on the brand's registered flights, each with the count it is taken over. */
+        /** One row per month (or week, or the window), market and brand (creative_brand_history), and per slice when the request names dimensions: flights active and started, creatives launched and confirmed, board faces and points, share of voice over every ad flight in the market or slice (by flights, by faces and by face-days, with its standard error), the market vacancy, face-days, the floor-priced media value and the attention on the brand's registered flights, each with the count it is taken over. A row carries the keys of the slices asked for. */
         rows: Array<DataApi_CreativeBrandHistoryRow>;
     };
     meta: {
-        /** The markets and brand ids applied. */
+        /** The markets, brand ids, dimensions and slice filters applied (null: not narrowed). */
         filters: Record<string, unknown> | null;
-        /** market_month or fleet_month. */
+        /** market_month, fleet_month, market_week, fleet_week, market_window or fleet_window. */
         grain: string | null;
         metric: "creative_brand_history";
         product: "ad_sightings";
@@ -851,6 +853,8 @@ type DataApi_CreativeBrandHistoryRow = {
         measure: string;
         reason: string;
     }>;
+    /** One of the brand's agencies of record as Winmo carries them, on an agency slice: a brand with several is on a row per agency. Null where none links (absent: no_agency_linked). */
+    agency?: string | null;
     /** The brand's flights on registered faces that started in the period with a completion: the flights whose passes the attention columns sum, each once. Unit: flights. */
     attention_flights: number;
     /** The board passes past those flights (inside each read span, +/- 600 s). Unit: passes. Null when attention_flights is 0. */
@@ -869,14 +873,24 @@ type DataApi_CreativeBrandHistoryRow = {
     brand_id: string | null;
     /** Brand name. */
     brand_label: string | null;
+    /** The brand's IAB tier-1 category on a category slice (its vote, stamped on the ledger). Null without one (absent: no_category). */
+    category?: string | null;
+    /** The Census CBSA (Metropolitan or Micropolitan Statistical Area, OMB's July 2023 delineation) of the faces the row counts, on a cbsa slice. Null outside every CBSA and outside the US (absent: no_cbsa). */
+    cbsa_code?: string | null;
+    /** The CBSA's title (Las Vegas-Henderson-North Las Vegas, NV). */
+    cbsa_name?: string | null;
     /** The brand's creatives whose first flight in the market (the fleet, on a fleet grain) began in the period. Unit: creatives. */
     creatives_launched: number;
     /** Of creatives_launched, those whose first flight's earlier looks would have caught it: the completion's miss_before <= 0.05. Unit: creatives. */
     creatives_launched_confirmed: number;
+    /** The face on a board slice: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point). */
+    face_key?: string | null;
     /** The brand's flights overlapping the period: one creative's run on one registered face or unregistered board point. Unit: flights. */
     flights_active: number;
     /** Of those, the flights that began in the period. Unit: flights. */
     flights_started: number;
+    /** static or digital on a format slice. Null where no read typed the face (absent: face_type_unknown). */
+    format?: string | null;
     /** Eye-gaze legible seconds (gaze_fl) over those passes. Unit: seconds. Null when attention_flights is 0. */
     gaze_legible_s: number | null;
     /** Eye-gaze looked seconds (gaze_fl) over those passes. Unit: seconds. Null when attention_flights is 0. */
@@ -887,7 +901,7 @@ type DataApi_CreativeBrandHistoryRow = {
     head_looked_s: number | null;
     /** Every ad flight's face-days in the market and period: the face-day share's denominator. Unit: face_days. Null when market_ad_flights is 0. */
     market_ad_face_days: number | null;
-    /** Every ad flight active in the market and period: registered faces and unregistered points, named or not. The share of voice denominator. Unit: flights. */
+    /** Every ad flight active in the market and period: registered faces and unregistered points, named or not. The share of voice denominator. Under slices, every ad flight of the row's slice: its period and geography cut by every slice the request names, and narrowed by every slice filter; every market_* count is the slice's. Unit: flights. */
     market_ad_flights: number;
     /** US DMA or CA CMA code. Null on a fleet row. */
     market_code: string | null;
@@ -903,7 +917,7 @@ type DataApi_CreativeBrandHistoryRow = {
     market_name: string | null;
     /** Of the market's ad flights, those of a named brand: the named share's denominator, steady as label coverage grows. Unit: flights. */
     market_named_flights: number;
-    /** Every still-reader sighting in the market and period: the vacancy denominator (creative_vacancy_rate's own count, rolled to the period). NULL where board_creative_sighting (400-day TTL) holds none of the period. Unit: sightings. Null when market_sightings is 0. */
+    /** Every still-reader sighting in the market and period: the vacancy denominator (creative_vacancy_rate's own count, rolled to the period). NULL where board_creative_sighting (400-day TTL) holds none of the period. Under slices, the vacancy is cut by where-it-ran slices only (a vacant face has no brand): each sighting placed by its read's face. Unit: sightings. Null when market_sightings is 0. */
     market_sightings: number | null;
     /** market_vacant_face_days / market_face_days: the market's vacancy in face-days, beside the sighting vacancy, never in place of it. Unit: share. market_vacant_face_days / market_face_days; null when market_face_days is 0. */
     market_vacancy_face_day_share: number | null;
@@ -923,12 +937,18 @@ type DataApi_CreativeBrandHistoryRow = {
     market_vacant_flights: number;
     /** The market's drawn sightings weighted by 1 / inclusion_probability. Unit: sightings. Null when market_drawn_sightings is 0. */
     market_weighted_sightings: number | null;
+    /** The faces' registry owner on a media_owner slice: a programmatic face's publisher, a permit layer's owner of record. Null on an unregistered board point (absent: no_registered_owner). */
+    media_owner?: string | null;
     /** Floor-priced media value: floor CPM / 1000 x modelled daily impressions per face-day, each face-day split among the flights estimated on the face that day, never fewer than its interleave set nor, on a digital face, the creatives read on it in the period, over the brand's flights on faces with a floor and impressions as of the flight's first day. An asking price, never a cleared one. Unit: usd. Null when media_value_priced_faces is 0. */
     media_value_floor_usd: number | null;
     /** The faces the floor-priced value is priced on. Unit: board_faces. */
     media_value_priced_faces: number;
     /** The month (its first day, YYYY-MM-DD). */
     month: string | null;
+    /** The brand's parent company on a parent slice: the brand graph id of the parent's Wikidata family. Null where the graph names none (absent: no_parent_named). */
+    parent_id?: string | null;
+    /** The parent company's name. */
+    parent_label?: string | null;
     /** flights_active / market_named_flights: the brand's share of the named brands' flights in the market and period (creative_share_of_voice's named denominator, over flights on faces and points). NULL on the unnamed row. Unit: share. named_flights_active / market_named_flights; null when market_named_flights is 0. */
     share_of_named_voice: number | null;
     /** flights_active / market_ad_flights: the brand's share of every ad flight in the market and period, on registered faces AND unregistered points (creative_share_of_voice counts sightings on registered faces only). Unit: share. flights_active / market_ad_flights; null when market_ad_flights is 0. */
@@ -939,6 +959,10 @@ type DataApi_CreativeBrandHistoryRow = {
     share_of_voice_face_days_se: number | null;
     /** brand_face_share / market_face_share: the share of voice with a digital loop's flights weighted by their share of its reads. Never mixed into share_of_voice. Unit: share. brand_face_share / market_face_share; null when market_face_share is 0. */
     share_of_voice_face_weighted: number | null;
+    /** The reader surface the face's held reads named most, on a surface slice: billboard, digital_board, bus_shelter or kiosk. Null where none named one (absent: no_reader_surface). */
+    surface?: string | null;
+    /** The ISO week on a week grain: its Monday, YYYY-MM-DD. */
+    week?: string | null;
 };
 type DataApi_DataProducts_AudienceRow = {
     /** Interval upper bound. */
@@ -1801,8 +1825,12 @@ type DataApi_DataProducts_Geometry = {
 type DataApi_DataProducts_MeasurementError = {
     /** Machine-readable reason, e.g. invalid_bbox, board_not_found, not_entitled, quota, measurement_unavailable. */
     code: string;
+    /** Owner upload refusals (sheet_refused, sheet_empty, log_refused, ssp_venue_conflict, write_failed): the plan or load report the refusal is about, with rows read, refused lines and their reasons, unmatched and ambiguous faces, and for ssp_venue_conflict the `conflicts`. */
+    data?: Record<string, unknown>;
     /** What was refused and how to ask again. */
     message: string;
+    /** The scopes the key must hold (INSUFFICIENT_SCOPE on the owner upload routes, which need `measurement:write`). */
+    required_scopes?: Array<string>;
     status: false;
 };
 type DataApi_DataProducts_Method = {
@@ -6218,6 +6246,8 @@ interface listAdSightingsInPortalOperation {
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. Combined with `brand` as either-or. */
         brand_id?: Array<string> | null;
+        /** The brand's IAB tier-1 category (IAB1..IAB25), repeatable: the records whose resolved brand votes in it (brand_knowledge_graph.iab_category, the `category` field). */
+        category?: Array<string> | null;
         /** A sighted creative (the campaign artwork), repeatable. */
         creative_id?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
@@ -6230,6 +6260,8 @@ interface listAdSightingsInPortalOperation {
         limit?: number;
         /** A market as COUNTRY:CODE (US DMA or CA CMA), repeatable. */
         market?: Array<string> | null;
+        /** A media owner, repeatable: the records matched to a face whose owner (`publisher_name`, the registry's) holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)). */
+        media_owner?: Array<string> | null;
         /** The surface kind as read (billboard, storefront, bus_shelter, ...), repeatable. */
         surface?: Array<string> | null;
         /** End (exclusive). Default: now. The span is at most 400 days. */
@@ -6247,20 +6279,38 @@ interface listAdSightingHistoryInPortalOperation {
     request: never;
     params: Record<string, unknown>;
     query: {
+        /** Narrow to brands this agency holds as agency of record (Winmo), by name in any case, repeatable. */
+        agency?: Array<string> | null;
+        /** Narrow to faces by face key, repeatable for a set of boards: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point), the `face_key` a board slice answers with. */
+        board?: Array<string> | null;
         /** A brand by name, repeatable (competitors). Resolved to its brand id the way the brand search does. */
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. */
         brand_id?: Array<string> | null;
+        /** Narrow to brands of an IAB tier-1 category (IAB1..IAB25), repeatable. A slice filter narrows the denominators with the rows: the shares are within the categories named. */
+        category?: Array<string> | null;
+        /** Narrow to faces in a Census CBSA (5-digit code, OMB July 2023 delineation), repeatable. */
+        cbsa?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
         cursor?: string;
+        /** A slice the rows are cut by, repeatable: category, parent, agency (what the brand is), media_owner, format, surface, board, cbsa (where it ran). Each row is a brand within its slice, and every share is over its slice: a slice recomputes every denominator, and every distinct count is counted within it. The market vacancy is cut by where-it-ran slices only. */
+        dimension?: Array<string> | null;
+        /** Narrow to static or digital faces, repeatable. */
+        format?: Array<string> | null;
         /** First month (YYYY-MM) or day. Default: 12 months before `to`. */
         from?: string;
-        /** market_month (default) or fleet_month. */
-        grain?: "market_month" | "fleet_month";
+        /** market_month (default) or fleet_month; market_week or fleet_week (ISO weeks from their Monday, each counted whole, every week the from..to span touches); market_window or fleet_window (the from..to span as one period). A fleet grain drops the market: with dimension=cbsa it is the CBSA geography. */
+        grain?: "market_month" | "fleet_month" | "market_week" | "fleet_week" | "market_window" | "fleet_window";
         /** Rows per page, 1..500 (default 100). The page limit is reserved; the rows returned are billed. */
         limit?: number;
         /** A market as COUNTRY:CODE, repeatable. */
         market?: Array<string> | null;
+        /** Narrow to faces whose registry owner holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)), repeatable. */
+        media_owner?: Array<string> | null;
+        /** Narrow to brands whose parent company is in this brand graph id's family (the `parent_id` a parent slice answers with), repeatable. */
+        parent?: Array<string> | null;
+        /** Narrow to faces of a reader surface (billboard, digital_board, bus_shelter, kiosk), repeatable. */
+        surface?: Array<string> | null;
         /** Last month (YYYY-MM, inclusive) or day. Default: this month. */
         to?: string;
     };
@@ -6601,30 +6651,46 @@ interface getApprovedMetricOperation {
         metric: "camera_people_per_screen_hour" | "camera_dwell_capped_ms" | "camera_head_pose_index" | "camera_gaze_pct" | "demographic_share" | "sensing_census" | "board_measured_impressions_per_spot" | "board_pass_audience" | "same_panel_index" | "radio_identifiers_per_person" | "creative_sightings" | "creative_share_of_voice" | "creative_street_presence" | "creative_vacancy_rate" | "creative_brand_history" | "seatbelt_compliance" | "seatbelt_unbuckled_ride_rate";
     };
     query: {
+        /** Agency names, |-separated (or repeated): the brands one of them holds as agency of record (Winmo), any case. Taken by: creative_brand_history. */
+        agencies?: string;
         /** Board face id (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
         board_id?: string;
+        /** Face keys, |-separated (or repeated): f:<board id>:<face index> or p:<point id>. Taken by: creative_brand_history. */
+        boards?: string;
         /** Comma-separated resolved brand ids. Taken by: creative_brand_history. */
         brands?: string;
         /** Condition scope (board metrics): daypart, light, weather or speed. Taken by: board_measured_impressions_per_spot. */
         by?: string;
+        /** Comma-separated IAB tier-1 codes (IAB1..IAB25): the brands of those categories. A slice filter narrows the denominators with the rows. Taken by: creative_brand_history. */
+        categories?: string;
+        /** Comma-separated 5-digit Census CBSA codes (OMB July 2023 delineation). Taken by: creative_brand_history. */
+        cbsas?: string;
         /** One day (YYYY-MM-DD). Give day or window; neither is the last settled day. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, sensing_census, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         day?: string;
         /** Daypart filter (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
         daypart?: string;
-        /** Comma-separated audience dimensions (dimension= is the one-value spelling). Taken by: demographic_share. */
+        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. Taken by: demographic_share, creative_brand_history. */
         dimensions?: string;
+        /** Comma-separated face formats: static, digital. Taken by: creative_brand_history. */
+        formats?: string;
         /** Camera evidence grade: face_backed or person_backed. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct. */
         grade?: string;
         /** The answer grain (screen_hour, screen_day, fleet_day, market_day, market_month, ...): one of the metric's grains. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, sensing_census, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         grain?: string;
         /** Comma-separated markets as COUNTRY:CODE (US DMA, CA CMA). Taken by: creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         markets?: string;
+        /** Media owner names, |-separated (or repeated): the faces whose registry owner holds a name's letters and digits, any case and punctuation. Taken by: creative_brand_history. */
+        media_owners?: string;
+        /** Comma-separated brand graph ids: the brands whose parent company is in one of those Wikidata families. Taken by: creative_brand_history. */
+        parents?: string;
         /** The population the shares are over. Taken by: sensing_census, same_panel_index. */
         population?: string;
         /** Comma-separated 24-hex screen ids, up to the metric's max_screens. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         screens?: string;
         /** Comma-separated statistics (mean, p50, ...), from the metric's allowed stats. Taken by: camera_people_per_screen_hour, camera_head_pose_index. */
         stats?: string;
+        /** Comma-separated reader surfaces: billboard, digital_board, bus_shelter, kiosk. Taken by: creative_brand_history. */
+        surfaces?: string;
         /** An inclusive span, YYYY-MM-DD..YYYY-MM-DD, up to the metric's max_window_days. Taken by: camera_people_per_screen_hour, camera_dwell_capped_ms, camera_head_pose_index, camera_gaze_pct, demographic_share, same_panel_index, radio_identifiers_per_person, creative_sightings, creative_share_of_voice, creative_street_presence, creative_vacancy_rate, creative_brand_history, seatbelt_compliance, seatbelt_unbuckled_ride_rate. */
         window?: string;
         /** Currency window end (board metrics). Taken by: board_measured_impressions_per_spot, board_pass_audience. */
@@ -6726,6 +6792,8 @@ interface dataApiAdSightingsOperation {
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. Combined with `brand` as either-or. */
         brand_id?: Array<string> | null;
+        /** The brand's IAB tier-1 category (IAB1..IAB25), repeatable: the records whose resolved brand votes in it (brand_knowledge_graph.iab_category, the `category` field). */
+        category?: Array<string> | null;
         /** A sighted creative (the campaign artwork), repeatable. */
         creative_id?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
@@ -6738,6 +6806,8 @@ interface dataApiAdSightingsOperation {
         limit?: number;
         /** A market as COUNTRY:CODE (US DMA or CA CMA), repeatable. */
         market?: Array<string> | null;
+        /** A media owner, repeatable: the records matched to a face whose owner (`publisher_name`, the registry's) holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)). */
+        media_owner?: Array<string> | null;
         /** The surface kind as read (billboard, storefront, bus_shelter, ...), repeatable. */
         surface?: Array<string> | null;
         /** End (exclusive). Default: now. The span is at most 400 days. */
@@ -6755,20 +6825,38 @@ interface dataApiAdSightingsHistoryOperation {
     request: never;
     params: Record<string, unknown>;
     query: {
+        /** Narrow to brands this agency holds as agency of record (Winmo), by name in any case, repeatable. */
+        agency?: Array<string> | null;
+        /** Narrow to faces by face key, repeatable for a set of boards: f:<board id>:<face index> (a registered face) or p:<point id> (an unregistered board point), the `face_key` a board slice answers with. */
+        board?: Array<string> | null;
         /** A brand by name, repeatable (competitors). Resolved to its brand id the way the brand search does. */
         brand?: Array<string> | null;
         /** A resolved brand id, repeatable. */
         brand_id?: Array<string> | null;
+        /** Narrow to brands of an IAB tier-1 category (IAB1..IAB25), repeatable. A slice filter narrows the denominators with the rows: the shares are within the categories named. */
+        category?: Array<string> | null;
+        /** Narrow to faces in a Census CBSA (5-digit code, OMB July 2023 delineation), repeatable. */
+        cbsa?: Array<string> | null;
         /** The `next_cursor` of the previous page. */
         cursor?: string;
+        /** A slice the rows are cut by, repeatable: category, parent, agency (what the brand is), media_owner, format, surface, board, cbsa (where it ran). Each row is a brand within its slice, and every share is over its slice: a slice recomputes every denominator, and every distinct count is counted within it. The market vacancy is cut by where-it-ran slices only. */
+        dimension?: Array<string> | null;
+        /** Narrow to static or digital faces, repeatable. */
+        format?: Array<string> | null;
         /** First month (YYYY-MM) or day. Default: 12 months before `to`. */
         from?: string;
-        /** market_month (default) or fleet_month. */
-        grain?: "market_month" | "fleet_month";
+        /** market_month (default) or fleet_month; market_week or fleet_week (ISO weeks from their Monday, each counted whole, every week the from..to span touches); market_window or fleet_window (the from..to span as one period). A fleet grain drops the market: with dimension=cbsa it is the CBSA geography. */
+        grain?: "market_month" | "fleet_month" | "market_week" | "fleet_week" | "market_window" | "fleet_window";
         /** Rows per page, 1..500 (default 100). The page limit is reserved; the rows returned are billed. */
         limit?: number;
         /** A market as COUNTRY:CODE, repeatable. */
         market?: Array<string> | null;
+        /** Narrow to faces whose registry owner holds the name's letters and digits, any case and punctuation (Lamar finds LAMAR-PITTSBURGH and Lamar (Cincinnati)), repeatable. */
+        media_owner?: Array<string> | null;
+        /** Narrow to brands whose parent company is in this brand graph id's family (the `parent_id` a parent slice answers with), repeatable. */
+        parent?: Array<string> | null;
+        /** Narrow to faces of a reader surface (billboard, digital_board, bus_shelter, kiosk), repeatable. */
+        surface?: Array<string> | null;
         /** Last month (YYYY-MM, inclusive) or day. Default: this month. */
         to?: string;
     };