@pushwoosh/rpc-v2-http-api-data 0.2.421 → 0.2.422

package/data.js

@@ -17798,7 +17798,11 @@ export const data = {
             "CREATE_NAME_TOO_LONG",
             "CREATE_CONNECTION_FAILED",
             "CREATE_PROJECT_ID_EMPTY",
-            "CREATE_SERVICE_ACCOUNT_JSON_EMPTY"
+            "CREATE_SERVICE_ACCOUNT_JSON_EMPTY",
+            "CREATE_GA4_PROPERTY_ID_EMPTY",
+            "CREATE_GA4_AUDIENCE_ID_EMPTY",
+            "CREATE_GA4_PROPERTY_ID_INVALID",
+            "CREATE_GA4_AUDIENCE_ID_INVALID"
         ]
     },
     "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FieldViolations": {
@@ -17815,7 +17819,11 @@ export const data = {
             "UPDATE_NAME_TOO_LONG",
             "UPDATE_CONNECTION_FAILED",
             "UPDATE_PROJECT_ID_EMPTY",
-            "UPDATE_SERVICE_ACCOUNT_JSON_EMPTY"
+            "UPDATE_SERVICE_ACCOUNT_JSON_EMPTY",
+            "UPDATE_GA4_PROPERTY_ID_EMPTY",
+            "UPDATE_GA4_AUDIENCE_ID_EMPTY",
+            "UPDATE_GA4_PROPERTY_ID_INVALID",
+            "UPDATE_GA4_AUDIENCE_ID_INVALID"
         ]
     },
     "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FailedPreconditions": {
@@ -17895,6 +17903,15 @@ export const data = {
                     "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
                 }
             },
