@trillboards/api-client 3.2.19 → 3.2.21

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.
@@ -1801,8 +1801,12 @@ type DataApi_DataProducts_Geometry = {
1801
1801
  type DataApi_DataProducts_MeasurementError = {
1802
1802
  /** Machine-readable reason, e.g. invalid_bbox, board_not_found, not_entitled, quota, measurement_unavailable. */
1803
1803
  code: string;
1804
+ /** 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`. */
1805
+ data?: Record<string, unknown>;
1804
1806
  /** What was refused and how to ask again. */
1805
1807
  message: string;
1808
+ /** The scopes the key must hold (INSUFFICIENT_SCOPE on the owner upload routes, which need `measurement:write`). */
1809
+ required_scopes?: Array<string>;
1806
1810
  status: false;
1807
1811
  };
1808
1812
  type DataApi_DataProducts_Method = {
@@ -1828,7 +1832,13 @@ type DataApi_DataProducts_MetricAnswer = {
1828
1832
  /** complete, partial or not_measured. */
1829
1833
  status: string;
1830
1834
  }>;
1831
- dimensions_measured?: Array<string>;
1835
+ /** Demographics metrics: each dimension read, with its readings in the window. */
1836
+ dimensions_measured?: Array<{
1837
+ /** A demographic dimension the answer reads. */
1838
+ dimension: string;
1839
+ /** Readings of that dimension in the window. */
1840
+ readings_in_window: number;
1841
+ }>;
1832
1842
  /** Metric family. */
1833
1843
  family: string;
1834
1844
  /** The filters applied (screens, markets, brands, board_id, by, ...). */
@@ -1860,8 +1870,8 @@ type DataApi_DataProducts_MetricAnswer = {
1860
1870
  row_count?: number;
1861
1871
  /** One row per grain cell: the grain keys, then every measure of the metric (see the table on this operation), each with the count it is taken over; `absent` lists the measures with no value and why. */
1862
1872
  rows?: Array<Record<string, unknown>>;
1863
- /** The fleet totals over the window, keyed like a row. */
1864
- totals?: Record<string, unknown>;
1873
+ /** The totals over the window, shaped like `rows`: one row when the answer has one key, one row per key when it has several (per brand for creative_share_of_voice, per panel for a panel metric, per dimension value for demographics); null when no day was measured. */
1874
+ totals?: Record<string, unknown> | Array<Record<string, unknown>> | null | null;
1865
1875
  /** The window answered: from, to, days, timezone, defaulted (or window_end, window_days for a board metric). */
1866
1876
  window: Record<string, unknown>;
1867
1877
  };
@@ -1801,8 +1801,12 @@ type DataApi_DataProducts_Geometry = {
1801
1801
  type DataApi_DataProducts_MeasurementError = {
1802
1802
  /** Machine-readable reason, e.g. invalid_bbox, board_not_found, not_entitled, quota, measurement_unavailable. */
1803
1803
  code: string;
1804
+ /** 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`. */
1805
+ data?: Record<string, unknown>;
1804
1806
  /** What was refused and how to ask again. */
1805
1807
  message: string;
1808
+ /** The scopes the key must hold (INSUFFICIENT_SCOPE on the owner upload routes, which need `measurement:write`). */
1809
+ required_scopes?: Array<string>;
1806
1810
  status: false;
1807
1811
  };
1808
1812
  type DataApi_DataProducts_Method = {
@@ -1828,7 +1832,13 @@ type DataApi_DataProducts_MetricAnswer = {
1828
1832
  /** complete, partial or not_measured. */
1829
1833
  status: string;
1830
1834
  }>;
1831
- dimensions_measured?: Array<string>;
1835
+ /** Demographics metrics: each dimension read, with its readings in the window. */
1836
+ dimensions_measured?: Array<{
1837
+ /** A demographic dimension the answer reads. */
1838
+ dimension: string;
1839
+ /** Readings of that dimension in the window. */
1840
+ readings_in_window: number;
1841
+ }>;
1832
1842
  /** Metric family. */
1833
1843
  family: string;
1834
1844
  /** The filters applied (screens, markets, brands, board_id, by, ...). */
@@ -1860,8 +1870,8 @@ type DataApi_DataProducts_MetricAnswer = {
1860
1870
  row_count?: number;
1861
1871
  /** One row per grain cell: the grain keys, then every measure of the metric (see the table on this operation), each with the count it is taken over; `absent` lists the measures with no value and why. */
1862
1872
  rows?: Array<Record<string, unknown>>;
1863
- /** The fleet totals over the window, keyed like a row. */
1864
- totals?: Record<string, unknown>;
1873
+ /** The totals over the window, shaped like `rows`: one row when the answer has one key, one row per key when it has several (per brand for creative_share_of_voice, per panel for a panel metric, per dimension value for demographics); null when no day was measured. */
1874
+ totals?: Record<string, unknown> | Array<Record<string, unknown>> | null | null;
1865
1875
  /** The window answered: from, to, days, timezone, defaulted (or window_end, window_days for a board metric). */
1866
1876
  window: Record<string, unknown>;
1867
1877
  };