@postrun/js 2.20.0 → 2.21.0

package/dist/query.d.cts

@@ -1294,6 +1294,10 @@ type GoogleAdsAudience = {
     status: 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'REMOVED';
     type: 'UNSPECIFIED' | 'UNKNOWN' | 'AUTO' | 'INTEREST' | 'PURCHASE_INTENT' | 'SEARCH';
 };
+/**
+ * Filter by serving status (ENABLED / PAUSED / REMOVED). Omit to return everything except REMOVED.
+ */
+type GoogleAdsReadStatusFilter = Array<'ENABLED' | 'PAUSED' | 'REMOVED'>;
 /**
  * A Google Ads campaign targeting criterion. LOCATION and LANGUAGE are fully modelled (with their geo_target_constant / language_constant, status, and negative flag); any other criterion type is returned as { type, criterion_id }.
  */
@@ -1446,13 +1450,21 @@ type GoogleAdsInsightsRow = {
      * The requested metrics keyed by name; only the metrics you asked for are present.
      */
     metrics: {
-        [key: string]: number | null;
+        impressions?: number | null;
+        clicks?: number | null;
+        ctr?: number | null;
+        average_cpc?: number | null;
+        cost_micros?: number | null;
+        conversions?: number | null;
+        conversions_value?: number | null;
+        cost_per_conversion?: number | null;
     };
     /**
      * The requested breakdowns keyed by segment name; present only when segments were requested.
      */
     segments?: {
-        [key: string]: string;
+        date?: string;
+        device?: string;
     };
 };
 /**
@@ -1501,11 +1513,22 @@ type GoogleAdTreeNode = {
      * Whether the tree read can fetch this node’s children today (true only for ad-group channel types in this version).
      */
     expandable: boolean;
+    /**
+     * The campaign’s average daily budget in micros (1/1,000,000 of the account currency). Present on campaign nodes only — null at ad_group / ad / keyword (and null when a campaign has no budget).
+     */
+    budget_micros: number | null;
     /**
      * The requested metrics keyed by name; only the metrics you asked for are present. Google’s authoritative per-level numbers (no client roll-up).
      */
     metrics: {
-        [key: string]: number | null;
+        impressions?: number | null;
+        clicks?: number | null;
+        ctr?: number | null;
+        average_cpc?: number | null;
+        cost_micros?: number | null;
+        conversions?: number | null;
+        conversions_value?: number | null;
+        cost_per_conversion?: number | null;
     };
     /**
      * Spend for this node in micros (1/1,000,000 of the account currency), as Google reports it.
@@ -11535,6 +11558,7 @@ type GoogleGetAdTreeData = {
          * Restrict to one campaign — returns that campaign’s subtree (ad groups + leaf). Omit for the campaign level.
          */
         campaign_id?: string;
+        status?: GoogleAdsReadStatusFilter;
         /**
          * The metric columns to report. At least one.
          */
@@ -16755,6 +16779,7 @@ type GoogleListAdGroupsData = {
          * Only return ad groups under this campaign (its numeric id).
          */
         campaign_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/ad-groups';
 };
@@ -20780,6 +20805,7 @@ type GoogleListAdsData = {
          * Only return ads under this ad group (its numeric id).
          */
         ad_group_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/ads';
 };
@@ -23036,6 +23062,7 @@ type GoogleListKeywordsData = {
          * Only return keywords under this ad group (its numeric id).
          */
         ad_group_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/keywords';
 };