+            "ListGoogleAnalyticsAudiences": {
+                "request": "pushwoosh.rpc.external_segments.v3.ListGoogleAnalyticsAudiencesRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.ListGoogleAnalyticsAudiencesResponse",
+                "method": "post",
+                "path": "/api/external-segments:list-ga4-audiences",
+                "errors": {
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            },
             "TestConnection": {
                 "request": "pushwoosh.rpc.external_segments.v3.TestConnectionRequest",
                 "response": "pushwoosh.rpc.external_segments.v3.TestConnectionResponse",
@@ -18007,6 +18024,20 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudienceConnection": {
+        "type": "I",
+        "fields": {
+            "propertyId": {
+                "type": "string"
+            },
+            "audienceId": {
+                "type": "string"
+            },
+            "serviceAccountJson": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc.external_segments.v3.ExternalSegment": {
         "type": "I",
         "fields": {
@@ -18031,6 +18062,9 @@ export const data = {
             "mssql": {
                 "type": "pushwoosh.rpc.external_segments.v3.MssqlConnection"
             },
+            "ga4Audience": {
+                "type": "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudienceConnection"
+            },
             "query": {
                 "type": "string"
             },
@@ -18056,7 +18090,8 @@ export const data = {
                     "postgres",
                     "mysql",
                     "bigquery",
-                    "mssql"
+                    "mssql",
+                    "ga4Audience"
                 ]
             }
         }
@@ -18118,6 +18153,9 @@ export const data = {
             "mssql": {
                 "type": "pushwoosh.rpc.external_segments.v3.MssqlConnection"
             },
+            "ga4Audience": {
+                "type": "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudienceConnection"
+            },
             "query": {
                 "type": "string"
             }
@@ -18128,7 +18166,8 @@ export const data = {
                     "postgres",
                     "mysql",
                     "bigquery",
-                    "mssql"
+                    "mssql",
+                    "ga4Audience"
                 ]
             }
         }
@@ -18166,6 +18205,9 @@ export const data = {
             "mssql": {
                 "type": "pushwoosh.rpc.external_segments.v3.MssqlConnection"
             },
+            "ga4Audience": {
+                "type": "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudienceConnection"
+            },
             "query": {
                 "type": "string",
                 "optional": true
@@ -18177,7 +18219,8 @@ export const data = {
                     "postgres",
                     "mysql",
                     "bigquery",
-                    "mssql"
+                    "mssql",
+                    "ga4Audience"
                 ]
             }
         }
@@ -18248,6 +18291,9 @@ export const data = {
             "mssql": {
                 "type": "pushwoosh.rpc.external_segments.v3.MssqlConnection"
             },
+            "ga4Audience": {
+                "type": "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudienceConnection"
+            },
             "query": {
                 "type": "string"
             },
@@ -18261,7 +18307,8 @@ export const data = {
                     "postgres",
                     "mysql",
                     "bigquery",
-                    "mssql"
+                    "mssql",
+                    "ga4Audience"
                 ]
             }
         }
@@ -18277,6 +18324,43 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc.external_segments.v3.ListGoogleAnalyticsAudiencesRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "propertyId": {
+                "type": "string"
+            },
+            "serviceAccountJson": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.ListGoogleAnalyticsAudiencesResponse": {
+        "type": "I",
+        "fields": {
+            "audiences": {
+                "type": "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudience",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.GoogleAnalyticsAudience": {
+        "type": "I",
+        "fields": {
+            "audienceId": {
+                "type": "string"
+            },
+            "displayName": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.feature_flags.FeatureFlagsService_FieldViolations": {
         "type": "E",
         "values": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.421",
+  "version": "0.2.422",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",

package/pushwoosh_rpc_external_segments_v3.d.ts

@@ -48,6 +48,22 @@ export type ExternalSegmentsService_Create_FieldViolations = {
     reason: 'CREATE_SERVICE_ACCOUNT_JSON_EMPTY';
     field: string;
     description: string;
+} | {
+    reason: 'CREATE_GA4_PROPERTY_ID_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_GA4_AUDIENCE_ID_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_GA4_PROPERTY_ID_INVALID';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_GA4_AUDIENCE_ID_INVALID';
+    field: string;
+    description: string;
 };
 export type ExternalSegmentsService_Update_FieldViolations = {
     reason: 'UPDATE_FV_UNSPECIFIED';
@@ -97,6 +113,22 @@ export type ExternalSegmentsService_Update_FieldViolations = {
     reason: 'UPDATE_SERVICE_ACCOUNT_JSON_EMPTY';
     field: string;
     description: string;
+} | {
+    reason: 'UPDATE_GA4_PROPERTY_ID_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_GA4_AUDIENCE_ID_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_GA4_PROPERTY_ID_INVALID';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_GA4_AUDIENCE_ID_INVALID';
+    field: string;
+    description: string;
 };
 export type ExternalSegmentsService_Update_FailedPreconditions = {
     type: 'UPDATE_FP_UNSPECIFIED';
@@ -161,6 +193,13 @@ export type ExternalSegmentsService_CheckConnection = RpcMethodV3<CheckConnectio
     error?: undefined;
     failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
+export type ExternalSegmentsService_ListGoogleAnalyticsAudiences = RpcMethodV3<ListGoogleAnalyticsAudiencesRequest, ListGoogleAnalyticsAudiencesResponse, {
+    error: unknown;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
 export type ExternalSegmentsService_TestConnection = RpcMethodV3<TestConnectionRequest, TestConnectionResponse, {
     error: unknown;
     failedPreconditions?: undefined;
@@ -194,6 +233,8 @@ export interface ExternalSegmentsService {
     Delete: ExternalSegmentsService_Delete;
     /** Connects to a stored external segment's database and runs its saved query, then records the outcome in the segment's valid flag. Use to re-check an existing segment; unlike test_external_segment_connection it persists the result. */
     CheckConnection: ExternalSegmentsService_CheckConnection;
+    /** Lists the audiences of a Google Analytics 4 property that the given service account can read, for picking the audience of a ga4_audience external segment. Pass code to reuse the stored key of an existing segment instead of re-entering it. */
+    ListGoogleAnalyticsAudiences: ExternalSegmentsService_ListGoogleAnalyticsAudiences;
     /** Tests external database connection parameters supplied inline (optionally backfilling secrets from a saved segment by code) without persisting anything. Use from the create/edit form before saving; set check_query to also validate the query, otherwise only connectivity is checked. */
     TestConnection: ExternalSegmentsService_TestConnection;
 }
@@ -218,6 +259,9 @@ export type ExternalSegmentsService_Errors = {
     CheckConnection: {
         failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
     };
+    ListGoogleAnalyticsAudiences: {
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
     TestConnection: {
         failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
     };
@@ -336,6 +380,23 @@ export type BigQueryConnection = {
      */
     location: string;
 };
+/**
+ * GoogleAnalyticsAudienceConnection points an external segment at a Google
+ * Analytics 4 audience. Members are read through the GA4 Audience Export API,
+ * so the segment has no query.
+ */
+export type GoogleAnalyticsAudienceConnection = {
+    /** GA4 property ID, e.g. "123456789" (a "properties/123456789" resource name is also accepted). */
+    propertyId: string;
+    /** GA4 audience ID within the property, e.g. "16052885366". */
+    audienceId: string;
+    /**
+     * Service account JSON key. The service account needs the Viewer role on the
+     * GA4 property. Write-only: never returned by read methods; on update an empty
+     * value keeps the currently stored key.
+     */
+    serviceAccountJson: string;
+};
 export type ExternalSegment_connection_postgres = {
     type: 'postgres';
     data: PostgresConnection;
@@ -352,7 +413,11 @@ export type ExternalSegment_connection_mssql = {
     type: 'mssql';
     data: MssqlConnection;
 };
-export type ExternalSegment_connection = ExternalSegment_connection_postgres | ExternalSegment_connection_mysql | ExternalSegment_connection_bigquery | ExternalSegment_connection_mssql;
+export type ExternalSegment_connection_ga4Audience = {
+    type: 'ga4Audience';
+    data: GoogleAnalyticsAudienceConnection;
+};
+export type ExternalSegment_connection = ExternalSegment_connection_postgres | ExternalSegment_connection_mysql | ExternalSegment_connection_bigquery | ExternalSegment_connection_mssql | ExternalSegment_connection_ga4Audience;
 /**
  * ExternalSegment is the full representation returned by read methods.
  * It exposes neither the raw connection string nor a database "kind" enum:
@@ -366,7 +431,7 @@ export type ExternalSegment = {
     code: string;
     /** Human-readable name. Not unique. Free text, up to 100 characters. */
     name: string;
-    /** SQL query that returns a single "user_id" column. */
+    /** SQL query that returns a single "user_id" column. Empty for ga4_audience. */
     query: string;
     /** Whether the segment configuration is considered valid and usable. */
     valid: boolean;
@@ -412,13 +477,20 @@ export type CreateRequest_connection_mssql = {
     type: 'mssql';
     data: MssqlConnection;
 };
-export type CreateRequest_connection = CreateRequest_connection_postgres | CreateRequest_connection_mysql | CreateRequest_connection_bigquery | CreateRequest_connection_mssql;
+export type CreateRequest_connection_ga4Audience = {
+    type: 'ga4Audience';
+    data: GoogleAnalyticsAudienceConnection;
+};
+export type CreateRequest_connection = CreateRequest_connection_postgres | CreateRequest_connection_mysql | CreateRequest_connection_bigquery | CreateRequest_connection_mssql | CreateRequest_connection_ga4Audience;
 export type CreateRequest = {
     /** Application code the segment belongs to. */
     application?: string;
     /** Human-readable name. Required, not unique, up to 100 characters. */
     name?: string;
-    /** SQL query that must return a single "user_id" column. */
+    /**
+     * SQL query that must return a single "user_id" column. Not used (leave empty)
+     * for ga4_audience.
+     */
     query?: string;
     connection: CreateRequest_connection;
 };
@@ -441,7 +513,11 @@ export type UpdateRequest_connection_mssql = {
     type: 'mssql';
     data: MssqlConnection;
 };
-export type UpdateRequest_connection = UpdateRequest_connection_postgres | UpdateRequest_connection_mysql | UpdateRequest_connection_bigquery | UpdateRequest_connection_mssql;
+export type UpdateRequest_connection_ga4Audience = {
+    type: 'ga4Audience';
+    data: GoogleAnalyticsAudienceConnection;
+};
+export type UpdateRequest_connection = UpdateRequest_connection_postgres | UpdateRequest_connection_mysql | UpdateRequest_connection_bigquery | UpdateRequest_connection_mssql | UpdateRequest_connection_ga4Audience;
 export type UpdateRequest = {
     /** Application code the segment belongs to. */
     application?: string;
@@ -494,7 +570,11 @@ export type TestConnectionRequest_connection_mssql = {
     type: 'mssql';
     data: MssqlConnection;
 };
-export type TestConnectionRequest_connection = TestConnectionRequest_connection_postgres | TestConnectionRequest_connection_mysql | TestConnectionRequest_connection_bigquery | TestConnectionRequest_connection_mssql;
+export type TestConnectionRequest_connection_ga4Audience = {
+    type: 'ga4Audience';
+    data: GoogleAnalyticsAudienceConnection;
+};
+export type TestConnectionRequest_connection = TestConnectionRequest_connection_postgres | TestConnectionRequest_connection_mysql | TestConnectionRequest_connection_bigquery | TestConnectionRequest_connection_mssql | TestConnectionRequest_connection_ga4Audience;
 export type TestConnectionRequest = {
     /** Application code the segment belongs to. */
     application?: string;
@@ -509,7 +589,8 @@ export type TestConnectionRequest = {
     query?: string;
     /**
      * When true, the query is executed to validate it (SQL: run it and read the
-     * first row; BigQuery: dry-run). When false, only connectivity is checked.
+     * first row; BigQuery: dry-run; GA4 audience: the audience must exist). When
+     * false, only connectivity is checked.
      */
     checkQuery?: boolean;
     connection: TestConnectionRequest_connection;
@@ -520,3 +601,27 @@ export type TestConnectionResponse = {
     /** Failure message when ok is false; empty otherwise. */
     error: string;
 };
+export type ListGoogleAnalyticsAudiencesRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /**
+     * Optional external segment code. When set and service_account_json is
+     * empty, the stored key of that ga4_audience segment is used, provided
+     * property_id matches the stored one.
+     */
+    code?: string;
+    /** GA4 property ID. */
+    propertyId?: string;
+    /** Service account JSON key with the Viewer role on the property. */
+    serviceAccountJson?: string;
+};
+export type ListGoogleAnalyticsAudiencesResponse = {
+    audiences: GoogleAnalyticsAudience[];
+};
+/** GoogleAnalyticsAudience is one audience of a GA4 property. */
+export type GoogleAnalyticsAudience = {
+    /** Audience ID within the property, as expected in GoogleAnalyticsAudienceConnection.audience_id. */
+    audienceId: string;
+    /** Audience name shown in Google Analytics. */
+    displayName: string;
+};