@getlatedev/node 0.2.1358 → 0.2.1360

package/src/generated/types.gen.ts

@@ -47384,15 +47384,15 @@ export type ListAdSetsError = (ErrorResponse | unknown);
 export type CreateAdSetData = {
     body: {
         /**
-         * Zernio SocialAccount id owning the Google Ads connection.
+         * Zernio SocialAccount id owning the Google Ads or Reddit Ads connection.
          */
         accountId: string;
         /**
-         * Only "google" is implemented today; every other value returns 501.
+         * "google" and "reddit" are implemented; every other value returns 501.
          */
         platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
         /**
-         * Google platform campaign ID (numeric) the ad group is created under.
+         * Platform campaign ID the ad group is created under (numeric on Google).
          */
         campaignId: string;
         name: string;
@@ -47402,14 +47402,56 @@ export type CreateAdSetData = {
          */
         maxCpc?: number;
         /**
-         * Platform ad account ID (Google customer ID, digits only). Only required when the connection has more than one.
+         * Platform ad account ID: the Google customer ID (digits only, only required when the connection has more than one) or the Reddit ad account id (required).
          */
         adAccountId?: string;
         /**
-         * Alias of adAccountId, kept for existing callers
+         * Google only. Alias of adAccountId, kept for existing callers
          * @deprecated
          */
         customerId?: string;
+        /**
+         * Reddit only. Budget of the new ad group, in the ad account's currency units. Required when the campaign has no campaign budget; not applied under campaign budget optimization.
+         */
+        budgetAmount?: number;
+        /**
+         * Reddit only. Sent together with budgetAmount.
+         */
+        budgetType?: 'daily' | 'lifetime';
+        /**
+         * Reddit only. ISO 8601 start of the ad group. Defaults to now, or to the campaign start when it is in the future.
+         */
+        startDate?: string;
+        /**
+         * Reddit only. ISO 8601 end of the ad group. Defaults to the campaign end.
+         */
+        endDate?: string;
+        targeting?: TargetingSpec;
+        /**
+         * Reddit only. The pixel and the conversion event the ad group optimizes toward.
+         */
+        promotedObject?: {
+            /**
+             * Reddit pixel id. Defaults to the ad account's first pixel.
+             */
+            pixelId?: string;
+            /**
+             * Conversion event (PURCHASE, LEAD, SIGN_UP, ADD_TO_CART, PAGE_VISIT). Required on a conversions campaign.
+             */
+            customEventType?: string;
+        };
+        /**
+         * Reddit only. VIDEO_VIEW_6S (default) or VIDEO_VIEW_15S on a video views campaign.
+         */
+        optimizationGoal?: string;
+        /**
+         * Reddit only. Defaults to LOWEST_COST_WITHOUT_CAP. Not accepted under campaign budget optimization.
+         */
+        bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP';
+        /**
+         * Reddit only. Bid cap in currency units, sent with bidStrategy.
+         */
+        bidAmount?: number;
     };
     headers?: {
         /**
@@ -47697,7 +47739,35 @@ export type UpdateAdSetData = {
             devicePlatforms?: Array<('mobile' | 'desktop')>;
         } | null;
         /**
-         * Meta only (400 elsewhere). Targeting fields to change, same shape as the `targeting`
+         * Reddit only. Every other platform ignores it (nothing is written and no error is returned,
+         * so a body that also sends `status` still applies it); Meta takes it in
+         * `platformSpecificData.startDate`. The ad group's new start_time, ISO 8601. A value
+         * without an offset (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account
+         * timezone. It cannot be earlier than the start of a campaign that starts in the future,
+         * nor at or after the ad group's end (400, `param: startDate`).
+         *
+         */
+        startDate?: string;
+        /**
+         * Reddit only. Every other platform ignores it (nothing is written and no error is returned,
+         * so a body that also sends `status` still applies it); Meta takes it in
+         * `platformSpecificData.endDate`. The ad group's new end_time, ISO 8601, read in the ad
+         * account timezone when it has no offset; a date alone means the end of that day. `null`
+         * removes the end date so the ad group runs continuously. Returns 400 with
+         * `param: endDate` when it is not after the start, when it falls after the campaign's
+         * end, when the campaign uses campaign budget optimization with no end date (Reddit then
+         * takes no end date on its ad groups), when `null` would outlive a campaign budget
+         * campaign that ends, or when `null` is sent for an ad group with a lifetime budget.
+         *
+         */
+        endDate?: (string) | null;
+        /**
+         * Meta and Reddit (400 elsewhere). On Reddit, see the description above: `languages`
+         * must be among Reddit's ISO 639-1 codes (AR, CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, JA,
+         * KO, NL, NO, PL, PT, RO, SV, VI, ZH, any case), emptying every included location is a
+         * 400 with `param: targeting.countries`, and fields Reddit ad groups cannot take (age,
+         * income, devices, behaviors, B2B, `places`) return 400 with `param: targeting.<field>`.
+         * On Meta: targeting fields to change, same shape as the `targeting`
          * object on POST /v1/ads/create. Only the keys you send change: Zernio reads the ad set's
          * live targeting from Meta, merges these keys over it and writes the full spec back, so
          * everything you do not send (custom audiences, geo, age, interest groups,
@@ -47859,11 +47929,19 @@ export type UpdateAdSetResponse = ({
         [key: string]: unknown;
     };
     /**
-     * Present when `placements` or `targeting` was sent. The ad set's full Meta targeting as written (Meta snake_case). The same snake_case object is stored as the ad set's and its ads' `targeting`.
+     * Present when `placements` or `targeting` was sent. The ad set's full targeting as written, in the platform's own vocabulary (Meta or Reddit snake_case). Stored as the ad set's `targeting`. Meta stores the same object on its ads; Reddit stores it on its ads in the create vocabulary (`countries`, `communities`, ...), as GET /v1/ads/ad-sets/{adSetId}/targeting returns it.
      */
     targeting?: {
         [key: string]: unknown;
     };
+    /**
+     * Reddit: the start_time written, a UTC instant. Present when `startDate` was sent.
+     */
+    startDate?: string;
+    /**
+     * Reddit: the end_time written, a UTC instant, or null when the end date was removed. Present when `endDate` was sent.
+     */
+    endDate?: (string) | null;
 });
 
 export type UpdateAdSetError = (unknown | ErrorResponse);
@@ -47887,6 +47965,39 @@ export type DeleteAdSetResponse = ({
 
 export type DeleteAdSetError = (ErrorResponse | unknown);
 
+export type GetAdSetTargetingData = {
+    path: {
+        /**
+         * Reddit ad group ID
+         */
+        adSetId: string;
+    };
+    query?: {
+        /**
+         * Disambiguates when the same adSetId string exists on more than one connected platform.
+         */
+        platform?: 'reddit';
+    };
+};
+
+export type GetAdSetTargetingResponse = ({
+    adSetId?: string;
+    /**
+     * Only the keys the ad group sets. `regions`, `metros`, `cities` and `zips` entries carry `{ key, name }`; `interests` carry `{ id, name }`.
+     */
+    targeting?: (TargetingSpec);
+    /**
+     * The ad group's start_time, null when it has none.
+     */
+    startDate?: (string) | null;
+    /**
+     * The ad group's end_time, null when it runs continuously.
+     */
+    endDate?: (string) | null;
+});
+
+export type GetAdSetTargetingError = (ErrorResponse | unknown);
+
 export type UpdateAdSetStatusData = {
     body: {
         status: 'active' | 'paused';
@@ -54191,10 +54302,18 @@ export type CreateStandaloneAdData = {
          * (geo, languages, `demandGen.channels`/`audience`/`audienceId`/
          * `adGroupName`) return 400. `validateOnly` is supported.
          *
+         * On Reddit Ads the `adSetId` is the AD GROUP id. Only the post
+         * and the ad are created; the ad group keeps its budget,
+         * schedule, targeting, bid and optimization, so `budgetAmount`,
+         * `budgetType`, `startDate`, `endDate`, targeting fields,
+         * `promotedObject`, `tracking.pixelId` and `optimizationGoal`
+         * return 400. `goal` is not required. An ad group of another
+         * ad account returns 404.
+         *
          */
         adSetId?: string;
         /**
-         * Meta, Google Ads, LinkedIn and TikTok. On TikTok: creates
+         * Meta, Google Ads, LinkedIn, TikTok and Reddit Ads. On TikTok: creates
          * the ad group and the ad under this existing campaign; the
          * campaign is neither created nor activated and its
          * objective must fit `goal`; not with `smartPlus`.
@@ -54220,8 +54339,26 @@ export type CreateStandaloneAdData = {
          * a new ad group, so geo and language fields return 400 there; the new
          * ad group follows the campaign's targeting. On failure only the entities we
          * authored are cleaned up; the pre-existing parent is left
-         * untouched and is never (re)activated. Mutually exclusive
-         * with `adSetId` and `creatives[]`.
+         * untouched and is never (re)activated. On Reddit Ads:
+         * creates a new ad group and the ad under this EXISTING
+         * campaign; `goal` may be omitted (the campaign's objective
+         * decides it) and any other goal returns 400 naming the one to
+         * send. The ad group must start no earlier than a future
+         * campaign start and end no later than the campaign end
+         * (400 otherwise); without `endDate` it ends with the
+         * campaign. When the campaign has
+         * no campaign budget, send `budgetAmount`/`budgetType` for the
+         * new ad group (400 without them); bid, conversion event and
+         * pixel work as on a new campaign. Under campaign budget
+         * optimization the ad group takes the campaign's bid,
+         * goal type, optimization event and pixel, carries no budget
+         * of its own (a budget in the request is not applied), and
+         * bid fields or another conversion event or pixel return
+         * 400, as does an `endDate` when the campaign has no end
+         * date. A
+         * campaign of another ad account returns 404, a Reddit Max
+         * campaign 422. If the ad fails, the new ad group is
+         * archived. Mutually exclusive with `adSetId` and `creatives[]`.
          *
          */
         existingCampaignId?: string;
@@ -57874,6 +58011,74 @@ export type RemoveCustomConversionGoalResponse = ({
 
 export type RemoveCustomConversionGoalError = (ErrorResponse | unknown);
 
+export type ListEventsData = {
+    query: {
+        /**
+         * `nextCursor` from the previous page.
+         */
+        cursor?: string;
+        /**
+         * Only events with this name, such as `Purchase`.
+         */
+        eventName?: string;
+        /**
+         * Only events at or after this time (ISO 8601, on the event time).
+         */
+        from?: string;
+        limit?: number;
+        profileId: string;
+        /**
+         * Only events before this time (ISO 8601, on the event time).
+         */
+        to?: string;
+    };
+};
+
+export type ListEventsResponse = ({
+    events?: Array<{
+        eventId?: string;
+        eventName?: string;
+        eventTime?: string;
+        receivedAt?: string;
+        actionSource?: (string) | null;
+        value?: (number) | null;
+        currency?: (string) | null;
+        /**
+         * Origin, path and attribution parameters only.
+         */
+        sourceUrl?: (string) | null;
+        utm?: {
+            source?: (string) | null;
+            medium?: (string) | null;
+            campaign?: (string) | null;
+            content?: (string) | null;
+        };
+        /**
+         * Ad ID from the `zrn` parameter Zernio adds to links of ads it creates.
+         */
+        zrn?: (string) | null;
+        clickIds?: {
+            gclid?: (string) | null;
+            fbc?: (string) | null;
+        };
+        /**
+         * Destinations the event was forwarded to.
+         */
+        destinationsSent?: number;
+        hasEmail?: boolean;
+        hasPhone?: boolean;
+        hasExternalId?: boolean;
+    }>;
+    /**
+     * Pass as `cursor` to get the next page; `null` on the last page.
+     */
+    nextCursor?: (string) | null;
+});
+
+export type ListEventsError = (ErrorResponse | {
+    error?: string;
+});
+
 export type SendEventsData = {
     body: {
         /**