@@ -32700,7 +32727,7 @@ declare const googleGetAdTreeQueryKey: (options: Options<GoogleGetAdTreeData>) =
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * The campaign → ad_group → ad/keyword tree as flat, native, typed nodes — group them by `parent_id` to assemble the tree. Without `campaign_id`, returns every campaign (all channel types) with a per-type `child_kind`/`expandable` hint. With `campaign_id`, returns that campaign’s whole supported subtree (ad groups + the type’s leaf — keywords for Search, ads for Display/Video/Demand Gen) in one batched fetch at a single window. Each node carries Google’s authoritative per-level metrics (no client roll-up), `cost_micros`, and `cost` (account currency).
+ * The campaign → ad_group → ad/keyword tree as flat, native, typed nodes — group them by `parent_id` to assemble the tree. Without `campaign_id`, returns every campaign (all channel types) with a per-type `child_kind`/`expandable` hint. With `campaign_id`, returns that campaign’s whole supported subtree (ad groups + the type’s leaf — keywords for Search, ads for Display/Video/Demand Gen) in one batched fetch at a single window. By default REMOVED nodes are hidden at every level; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED). Each node carries `budget_micros` (campaign nodes only), Google’s authoritative per-level metrics (no client roll-up), `cost_micros`, and `cost` (account currency).
  */
 declare const googleGetAdTreeOptions: (options: Options<GoogleGetAdTreeData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<GoogleAdTree, GoogleGetAdTreeError, GoogleAdTree, [Pick<Options<GoogleGetAdTreeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
@@ -33056,7 +33083,7 @@ declare const googleListAdGroupsQueryKey: (options: Options<GoogleListAdGroupsDa
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Lists the ad groups (Google’s equivalent of an ad set) in the Google Ads account backing this connection — id, name, status, type, and parent campaign. Pass `campaign_id` to return only the ad groups under one campaign.
+ * Lists the ad groups (Google’s equivalent of an ad set) in the Google Ads account backing this connection — id, name, status, type, and parent campaign. Pass `campaign_id` to return only the ad groups under one campaign. By default REMOVED ad groups are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListAdGroupsOptions: (options: Options<GoogleListAdGroupsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";
@@ -33292,7 +33319,7 @@ declare const googleListAdsQueryKey: (options: Options<GoogleListAdsData>) => [P
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Returns the ads (the `ad_group_ad` resource) on the connection’s account — id, name, creative type, serving status, and the owning ad group. Pass `ad_group_id` to return only the ads under one ad group.
+ * Returns the ads (the `ad_group_ad` resource) on the connection’s account — id, name, creative type, serving status, and the owning ad group. Pass `ad_group_id` to return only the ads under one ad group. By default REMOVED ads are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListAdsOptions: (options: Options<GoogleListAdsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";
@@ -33408,7 +33435,7 @@ declare const googleListKeywordsQueryKey: (options: Options<GoogleListKeywordsDa
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Lists the keywords (`ad_group_criterion` of type KEYWORD) in the connection’s account — each with its criterion id, text, match type, status, negative flag, and owning ad group. Pass `ad_group_id` to return only the keywords under one ad group.
+ * Lists the keywords (`ad_group_criterion` of type KEYWORD) in the connection’s account — each with its criterion id, text, match type, status, negative flag, and owning ad group. Pass `ad_group_id` to return only the keywords under one ad group. By default REMOVED keywords are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListKeywordsOptions: (options: Options<GoogleListKeywordsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";

package/dist/query.d.ts

@@ -1294,6 +1294,10 @@ type GoogleAdsAudience = {
     status: 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'REMOVED';
     type: 'UNSPECIFIED' | 'UNKNOWN' | 'AUTO' | 'INTEREST' | 'PURCHASE_INTENT' | 'SEARCH';
 };
+/**
+ * Filter by serving status (ENABLED / PAUSED / REMOVED). Omit to return everything except REMOVED.
+ */
+type GoogleAdsReadStatusFilter = Array<'ENABLED' | 'PAUSED' | 'REMOVED'>;
 /**
  * A Google Ads campaign targeting criterion. LOCATION and LANGUAGE are fully modelled (with their geo_target_constant / language_constant, status, and negative flag); any other criterion type is returned as { type, criterion_id }.
  */
@@ -1446,13 +1450,21 @@ type GoogleAdsInsightsRow = {
      * The requested metrics keyed by name; only the metrics you asked for are present.
      */
     metrics: {
-        [key: string]: number | null;
+        impressions?: number | null;
+        clicks?: number | null;
+        ctr?: number | null;
+        average_cpc?: number | null;
+        cost_micros?: number | null;
+        conversions?: number | null;
+        conversions_value?: number | null;
+        cost_per_conversion?: number | null;
     };
     /**
      * The requested breakdowns keyed by segment name; present only when segments were requested.
      */
     segments?: {
-        [key: string]: string;
+        date?: string;
+        device?: string;
     };
 };
 /**
@@ -1501,11 +1513,22 @@ type GoogleAdTreeNode = {
      * Whether the tree read can fetch this node’s children today (true only for ad-group channel types in this version).
      */
     expandable: boolean;
+    /**
+     * The campaign’s average daily budget in micros (1/1,000,000 of the account currency). Present on campaign nodes only — null at ad_group / ad / keyword (and null when a campaign has no budget).
+     */
+    budget_micros: number | null;
     /**
      * The requested metrics keyed by name; only the metrics you asked for are present. Google’s authoritative per-level numbers (no client roll-up).
      */
     metrics: {
-        [key: string]: number | null;
+        impressions?: number | null;
+        clicks?: number | null;
+        ctr?: number | null;
+        average_cpc?: number | null;
+        cost_micros?: number | null;
+        conversions?: number | null;
+        conversions_value?: number | null;
+        cost_per_conversion?: number | null;
     };
     /**
      * Spend for this node in micros (1/1,000,000 of the account currency), as Google reports it.
@@ -11535,6 +11558,7 @@ type GoogleGetAdTreeData = {
          * Restrict to one campaign — returns that campaign’s subtree (ad groups + leaf). Omit for the campaign level.
          */
         campaign_id?: string;
+        status?: GoogleAdsReadStatusFilter;
         /**
          * The metric columns to report. At least one.
          */
@@ -16755,6 +16779,7 @@ type GoogleListAdGroupsData = {
          * Only return ad groups under this campaign (its numeric id).
          */
         campaign_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/ad-groups';
 };
@@ -20780,6 +20805,7 @@ type GoogleListAdsData = {
          * Only return ads under this ad group (its numeric id).
          */
         ad_group_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/ads';
 };
@@ -23036,6 +23062,7 @@ type GoogleListKeywordsData = {
          * Only return keywords under this ad group (its numeric id).
          */
         ad_group_id?: string;
+        status?: GoogleAdsReadStatusFilter;
     };
     url: '/google/{connection_id}/keywords';
 };
@@ -32700,7 +32727,7 @@ declare const googleGetAdTreeQueryKey: (options: Options<GoogleGetAdTreeData>) =
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * The campaign → ad_group → ad/keyword tree as flat, native, typed nodes — group them by `parent_id` to assemble the tree. Without `campaign_id`, returns every campaign (all channel types) with a per-type `child_kind`/`expandable` hint. With `campaign_id`, returns that campaign’s whole supported subtree (ad groups + the type’s leaf — keywords for Search, ads for Display/Video/Demand Gen) in one batched fetch at a single window. Each node carries Google’s authoritative per-level metrics (no client roll-up), `cost_micros`, and `cost` (account currency).
+ * The campaign → ad_group → ad/keyword tree as flat, native, typed nodes — group them by `parent_id` to assemble the tree. Without `campaign_id`, returns every campaign (all channel types) with a per-type `child_kind`/`expandable` hint. With `campaign_id`, returns that campaign’s whole supported subtree (ad groups + the type’s leaf — keywords for Search, ads for Display/Video/Demand Gen) in one batched fetch at a single window. By default REMOVED nodes are hidden at every level; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED). Each node carries `budget_micros` (campaign nodes only), Google’s authoritative per-level metrics (no client roll-up), `cost_micros`, and `cost` (account currency).
  */
 declare const googleGetAdTreeOptions: (options: Options<GoogleGetAdTreeData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<GoogleAdTree, GoogleGetAdTreeError, GoogleAdTree, [Pick<Options<GoogleGetAdTreeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
@@ -33056,7 +33083,7 @@ declare const googleListAdGroupsQueryKey: (options: Options<GoogleListAdGroupsDa
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Lists the ad groups (Google’s equivalent of an ad set) in the Google Ads account backing this connection — id, name, status, type, and parent campaign. Pass `campaign_id` to return only the ad groups under one campaign.
+ * Lists the ad groups (Google’s equivalent of an ad set) in the Google Ads account backing this connection — id, name, status, type, and parent campaign. Pass `campaign_id` to return only the ad groups under one campaign. By default REMOVED ad groups are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListAdGroupsOptions: (options: Options<GoogleListAdGroupsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";
@@ -33292,7 +33319,7 @@ declare const googleListAdsQueryKey: (options: Options<GoogleListAdsData>) => [P
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Returns the ads (the `ad_group_ad` resource) on the connection’s account — id, name, creative type, serving status, and the owning ad group. Pass `ad_group_id` to return only the ads under one ad group.
+ * Returns the ads (the `ad_group_ad` resource) on the connection’s account — id, name, creative type, serving status, and the owning ad group. Pass `ad_group_id` to return only the ads under one ad group. By default REMOVED ads are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListAdsOptions: (options: Options<GoogleListAdsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";
@@ -33408,7 +33435,7 @@ declare const googleListKeywordsQueryKey: (options: Options<GoogleListKeywordsDa
  *
  * **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
  *
- * Lists the keywords (`ad_group_criterion` of type KEYWORD) in the connection’s account — each with its criterion id, text, match type, status, negative flag, and owning ad group. Pass `ad_group_id` to return only the keywords under one ad group.
+ * Lists the keywords (`ad_group_criterion` of type KEYWORD) in the connection’s account — each with its criterion id, text, match type, status, negative flag, and owning ad group. Pass `ad_group_id` to return only the keywords under one ad group. By default REMOVED keywords are hidden; pass `status` to filter to specific serving states (ENABLED / PAUSED / REMOVED).
  */
 declare const googleListKeywordsOptions: (options: Options<GoogleListKeywordsData>) => _tanstack_react_query.OmitKeyof<_tanstack_react_query.UseQueryOptions<{
     object: "list";