@postrun/js 3.2.0 → 4.0.0
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.
- package/dist/{chunk-A6DM6I6G.js → chunk-VCOKMHAJ.js} +497 -2655
- package/dist/chunk-VCOKMHAJ.js.map +1 -0
- package/dist/{chunk-PE3ULG66.js → chunk-YP26OO5J.js} +8 -989
- package/dist/chunk-YP26OO5J.js.map +1 -0
- package/dist/index.cjs +1471 -4639
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +92 -604
- package/dist/index.d.ts +92 -604
- package/dist/index.js +51 -48
- package/dist/index.js.map +1 -1
- package/dist/query.cjs +253 -2195
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +1609 -19326
- package/dist/query.d.ts +1609 -19326
- package/dist/query.js +253 -2101
- package/dist/query.js.map +1 -1
- package/dist/schemas/index.cjs +499 -2924
- package/dist/schemas/index.cjs.map +1 -1
- package/dist/schemas/index.d.cts +9478 -9171
- package/dist/schemas/index.d.ts +9478 -9171
- package/dist/schemas/index.js +1 -27
- package/dist/schemas/index.js.map +1 -1
- package/dist/server.cjs +492 -2619
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.js +2 -2
- package/dist/types.gen-DjaUEnXO.d.cts +10571 -0
- package/dist/types.gen-DjaUEnXO.d.ts +10571 -0
- package/package.json +1 -1
- package/dist/chunk-A6DM6I6G.js.map +0 -1
- package/dist/chunk-PE3ULG66.js.map +0 -1
- package/dist/types.gen-K4cuIpk3.d.cts +0 -27064
- package/dist/types.gen-K4cuIpk3.d.ts +0 -27064
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { T as TDataShape, O as Options$1, C as Client, a as ClientMeta, b as ConnectionsConnectData, R as RequestResult, c as ConnectionsConnectResponses, d as ConnectionsConnectErrors, e as ConnectionsDeleteData, f as ConnectionsDeleteResponses, g as ConnectionsDeleteErrors, h as ConnectionsGetData, i as ConnectionsGetResponses, j as ConnectionsGetErrors, k as ConnectionsListAccountsData, l as ConnectionsListAccountsResponses, m as ConnectionsListAccountsErrors, n as ConnectionsListByProfileData, o as ConnectionsListByProfileResponses, p as ConnectionsListByProfileErrors, q as ConnectionsSelectData, r as ConnectionsSelectResponses, s as ConnectionsSelectErrors, G as GoogleCreateAdData, t as GoogleCreateAdResponses, u as GoogleCreateAdErrors, v as GoogleCreateAdGroupData, w as GoogleCreateAdGroupResponses, x as GoogleCreateAdGroupErrors, y as GoogleCreateAdGroupCriterionData, z as GoogleCreateAdGroupCriterionResponses, A as GoogleCreateAdGroupCriterionErrors, B as GoogleCreateBudgetData, D as GoogleCreateBudgetResponses, E as GoogleCreateBudgetErrors, F as GoogleCreateCampaignData, H as GoogleCreateCampaignResponses, I as GoogleCreateCampaignErrors, J as GoogleCreateCampaignCriterionData, K as GoogleCreateCampaignCriterionResponses, L as GoogleCreateCampaignCriterionErrors, M as GoogleCreateConversionActionData, N as GoogleCreateConversionActionResponses, P as GoogleCreateConversionActionErrors, Q as GoogleCreateDisplayAdData, S as GoogleCreateDisplayAdResponses, U as GoogleCreateDisplayAdErrors, V as GoogleCreateKeywordData, W as GoogleCreateKeywordResponses, X as GoogleCreateKeywordErrors, Y as GoogleEditAccountData, Z as GoogleEditAccountResponses, _ as GoogleEditAccountErrors, $ as GoogleEditAdGroupData, a0 as GoogleEditAdGroupResponses, a1 as GoogleEditAdGroupErrors, a2 as GoogleEditBudgetData, a3 as GoogleEditBudgetResponses, a4 as GoogleEditBudgetErrors, a5 as GoogleEditCampaignData, a6 as GoogleEditCampaignResponses, a7 as GoogleEditCampaignErrors, a8 as GoogleEnableAdData, a9 as GoogleEnableAdResponses, aa as GoogleEnableAdErrors, ab as GoogleEnableAdGroupData, ac as GoogleEnableAdGroupResponses, ad as GoogleEnableAdGroupErrors, ae as GoogleEnableCampaignData, af as GoogleEnableCampaignResponses, ag as GoogleEnableCampaignErrors, ah as GoogleEnableKeywordData, ai as GoogleEnableKeywordResponses, aj as GoogleEnableKeywordErrors, ak as GoogleGetAccountData, al as GoogleGetAccountResponses, am as GoogleGetAccountErrors, an as GoogleGetAdData, ao as GoogleGetAdResponses, ap as GoogleGetAdErrors, aq as GoogleGetAdGroupData, ar as GoogleGetAdGroupResponses, as as GoogleGetAdGroupErrors, at as GoogleGetAdTreeData, au as GoogleGetAdTreeResponses, av as GoogleGetAdTreeErrors, aw as GoogleGetCampaignData, ax as GoogleGetCampaignResponses, ay as GoogleGetCampaignErrors, az as GoogleGetConversionActionData, aA as GoogleGetConversionActionResponses, aB as GoogleGetConversionActionErrors, aC as GoogleGetConversionStatusData, aD as GoogleGetConversionStatusResponses, aE as GoogleGetConversionStatusErrors, aF as GoogleGetInsightsData, aG as GoogleGetInsightsResponses, aH as GoogleGetInsightsErrors, aI as GoogleGetKeywordData, aJ as GoogleGetKeywordResponses, aK as GoogleGetKeywordErrors, aL as GoogleListAdGroupCriteriaData, aM as GoogleListAdGroupCriteriaResponses, aN as GoogleListAdGroupCriteriaErrors, aO as GoogleListAdGroupsData, aP as GoogleListAdGroupsResponses, aQ as GoogleListAdGroupsErrors, aR as GoogleListAdsData, aS as GoogleListAdsResponses, aT as GoogleListAdsErrors, aU as GoogleListAudiencesData, aV as GoogleListAudiencesResponses, aW as GoogleListAudiencesErrors, aX as GoogleListCampaignCriteriaData, aY as GoogleListCampaignCriteriaResponses, aZ as GoogleListCampaignCriteriaErrors, a_ as GoogleListCampaignsData, a$ as GoogleListCampaignsResponses, b0 as GoogleListCampaignsErrors, b1 as GoogleListConversionActionsData, b2 as GoogleListConversionActionsResponses, b3 as GoogleListConversionActionsErrors, b4 as GoogleListConversionGoalsData, b5 as GoogleListConversionGoalsResponses, b6 as GoogleListConversionGoalsErrors, b7 as GoogleListConversionRequestsData, b8 as GoogleListConversionRequestsResponses, b9 as GoogleListConversionRequestsErrors, ba as GoogleListKeywordsData, bb as GoogleListKeywordsResponses, bc as GoogleListKeywordsErrors, bd as GooglePauseAdData, be as GooglePauseAdResponses, bf as GooglePauseAdErrors, bg as GooglePauseAdGroupData, bh as GooglePauseAdGroupResponses, bi as GooglePauseAdGroupErrors, bj as GooglePauseCampaignData, bk as GooglePauseCampaignResponses, bl as GooglePauseCampaignErrors, bm as GooglePauseKeywordData, bn as GooglePauseKeywordResponses, bo as GooglePauseKeywordErrors, bp as GoogleRemoveAdData, bq as GoogleRemoveAdResponses, br as GoogleRemoveAdErrors, bs as GoogleRemoveAdGroupData, bt as GoogleRemoveAdGroupResponses, bu as GoogleRemoveAdGroupErrors, bv as GoogleRemoveAdGroupCriterionData, bw as GoogleRemoveAdGroupCriterionResponses, bx as GoogleRemoveAdGroupCriterionErrors, by as GoogleRemoveBudgetData, bz as GoogleRemoveBudgetResponses, bA as GoogleRemoveBudgetErrors, bB as GoogleRemoveCampaignData, bC as GoogleRemoveCampaignResponses, bD as GoogleRemoveCampaignErrors, bE as GoogleRemoveCampaignCriterionData, bF as GoogleRemoveCampaignCriterionResponses, bG as GoogleRemoveCampaignCriterionErrors, bH as GoogleRemoveConversionActionData, bI as GoogleRemoveConversionActionResponses, bJ as GoogleRemoveConversionActionErrors, bK as GoogleRemoveKeywordData, bL as GoogleRemoveKeywordResponses, bM as GoogleRemoveKeywordErrors, bN as GoogleRunGaqlData, bO as GoogleRunGaqlResponses, bP as GoogleRunGaqlErrors, bQ as GoogleSearchGeoTargetsData, bR as GoogleSearchGeoTargetsResponses, bS as GoogleSearchGeoTargetsErrors, bT as GoogleSendConversionsData, bU as GoogleSendConversionsResponses, bV as GoogleSendConversionsErrors, bW as GoogleSetAdGroupBidsData, bX as GoogleSetAdGroupBidsResponses, bY as GoogleSetAdGroupBidsErrors, bZ as GoogleSetCampaignGeoSettingsData, b_ as GoogleSetCampaignGeoSettingsResponses, b$ as GoogleSetCampaignGeoSettingsErrors, c0 as GoogleSetCampaignTargetingSettingData, c1 as GoogleSetCampaignTargetingSettingResponses, c2 as GoogleSetCampaignTargetingSettingErrors, c3 as GoogleSetConversionGoalData, c4 as GoogleSetConversionGoalResponses, c5 as GoogleSetConversionGoalErrors, c6 as GoogleSetKeywordBidData, c7 as GoogleSetKeywordBidResponses, c8 as GoogleSetKeywordBidErrors, c9 as GoogleUpdateConversionActionData, ca as GoogleUpdateConversionActionResponses, cb as GoogleUpdateConversionActionErrors, cc as GoogleUploadImageAssetData, cd as GoogleUploadImageAssetResponses, ce as GoogleUploadImageAssetErrors, cf as LogsGetData, cg as LogsGetResponses, ch as LogsGetErrors, ci as LogsListData, cj as LogsListResponses, ck as LogsListErrors, cl as MediaAbortData, cm as MediaAbortResponses, cn as MediaAbortErrors, co as MediaCompleteData, cp as MediaCompleteResponses, cq as MediaCompleteErrors, cr as MediaCreateData, cs as MediaCreateResponses, ct as MediaCreateErrors, cu as MediaDeleteData, cv as MediaDeleteResponses, cw as MediaDeleteErrors, cx as MediaGetData, cy as MediaGetResponses, cz as MediaGetErrors, cA as MediaListData, cB as MediaListResponses, cC as MediaListErrors, cD as MediaListPartsData, cE as MediaListPartsResponses, cF as MediaListPartsErrors, cG as MediaSignPartData, cH as MediaSignPartResponses, cI as MediaSignPartErrors, cJ as MediaUpdateData, cK as MediaUpdateResponses, cL as MediaUpdateErrors, cM as MetaAccountData, cN as MetaAccountResponses, cO as MetaAccountErrors, cP as MetaAdData, cQ as MetaAdResponses, cR as MetaAdErrors, cS as MetaAdsData, cT as MetaAdsResponses, cU as MetaAdsErrors, cV as MetaAdsetData, cW as MetaAdsetResponses, cX as MetaAdsetErrors, cY as MetaAdsetsData, cZ as MetaAdsetsResponses, c_ as MetaAdsetsErrors, c$ as MetaCampaignData, d0 as MetaCampaignResponses, d1 as MetaCampaignErrors, d2 as MetaCampaignsData, d3 as MetaCampaignsResponses, d4 as MetaCampaignsErrors, d5 as MetaInsightsData, d6 as MetaInsightsResponses, d7 as MetaInsightsErrors, d8 as PostsCreateData, d9 as PostsCreateResponses, da as PostsCreateErrors, db as PostsDeleteData, dc as PostsDeleteResponses, dd as PostsDeleteErrors, de as PostsGetData, df as PostsGetResponses, dg as PostsGetErrors, dh as PostsListData, di as PostsListResponses, dj as PostsListErrors, dk as PostsUpdateData, dl as PostsUpdateResponses, dm as PostsUpdateErrors, dn as PostsValidateData, dp as PostsValidateResponses, dq as PostsValidateErrors, dr as ProfilesCreateData, ds as ProfilesCreateResponses, dt as ProfilesCreateErrors, du as ProfilesDeleteData, dv as ProfilesDeleteResponses, dw as ProfilesDeleteErrors, dx as ProfilesGetData, dy as ProfilesGetResponses, dz as ProfilesGetErrors, dA as ProfilesListData, dB as ProfilesListResponses, dC as ProfilesListErrors, dD as ProfilesUpdateData, dE as ProfilesUpdateResponses, dF as ProfilesUpdateErrors, dG as TiktokCreatorInfoData, dH as TiktokCreatorInfoResponses, dI as TiktokCreatorInfoErrors, dJ as TokensMintData, dK as TokensMintResponses, dL as TokensMintErrors, dM as WebhooksCreateEndpointData, dN as WebhooksCreateEndpointResponses, dO as WebhooksCreateEndpointErrors, dP as WebhooksCreatePortalData, dQ as WebhooksCreatePortalResponses, dR as WebhooksCreatePortalErrors, dS as WebhooksDeleteEndpointData, dT as WebhooksDeleteEndpointResponses, dU as WebhooksDeleteEndpointErrors, dV as WebhooksGetEndpointData, dW as WebhooksGetEndpointResponses, dX as WebhooksGetEndpointErrors, dY as WebhooksListEndpointsData, dZ as WebhooksListEndpointsResponses, d_ as WebhooksListEndpointsErrors, d$ as WebhooksListEventTypesData, e0 as WebhooksListEventTypesResponses, e1 as WebhooksListEventTypesErrors, e2 as WebhooksPingData, e3 as WebhooksPingResponses, e4 as WebhooksPingErrors, e5 as WebhooksUpdateEndpointData, e6 as WebhooksUpdateEndpointResponses, e7 as WebhooksUpdateEndpointErrors, e8 as ErrorCode, e9 as MediaGetResponse, ea as ConnectionsConnectResponse, eb as ConnectionsGetResponse, ec as ConnectionsListByProfileResponse, ed as MediaCreateResponse, ee as ConnectionsListAccountsResponse, ef as MediaListResponse, eg as PostsGetResponse, eh as PostsListResponse, ei as PostsValidateResponse, ej as ProfilesGetResponse, ek as ProfilesListResponse, el as TiktokCreatorInfoResponse, em as PostrunClient, en as GoogleAdTreeNode } from './types.gen-K4cuIpk3.cjs';
|
|
2
|
-
export {
|
|
1
|
+
import { T as TDataShape, O as Options$1, C as Client, a as ClientMeta, b as ConnectionsConnectData, R as RequestResult, c as ConnectionsConnectResponses, d as ConnectionsConnectErrors, e as ConnectionsDeleteData, f as ConnectionsDeleteResponses, g as ConnectionsDeleteErrors, h as ConnectionsGetData, i as ConnectionsGetResponses, j as ConnectionsGetErrors, k as ConnectionsListAccountsData, l as ConnectionsListAccountsResponses, m as ConnectionsListAccountsErrors, n as ConnectionsListByProfileData, o as ConnectionsListByProfileResponses, p as ConnectionsListByProfileErrors, q as ConnectionsSelectData, r as ConnectionsSelectResponses, s as ConnectionsSelectErrors, L as LogsGetData, t as LogsGetResponses, u as LogsGetErrors, v as LogsListData, w as LogsListResponses, x as LogsListErrors, M as MediaAbortData, y as MediaAbortResponses, z as MediaAbortErrors, A as MediaCompleteData, B as MediaCompleteResponses, D as MediaCompleteErrors, E as MediaCreateData, F as MediaCreateResponses, G as MediaCreateErrors, H as MediaDeleteData, I as MediaDeleteResponses, J as MediaDeleteErrors, K as MediaGetData, N as MediaGetResponses, P as MediaGetErrors, Q as MediaListData, S as MediaListResponses, U as MediaListErrors, V as MediaListPartsData, W as MediaListPartsResponses, X as MediaListPartsErrors, Y as MediaSignPartData, Z as MediaSignPartResponses, _ as MediaSignPartErrors, $ as MediaUpdateData, a0 as MediaUpdateResponses, a1 as MediaUpdateErrors, a2 as PostsCreateData, a3 as PostsCreateResponses, a4 as PostsCreateErrors, a5 as PostsDeleteData, a6 as PostsDeleteResponses, a7 as PostsDeleteErrors, a8 as PostsGetData, a9 as PostsGetResponses, aa as PostsGetErrors, ab as PostsListData, ac as PostsListResponses, ad as PostsListErrors, ae as PostsRetryData, af as PostsRetryResponses, ag as PostsRetryErrors, ah as PostsUpdateData, ai as PostsUpdateResponses, aj as PostsUpdateErrors, ak as PostsValidateData, al as PostsValidateResponses, am as PostsValidateErrors, an as ProfilesCreateData, ao as ProfilesCreateResponses, ap as ProfilesCreateErrors, aq as ProfilesDeleteData, ar as ProfilesDeleteResponses, as as ProfilesDeleteErrors, at as ProfilesGetData, au as ProfilesGetResponses, av as ProfilesGetErrors, aw as ProfilesListData, ax as ProfilesListResponses, ay as ProfilesListErrors, az as ProfilesUpdateData, aA as ProfilesUpdateResponses, aB as ProfilesUpdateErrors, aC as TiktokCreatorInfoData, aD as TiktokCreatorInfoResponses, aE as TiktokCreatorInfoErrors, aF as TokensMintData, aG as TokensMintResponses, aH as TokensMintErrors, aI as WebhooksCreateEndpointData, aJ as WebhooksCreateEndpointResponses, aK as WebhooksCreateEndpointErrors, aL as WebhooksCreatePortalData, aM as WebhooksCreatePortalResponses, aN as WebhooksCreatePortalErrors, aO as WebhooksDeleteEndpointData, aP as WebhooksDeleteEndpointResponses, aQ as WebhooksDeleteEndpointErrors, aR as WebhooksGetEndpointData, aS as WebhooksGetEndpointResponses, aT as WebhooksGetEndpointErrors, aU as WebhooksListEndpointsData, aV as WebhooksListEndpointsResponses, aW as WebhooksListEndpointsErrors, aX as WebhooksListEventTypesData, aY as WebhooksListEventTypesResponses, aZ as WebhooksListEventTypesErrors, a_ as WebhooksPingData, a$ as WebhooksPingResponses, b0 as WebhooksPingErrors, b1 as WebhooksUpdateEndpointData, b2 as WebhooksUpdateEndpointResponses, b3 as WebhooksUpdateEndpointErrors, b4 as ErrorCode, b5 as TiktokCreatorInfoResponse, b6 as MediaGetResponse, b7 as ConnectionsConnectResponse, b8 as ConnectionsGetResponse, b9 as ConnectionsListByProfileResponse, ba as MediaCreateResponse, bb as ConnectionsListAccountsResponse, bc as MediaListResponse, bd as PostsGetResponse, be as PostsListResponse, bf as PostsValidateResponse, bg as ProfilesGetResponse, bh as ProfilesListResponse, bi as PostrunClient } from './types.gen-DjaUEnXO.cjs';
|
|
2
|
+
export { bj as ClientOptions, bk as ConnectionsConnectError, bl as ConnectionsDeleteError, bm as ConnectionsDeleteResponse, bn as ConnectionsGetError, bo as ConnectionsListAccountsError, bp as ConnectionsListByProfileError, bq as ConnectionsSelectError, br as ConnectionsSelectResponse, bs as CreatePostBody, bt as DiscoverableAccount, bu as ErrorSource, bv as IdempotencyKey, bw as LogsGetError, bx as LogsGetResponse, by as LogsListError, bz as LogsListResponse, bA as Media, bB as MediaAbortError, bC as MediaAbortResponse, bD as MediaCompleteError, bE as MediaCompleteResponse, bF as MediaCreateError, bG as MediaDeleteError, bH as MediaDeleteResponse, bI as MediaGetError, bJ as MediaListError, bK as MediaListPartsError, bL as MediaListPartsResponse, bM as MediaSignPartError, bN as MediaSignPartResponse, bO as MediaStage, bP as MediaUpdateError, bQ as MediaUpdateResponse, bR as PostVariantStatus, bS as PostWriteResult, bT as PostrunClientOptions, bU as PostsCreateError, bV as PostsCreateResponse, bW as PostsDeleteError, bX as PostsDeleteResponse, bY as PostsGetError, bZ as PostsListError, b_ as PostsRetryError, b$ as PostsRetryResponse, c0 as PostsUpdateError, c1 as PostsUpdateResponse, c2 as PostsValidateError, c3 as ProfilesCreateError, c4 as ProfilesCreateResponse, c5 as ProfilesDeleteError, c6 as ProfilesDeleteResponse, c7 as ProfilesGetError, c8 as ProfilesListError, c9 as ProfilesUpdateError, ca as ProfilesUpdateResponse, cb as TiktokCreatorInfoError, cc as TokensMintError, cd as TokensMintResponse, ce as WebhooksCreateEndpointError, cf as WebhooksCreateEndpointResponse, cg as WebhooksCreatePortalError, ch as WebhooksCreatePortalResponse, ci as WebhooksDeleteEndpointError, cj as WebhooksDeleteEndpointResponse, ck as WebhooksGetEndpointError, cl as WebhooksGetEndpointResponse, cm as WebhooksListEndpointsError, cn as WebhooksListEndpointsResponse, co as WebhooksListEventTypesError, cp as WebhooksListEventTypesResponse, cq as WebhooksPingError, cr as WebhooksPingResponse, cs as WebhooksUpdateEndpointError, ct as WebhooksUpdateEndpointResponse, cu as createPostrunClient } from './types.gen-DjaUEnXO.cjs';
|
|
3
3
|
import * as z from 'zod';
|
|
4
4
|
|
|
5
5
|
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
|
|
@@ -34,7 +34,7 @@ declare const profilesCreate: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
34
34
|
/**
|
|
35
35
|
* Delete a profile
|
|
36
36
|
*
|
|
37
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `profiles:
|
|
37
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `profiles:delete` scoped to the target profile.
|
|
38
38
|
*
|
|
39
39
|
* Deletes a profile. The profile must have no connections — delete its connections first (and a connection in turn cannot be deleted while a post still publishes through it).
|
|
40
40
|
*/
|
|
@@ -66,7 +66,7 @@ declare const connectionsListByProfile: <ThrowOnError extends boolean = true>(op
|
|
|
66
66
|
/**
|
|
67
67
|
* Delete a connection
|
|
68
68
|
*
|
|
69
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `connections:
|
|
69
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `connections:delete` scoped to the profile that owns the connection.
|
|
70
70
|
*
|
|
71
71
|
* Disconnects a connection. Returns a deletion marker; returns 404 if it does not exist in your account. Disconnect is unconditional — any scheduled posts that target this connection are not blocked; they fail gracefully at publish time with a `connection_removed` error until you reconnect and reschedule.
|
|
72
72
|
*/
|
|
@@ -84,7 +84,7 @@ declare const connectionsGet: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
84
84
|
*
|
|
85
85
|
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `connections:write` scoped to the profile that owns the connection.
|
|
86
86
|
*
|
|
87
|
-
* Activates a pending connection by choosing which external account (e.g. which
|
|
87
|
+
* Activates a pending connection by choosing which external account (e.g. which Facebook Page) it uses. The account must be one reachable through the connection’s OAuth grant; its canonical name + currency are resolved server-side from discovery, so the stored display values can’t be spoofed by the caller.
|
|
88
88
|
*/
|
|
89
89
|
declare const connectionsSelect: <ThrowOnError extends boolean = true>(options: Options<ConnectionsSelectData, ThrowOnError>) => RequestResult<ConnectionsSelectResponses, ConnectionsSelectErrors, ThrowOnError>;
|
|
90
90
|
/**
|
|
@@ -92,7 +92,7 @@ declare const connectionsSelect: <ThrowOnError extends boolean = true>(options:
|
|
|
92
92
|
*
|
|
93
93
|
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `connections:read` scoped to the profile that owns the connection.
|
|
94
94
|
*
|
|
95
|
-
* Lists the external
|
|
95
|
+
* Lists the external accounts reachable through this connection’s OAuth grant — the picker shown after OAuth, while the connection is still pending account selection. Returns 404 if the connection does not exist in your account, and 501 if account discovery is not yet supported for the connection’s platform.
|
|
96
96
|
*/
|
|
97
97
|
declare const connectionsListAccounts: <ThrowOnError extends boolean = true>(options: Options<ConnectionsListAccountsData, ThrowOnError>) => RequestResult<ConnectionsListAccountsResponses, ConnectionsListAccountsErrors, ThrowOnError>;
|
|
98
98
|
/**
|
|
@@ -122,7 +122,7 @@ declare const mediaCreate: <ThrowOnError extends boolean = true>(options: Option
|
|
|
122
122
|
/**
|
|
123
123
|
* Delete media
|
|
124
124
|
*
|
|
125
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `media:
|
|
125
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `media:delete` scoped to the profile that owns the media asset.
|
|
126
126
|
*
|
|
127
127
|
* Deletes a media asset and its stored renditions.
|
|
128
128
|
*/
|
|
@@ -194,7 +194,7 @@ declare const postsCreate: <ThrowOnError extends boolean = true>(options: Option
|
|
|
194
194
|
/**
|
|
195
195
|
* Delete a post
|
|
196
196
|
*
|
|
197
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `posts:
|
|
197
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `posts:delete` scoped to the profile that owns the post.
|
|
198
198
|
*
|
|
199
199
|
* Deletes a post and its variants. Returns a deletion marker; 404 if it does not exist in your account. Already-published posts are not retracted from the platform.
|
|
200
200
|
*/
|
|
@@ -216,547 +216,27 @@ declare const postsGet: <ThrowOnError extends boolean = true>(options: Options<P
|
|
|
216
216
|
*/
|
|
217
217
|
declare const postsUpdate: <ThrowOnError extends boolean = true>(options: Options<PostsUpdateData, ThrowOnError>) => RequestResult<PostsUpdateResponses, PostsUpdateErrors, ThrowOnError>;
|
|
218
218
|
/**
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `posts:read` scoped to the target profile.
|
|
222
|
-
*
|
|
223
|
-
* Runs the exact ownership + publish-readiness checks the create path runs under dry_run, with no side effects. Returns a per-issue verdict (`publishable` + `issues[]`) on 200; a reference to a connection/media outside the profile is a typed 422.
|
|
224
|
-
*/
|
|
225
|
-
declare const postsValidate: <ThrowOnError extends boolean = true>(options: Options<PostsValidateData, ThrowOnError>) => RequestResult<PostsValidateResponses, PostsValidateErrors, ThrowOnError>;
|
|
226
|
-
/**
|
|
227
|
-
* Retrieve the Meta ad account
|
|
228
|
-
*
|
|
229
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
230
|
-
*
|
|
231
|
-
* Retrieves the Meta ad account this connection is linked to — name, currency, status, and spend. Monetary fields are in the account currency’s minor units.
|
|
232
|
-
*/
|
|
233
|
-
declare const metaAccount: <ThrowOnError extends boolean = true>(options: Options<MetaAccountData, ThrowOnError>) => RequestResult<MetaAccountResponses, MetaAccountErrors, ThrowOnError>;
|
|
234
|
-
/**
|
|
235
|
-
* Retrieve Meta ad insights
|
|
236
|
-
*
|
|
237
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
238
|
-
*
|
|
239
|
-
* Retrieves performance insights for the connection’s Meta ad account, aggregated at the chosen `level` over a date window. Metric values are strings, in the account currency’s units.
|
|
240
|
-
*/
|
|
241
|
-
declare const metaInsights: <ThrowOnError extends boolean = true>(options: Options<MetaInsightsData, ThrowOnError>) => RequestResult<MetaInsightsResponses, MetaInsightsErrors, ThrowOnError>;
|
|
242
|
-
/**
|
|
243
|
-
* List Meta campaigns
|
|
244
|
-
*
|
|
245
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
246
|
-
*
|
|
247
|
-
* Lists the campaigns under the connection’s Meta ad account, with each campaign’s status, objective, and budgets (budgets in the account currency’s minor units).
|
|
248
|
-
*/
|
|
249
|
-
declare const metaCampaigns: <ThrowOnError extends boolean = true>(options: Options<MetaCampaignsData, ThrowOnError>) => RequestResult<MetaCampaignsResponses, MetaCampaignsErrors, ThrowOnError>;
|
|
250
|
-
/**
|
|
251
|
-
* Retrieve a Meta campaign
|
|
252
|
-
*
|
|
253
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
254
|
-
*
|
|
255
|
-
* Retrieves a single campaign under the connection’s Meta ad account by its campaign id — status, objective, and budgets.
|
|
256
|
-
*/
|
|
257
|
-
declare const metaCampaign: <ThrowOnError extends boolean = true>(options: Options<MetaCampaignData, ThrowOnError>) => RequestResult<MetaCampaignResponses, MetaCampaignErrors, ThrowOnError>;
|
|
258
|
-
/**
|
|
259
|
-
* List Meta ad sets
|
|
260
|
-
*
|
|
261
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
262
|
-
*
|
|
263
|
-
* Lists the ad sets under the connection’s Meta ad account, with each ad set’s status, parent campaign, budgets, and optimization (budgets in the account currency’s minor units).
|
|
264
|
-
*/
|
|
265
|
-
declare const metaAdsets: <ThrowOnError extends boolean = true>(options: Options<MetaAdsetsData, ThrowOnError>) => RequestResult<MetaAdsetsResponses, MetaAdsetsErrors, ThrowOnError>;
|
|
266
|
-
/**
|
|
267
|
-
* Retrieve a Meta ad set
|
|
268
|
-
*
|
|
269
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
270
|
-
*
|
|
271
|
-
* Retrieves a single ad set under the connection’s Meta ad account by its ad set id — status, parent campaign, budgets, and optimization.
|
|
272
|
-
*/
|
|
273
|
-
declare const metaAdset: <ThrowOnError extends boolean = true>(options: Options<MetaAdsetData, ThrowOnError>) => RequestResult<MetaAdsetResponses, MetaAdsetErrors, ThrowOnError>;
|
|
274
|
-
/**
|
|
275
|
-
* List Meta ads
|
|
276
|
-
*
|
|
277
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
278
|
-
*
|
|
279
|
-
* Lists the ads under the connection’s Meta ad account, with each ad’s status, parent ad set and campaign ids, and timestamps.
|
|
280
|
-
*/
|
|
281
|
-
declare const metaAds: <ThrowOnError extends boolean = true>(options: Options<MetaAdsData, ThrowOnError>) => RequestResult<MetaAdsResponses, MetaAdsErrors, ThrowOnError>;
|
|
282
|
-
/**
|
|
283
|
-
* Retrieve a Meta ad
|
|
284
|
-
*
|
|
285
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
286
|
-
*
|
|
287
|
-
* Retrieves a single ad under the connection’s Meta ad account by its ad id — status, parent ad set and campaign ids, and timestamps.
|
|
288
|
-
*/
|
|
289
|
-
declare const metaAd: <ThrowOnError extends boolean = true>(options: Options<MetaAdData, ThrowOnError>) => RequestResult<MetaAdResponses, MetaAdErrors, ThrowOnError>;
|
|
290
|
-
/**
|
|
291
|
-
* Retrieve the connected Google Ads account
|
|
292
|
-
*
|
|
293
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
294
|
-
*
|
|
295
|
-
* Returns the Google Ads account (the `customer` resource) backing this connection — id, descriptive name, currency, time zone, status, and whether it is a manager (MCC) or test account.
|
|
296
|
-
*/
|
|
297
|
-
declare const googleGetAccount: <ThrowOnError extends boolean = true>(options: Options<GoogleGetAccountData, ThrowOnError>) => RequestResult<GoogleGetAccountResponses, GoogleGetAccountErrors, ThrowOnError>;
|
|
298
|
-
/**
|
|
299
|
-
* Edit Google Ads account URL settings
|
|
300
|
-
*
|
|
301
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
302
|
-
*
|
|
303
|
-
* Updates the account-level (customer) URL tracking settings — tracking_url_template and final_url_suffix. A campaign-level template overrides the account one. Pass `dry_run: true` to validate against Google without applying.
|
|
304
|
-
*/
|
|
305
|
-
declare const googleEditAccount: <ThrowOnError extends boolean = true>(options: Options<GoogleEditAccountData, ThrowOnError>) => RequestResult<GoogleEditAccountResponses, GoogleEditAccountErrors, ThrowOnError>;
|
|
306
|
-
/**
|
|
307
|
-
* Google Ads performance insights
|
|
308
|
-
*
|
|
309
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
310
|
-
*
|
|
311
|
-
* Performance metrics for the connection’s account, at a chosen level (account / campaign / ad group / ad / keyword), for a date range, with optional breakdowns. Leaf levels (ad / keyword) require an `ad_group_id`; campaign / ad group accept an optional `campaign_id`. Each row carries its `parent_id`, so the tree is assemblable. The flagship cross-checked read; use `/gaql` for anything outside this shape.
|
|
312
|
-
*/
|
|
313
|
-
declare const googleGetInsights: <ThrowOnError extends boolean = true>(options: Options<GoogleGetInsightsData, ThrowOnError>) => RequestResult<GoogleGetInsightsResponses, GoogleGetInsightsErrors, ThrowOnError>;
|
|
314
|
-
/**
|
|
315
|
-
* Google Ads campaign tree
|
|
316
|
-
*
|
|
317
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
318
|
-
*
|
|
319
|
-
* 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).
|
|
320
|
-
*/
|
|
321
|
-
declare const googleGetAdTree: <ThrowOnError extends boolean = true>(options: Options<GoogleGetAdTreeData, ThrowOnError>) => RequestResult<GoogleGetAdTreeResponses, GoogleGetAdTreeErrors, ThrowOnError>;
|
|
322
|
-
/**
|
|
323
|
-
* Run a raw GAQL query
|
|
324
|
-
*
|
|
325
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
326
|
-
*
|
|
327
|
-
* Runs a raw Google Ads Query Language (GAQL) query against the connection’s account and returns the native rows. Read-only (GAQL only does `SELECT`). The power-user escape hatch beneath the typed reads.
|
|
328
|
-
*/
|
|
329
|
-
declare const googleRunGaql: <ThrowOnError extends boolean = true>(options: Options<GoogleRunGaqlData, ThrowOnError>) => RequestResult<GoogleRunGaqlResponses, GoogleRunGaqlErrors, ThrowOnError>;
|
|
330
|
-
/**
|
|
331
|
-
* Create a Google Ads campaign budget
|
|
332
|
-
*
|
|
333
|
-
* **Authentication.** Secret `pr_` API key only — this endpoint cannot be called with a browser token.
|
|
334
|
-
*
|
|
335
|
-
* Creates a standalone daily campaign budget (the `campaign_budget` resource) on the connection’s account. Money write — secret-key-only. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name to chain into a campaign.
|
|
336
|
-
*/
|
|
337
|
-
declare const googleCreateBudget: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateBudgetData, ThrowOnError>) => RequestResult<GoogleCreateBudgetResponses, GoogleCreateBudgetErrors, ThrowOnError>;
|
|
338
|
-
/**
|
|
339
|
-
* Edit a Google Ads campaign budget
|
|
340
|
-
*
|
|
341
|
-
* **Authentication.** Secret `pr_` API key only — this endpoint cannot be called with a browser token.
|
|
342
|
-
*
|
|
343
|
-
* Updates a budget’s daily amount (in micros) by numeric id. Money write — secret-key-only. Pass `dry_run: true` to validate against Google without applying.
|
|
344
|
-
*/
|
|
345
|
-
declare const googleEditBudget: <ThrowOnError extends boolean = true>(options: Options<GoogleEditBudgetData, ThrowOnError>) => RequestResult<GoogleEditBudgetResponses, GoogleEditBudgetErrors, ThrowOnError>;
|
|
346
|
-
/**
|
|
347
|
-
* Remove a Google Ads campaign budget
|
|
348
|
-
*
|
|
349
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
350
|
-
*
|
|
351
|
-
* Removes a campaign budget by numeric id (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
352
|
-
*/
|
|
353
|
-
declare const googleRemoveBudget: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveBudgetData, ThrowOnError>) => RequestResult<GoogleRemoveBudgetResponses, GoogleRemoveBudgetErrors, ThrowOnError>;
|
|
354
|
-
/**
|
|
355
|
-
* List Google Ads campaigns
|
|
356
|
-
*
|
|
357
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
358
|
-
*
|
|
359
|
-
* Returns the campaigns (the `campaign` resource) on the connection’s account — id, name, status, advertising channel type, and bidding strategy type.
|
|
360
|
-
*/
|
|
361
|
-
declare const googleListCampaigns: <ThrowOnError extends boolean = true>(options: Options<GoogleListCampaignsData, ThrowOnError>) => RequestResult<GoogleListCampaignsResponses, GoogleListCampaignsErrors, ThrowOnError>;
|
|
362
|
-
/**
|
|
363
|
-
* Create a Google Ads campaign
|
|
364
|
-
*
|
|
365
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
366
|
-
*
|
|
367
|
-
* Creates a Search or Display campaign (the `campaign` resource) on the connection’s account, attached to an existing budget. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
368
|
-
*/
|
|
369
|
-
declare const googleCreateCampaign: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateCampaignData, ThrowOnError>) => RequestResult<GoogleCreateCampaignResponses, GoogleCreateCampaignErrors, ThrowOnError>;
|
|
370
|
-
/**
|
|
371
|
-
* Retrieve a Google Ads campaign
|
|
372
|
-
*
|
|
373
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
374
|
-
*
|
|
375
|
-
* Returns a single campaign (the `campaign` resource) by its numeric id on the connection’s account — id, name, status, advertising channel type, and bidding strategy type.
|
|
376
|
-
*/
|
|
377
|
-
declare const googleGetCampaign: <ThrowOnError extends boolean = true>(options: Options<GoogleGetCampaignData, ThrowOnError>) => RequestResult<GoogleGetCampaignResponses, GoogleGetCampaignErrors, ThrowOnError>;
|
|
378
|
-
/**
|
|
379
|
-
* Edit a Google Ads campaign
|
|
380
|
-
*
|
|
381
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
382
|
-
*
|
|
383
|
-
* Updates a campaign’s non-money fields — its name and URL tracking settings (tracking_url_template, final_url_suffix, url_custom_parameters) — by numeric id. Status has its own pause/enable endpoints; bids are a separate money write. Pass `dry_run: true` to validate against Google without applying.
|
|
384
|
-
*/
|
|
385
|
-
declare const googleEditCampaign: <ThrowOnError extends boolean = true>(options: Options<GoogleEditCampaignData, ThrowOnError>) => RequestResult<GoogleEditCampaignResponses, GoogleEditCampaignErrors, ThrowOnError>;
|
|
386
|
-
/**
|
|
387
|
-
* Remove a Google Ads campaign
|
|
388
|
-
*
|
|
389
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
390
|
-
*
|
|
391
|
-
* Removes a campaign by numeric id (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
392
|
-
*/
|
|
393
|
-
declare const googleRemoveCampaign: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveCampaignData, ThrowOnError>) => RequestResult<GoogleRemoveCampaignResponses, GoogleRemoveCampaignErrors, ThrowOnError>;
|
|
394
|
-
/**
|
|
395
|
-
* Pause a Google Ads campaign
|
|
396
|
-
*
|
|
397
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
398
|
-
*
|
|
399
|
-
* Pauses a campaign by its numeric id (reversible). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
400
|
-
*/
|
|
401
|
-
declare const googlePauseCampaign: <ThrowOnError extends boolean = true>(options: Options<GooglePauseCampaignData, ThrowOnError>) => RequestResult<GooglePauseCampaignResponses, GooglePauseCampaignErrors, ThrowOnError>;
|
|
402
|
-
/**
|
|
403
|
-
* Enable a Google Ads campaign
|
|
404
|
-
*
|
|
405
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
406
|
-
*
|
|
407
|
-
* Enables (resumes) a campaign by its numeric id. Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
408
|
-
*/
|
|
409
|
-
declare const googleEnableCampaign: <ThrowOnError extends boolean = true>(options: Options<GoogleEnableCampaignData, ThrowOnError>) => RequestResult<GoogleEnableCampaignResponses, GoogleEnableCampaignErrors, ThrowOnError>;
|
|
410
|
-
/**
|
|
411
|
-
* Search Google Ads geo targets
|
|
412
|
-
*
|
|
413
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
414
|
-
*
|
|
415
|
-
* Resolves a free-text location name (e.g. "New York") to matching geo target constants — each with id, name, canonical name, country code, target type, and status. Use a result’s `resource_name` (e.g. `geoTargetConstants/2840`), NOT the bare `id`, as the `geo_target_constant` of a location criterion.
|
|
416
|
-
*/
|
|
417
|
-
declare const googleSearchGeoTargets: <ThrowOnError extends boolean = true>(options: Options<GoogleSearchGeoTargetsData, ThrowOnError>) => RequestResult<GoogleSearchGeoTargetsResponses, GoogleSearchGeoTargetsErrors, ThrowOnError>;
|
|
418
|
-
/**
|
|
419
|
-
* List Google Ads campaign targeting criteria
|
|
420
|
-
*
|
|
421
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
422
|
-
*
|
|
423
|
-
* Lists a campaign’s targeting criteria. LOCATION and LANGUAGE are fully modelled (geo_target_constant / language_constant, status, negative flag); any other criterion type is returned as { type, criterion_id }.
|
|
424
|
-
*/
|
|
425
|
-
declare const googleListCampaignCriteria: <ThrowOnError extends boolean = true>(options: Options<GoogleListCampaignCriteriaData, ThrowOnError>) => RequestResult<GoogleListCampaignCriteriaResponses, GoogleListCampaignCriteriaErrors, ThrowOnError>;
|
|
426
|
-
/**
|
|
427
|
-
* Add a Google Ads campaign targeting criterion
|
|
428
|
-
*
|
|
429
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
430
|
-
*
|
|
431
|
-
* Adds a geo (location) or language targeting criterion to a campaign. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
432
|
-
*/
|
|
433
|
-
declare const googleCreateCampaignCriterion: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateCampaignCriterionData, ThrowOnError>) => RequestResult<GoogleCreateCampaignCriterionResponses, GoogleCreateCampaignCriterionErrors, ThrowOnError>;
|
|
434
|
-
/**
|
|
435
|
-
* Remove a Google Ads campaign targeting criterion
|
|
436
|
-
*
|
|
437
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
438
|
-
*
|
|
439
|
-
* Removes a campaign targeting criterion by its criterion id (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
440
|
-
*/
|
|
441
|
-
declare const googleRemoveCampaignCriterion: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveCampaignCriterionData, ThrowOnError>) => RequestResult<GoogleRemoveCampaignCriterionResponses, GoogleRemoveCampaignCriterionErrors, ThrowOnError>;
|
|
442
|
-
/**
|
|
443
|
-
* Set a Google Ads campaign’s geo target type
|
|
444
|
-
*
|
|
445
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
446
|
-
*
|
|
447
|
-
* Sets a campaign’s geo target type — presence (people in the location) vs presence-or-interest (also people interested in it) — for positive and/or excluded locations. Pass `dry_run: true` to validate without applying.
|
|
448
|
-
*/
|
|
449
|
-
declare const googleSetCampaignGeoSettings: <ThrowOnError extends boolean = true>(options: Options<GoogleSetCampaignGeoSettingsData, ThrowOnError>) => RequestResult<GoogleSetCampaignGeoSettingsResponses, GoogleSetCampaignGeoSettingsErrors, ThrowOnError>;
|
|
450
|
-
/**
|
|
451
|
-
* List Google Ads ad groups
|
|
452
|
-
*
|
|
453
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
454
|
-
*
|
|
455
|
-
* 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).
|
|
456
|
-
*/
|
|
457
|
-
declare const googleListAdGroups: <ThrowOnError extends boolean = true>(options: Options<GoogleListAdGroupsData, ThrowOnError>) => RequestResult<GoogleListAdGroupsResponses, GoogleListAdGroupsErrors, ThrowOnError>;
|
|
458
|
-
/**
|
|
459
|
-
* Create a Google Ads ad group
|
|
460
|
-
*
|
|
461
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
462
|
-
*
|
|
463
|
-
* Creates an ad group (the `ad_group` resource) under a campaign on the connection’s account. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name to chain into ads and keywords.
|
|
464
|
-
*/
|
|
465
|
-
declare const googleCreateAdGroup: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateAdGroupData, ThrowOnError>) => RequestResult<GoogleCreateAdGroupResponses, GoogleCreateAdGroupErrors, ThrowOnError>;
|
|
466
|
-
/**
|
|
467
|
-
* Retrieve a Google Ads ad group
|
|
468
|
-
*
|
|
469
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
470
|
-
*
|
|
471
|
-
* Returns a single ad group by its numeric id from the Google Ads account backing this connection — id, name, status, type, and parent campaign.
|
|
472
|
-
*/
|
|
473
|
-
declare const googleGetAdGroup: <ThrowOnError extends boolean = true>(options: Options<GoogleGetAdGroupData, ThrowOnError>) => RequestResult<GoogleGetAdGroupResponses, GoogleGetAdGroupErrors, ThrowOnError>;
|
|
474
|
-
/**
|
|
475
|
-
* Edit a Google Ads ad group
|
|
476
|
-
*
|
|
477
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
478
|
-
*
|
|
479
|
-
* Updates an ad group’s non-money fields (its name) by numeric id. Status has its own pause/enable endpoints; bids are a separate money write. Pass `dry_run: true` to validate without applying.
|
|
480
|
-
*/
|
|
481
|
-
declare const googleEditAdGroup: <ThrowOnError extends boolean = true>(options: Options<GoogleEditAdGroupData, ThrowOnError>) => RequestResult<GoogleEditAdGroupResponses, GoogleEditAdGroupErrors, ThrowOnError>;
|
|
482
|
-
/**
|
|
483
|
-
* Set a Google Ads ad group’s bids
|
|
484
|
-
*
|
|
485
|
-
* **Authentication.** Secret `pr_` API key only — this endpoint cannot be called with a browser token.
|
|
486
|
-
*
|
|
487
|
-
* Sets an ad group’s manual bids (cpc/cpm/target CPA in micros, target ROAS as a ratio) by numeric id. Money write — secret-key-only. Pass `dry_run: true` to validate without applying.
|
|
488
|
-
*/
|
|
489
|
-
declare const googleSetAdGroupBids: <ThrowOnError extends boolean = true>(options: Options<GoogleSetAdGroupBidsData, ThrowOnError>) => RequestResult<GoogleSetAdGroupBidsResponses, GoogleSetAdGroupBidsErrors, ThrowOnError>;
|
|
490
|
-
/**
|
|
491
|
-
* Remove a Google Ads ad group
|
|
492
|
-
*
|
|
493
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
494
|
-
*
|
|
495
|
-
* Removes an ad group by numeric id (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
496
|
-
*/
|
|
497
|
-
declare const googleRemoveAdGroup: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveAdGroupData, ThrowOnError>) => RequestResult<GoogleRemoveAdGroupResponses, GoogleRemoveAdGroupErrors, ThrowOnError>;
|
|
498
|
-
/**
|
|
499
|
-
* Pause a Google Ads ad group
|
|
500
|
-
*
|
|
501
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
502
|
-
*
|
|
503
|
-
* Pauses an ad group by its numeric id (reversible). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
504
|
-
*/
|
|
505
|
-
declare const googlePauseAdGroup: <ThrowOnError extends boolean = true>(options: Options<GooglePauseAdGroupData, ThrowOnError>) => RequestResult<GooglePauseAdGroupResponses, GooglePauseAdGroupErrors, ThrowOnError>;
|
|
506
|
-
/**
|
|
507
|
-
* Enable a Google Ads ad group
|
|
508
|
-
*
|
|
509
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
510
|
-
*
|
|
511
|
-
* Enables (resumes) an ad group by its numeric id. Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
512
|
-
*/
|
|
513
|
-
declare const googleEnableAdGroup: <ThrowOnError extends boolean = true>(options: Options<GoogleEnableAdGroupData, ThrowOnError>) => RequestResult<GoogleEnableAdGroupResponses, GoogleEnableAdGroupErrors, ThrowOnError>;
|
|
514
|
-
/**
|
|
515
|
-
* List Google Ads ad-group targeting criteria
|
|
516
|
-
*
|
|
517
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
518
|
-
*
|
|
519
|
-
* Lists an ad group’s targeting criteria. The four demographics (AGE_RANGE, GENDER, INCOME_RANGE, PARENTAL_STATUS) are fully modelled (with their value, status, and negative flag); any other criterion type (e.g. KEYWORD) is returned as { type, criterion_id }.
|
|
520
|
-
*/
|
|
521
|
-
declare const googleListAdGroupCriteria: <ThrowOnError extends boolean = true>(options: Options<GoogleListAdGroupCriteriaData, ThrowOnError>) => RequestResult<GoogleListAdGroupCriteriaResponses, GoogleListAdGroupCriteriaErrors, ThrowOnError>;
|
|
522
|
-
/**
|
|
523
|
-
* Add a Google Ads ad-group targeting criterion
|
|
524
|
-
*
|
|
525
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
526
|
-
*
|
|
527
|
-
* Adds a demographic (age range, gender, income range, or parental status) or audience (user list, audience, or custom audience) targeting criterion to an ad group. Audience criteria reference the `resource_name` returned by the audiences discovery read (`GET .../audiences`). Set `negative: true` to exclude instead of target. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
528
|
-
*/
|
|
529
|
-
declare const googleCreateAdGroupCriterion: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateAdGroupCriterionData, ThrowOnError>) => RequestResult<GoogleCreateAdGroupCriterionResponses, GoogleCreateAdGroupCriterionErrors, ThrowOnError>;
|
|
530
|
-
/**
|
|
531
|
-
* Remove a Google Ads ad-group targeting criterion
|
|
532
|
-
*
|
|
533
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
534
|
-
*
|
|
535
|
-
* Removes an ad-group targeting criterion by its criterion id (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
536
|
-
*/
|
|
537
|
-
declare const googleRemoveAdGroupCriterion: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveAdGroupCriterionData, ThrowOnError>) => RequestResult<GoogleRemoveAdGroupCriterionResponses, GoogleRemoveAdGroupCriterionErrors, ThrowOnError>;
|
|
538
|
-
/**
|
|
539
|
-
* List Google Ads audiences available to target
|
|
540
|
-
*
|
|
541
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
542
|
-
*
|
|
543
|
-
* Lists the user lists and audiences available to attach to an ad group, each with the `resource_name` you pass as the user_list / audience of an ad-group audience criterion. Optional `q` filters by name; `kind` narrows to one audience kind.
|
|
544
|
-
*/
|
|
545
|
-
declare const googleListAudiences: <ThrowOnError extends boolean = true>(options: Options<GoogleListAudiencesData, ThrowOnError>) => RequestResult<GoogleListAudiencesResponses, GoogleListAudiencesErrors, ThrowOnError>;
|
|
546
|
-
/**
|
|
547
|
-
* Set a Google Ads campaign’s targeting setting
|
|
548
|
-
*
|
|
549
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
550
|
-
*
|
|
551
|
-
* Sets a campaign’s targeting setting for one dimension (e.g. AUDIENCE): Observation (`bid_only: true` — does NOT narrow reach) vs Targeting (`bid_only: false` — narrows reach to the targeted criteria). Campaign + dimension scoped: shared by every audience criterion in the campaign. Pass `dry_run: true` to validate without applying. Note: Google rejects setting this on a campaign whose ad group already has a targeting setting (and vice versa).
|
|
552
|
-
*/
|
|
553
|
-
declare const googleSetCampaignTargetingSetting: <ThrowOnError extends boolean = true>(options: Options<GoogleSetCampaignTargetingSettingData, ThrowOnError>) => RequestResult<GoogleSetCampaignTargetingSettingResponses, GoogleSetCampaignTargetingSettingErrors, ThrowOnError>;
|
|
554
|
-
/**
|
|
555
|
-
* List Google Ads ads
|
|
556
|
-
*
|
|
557
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
558
|
-
*
|
|
559
|
-
* 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).
|
|
560
|
-
*/
|
|
561
|
-
declare const googleListAds: <ThrowOnError extends boolean = true>(options: Options<GoogleListAdsData, ThrowOnError>) => RequestResult<GoogleListAdsResponses, GoogleListAdsErrors, ThrowOnError>;
|
|
562
|
-
/**
|
|
563
|
-
* Create a Google Ads responsive search ad
|
|
564
|
-
*
|
|
565
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
566
|
-
*
|
|
567
|
-
* Creates a Responsive Search Ad (the `ad_group_ad` resource, inline text — no image assets) under an ad group on the connection’s account. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
568
|
-
*/
|
|
569
|
-
declare const googleCreateAd: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateAdData, ThrowOnError>) => RequestResult<GoogleCreateAdResponses, GoogleCreateAdErrors, ThrowOnError>;
|
|
570
|
-
/**
|
|
571
|
-
* Retrieve a Google Ads ad
|
|
572
|
-
*
|
|
573
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
574
|
-
*
|
|
575
|
-
* Returns a single ad (the `ad_group_ad` resource) by its composite id ({ad_group_id}~{ad_id}) on the connection’s account — id, name, creative type, serving status, and the owning ad group.
|
|
576
|
-
*/
|
|
577
|
-
declare const googleGetAd: <ThrowOnError extends boolean = true>(options: Options<GoogleGetAdData, ThrowOnError>) => RequestResult<GoogleGetAdResponses, GoogleGetAdErrors, ThrowOnError>;
|
|
578
|
-
/**
|
|
579
|
-
* Create a Google Ads responsive display ad
|
|
580
|
-
*
|
|
581
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
582
|
-
*
|
|
583
|
-
* Creates a Responsive Display Ad (the `ad_group_ad` resource) under a Display ad group on the connection’s account, assembled from already-uploaded image-asset resource_names (upload them first via POST /v1/google/{connection_id}/assets). Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
584
|
-
*/
|
|
585
|
-
declare const googleCreateDisplayAd: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateDisplayAdData, ThrowOnError>) => RequestResult<GoogleCreateDisplayAdResponses, GoogleCreateDisplayAdErrors, ThrowOnError>;
|
|
586
|
-
/**
|
|
587
|
-
* Remove a Google Ads ad
|
|
588
|
-
*
|
|
589
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
590
|
-
*
|
|
591
|
-
* Removes an ad (an `ad_group_ad`) by its composite id ({ad_group_id}~{ad_id}) (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
592
|
-
*/
|
|
593
|
-
declare const googleRemoveAd: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveAdData, ThrowOnError>) => RequestResult<GoogleRemoveAdResponses, GoogleRemoveAdErrors, ThrowOnError>;
|
|
594
|
-
/**
|
|
595
|
-
* Pause a Google Ads ad
|
|
596
|
-
*
|
|
597
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
598
|
-
*
|
|
599
|
-
* Pauses an ad by its composite id ({ad_group_id}~{ad_id}) (reversible). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
600
|
-
*/
|
|
601
|
-
declare const googlePauseAd: <ThrowOnError extends boolean = true>(options: Options<GooglePauseAdData, ThrowOnError>) => RequestResult<GooglePauseAdResponses, GooglePauseAdErrors, ThrowOnError>;
|
|
602
|
-
/**
|
|
603
|
-
* Enable a Google Ads ad
|
|
604
|
-
*
|
|
605
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
606
|
-
*
|
|
607
|
-
* Enables (resumes) an ad by its composite id ({ad_group_id}~{ad_id}). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
608
|
-
*/
|
|
609
|
-
declare const googleEnableAd: <ThrowOnError extends boolean = true>(options: Options<GoogleEnableAdData, ThrowOnError>) => RequestResult<GoogleEnableAdResponses, GoogleEnableAdErrors, ThrowOnError>;
|
|
610
|
-
/**
|
|
611
|
-
* List Google Ads keywords
|
|
612
|
-
*
|
|
613
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
614
|
-
*
|
|
615
|
-
* 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).
|
|
616
|
-
*/
|
|
617
|
-
declare const googleListKeywords: <ThrowOnError extends boolean = true>(options: Options<GoogleListKeywordsData, ThrowOnError>) => RequestResult<GoogleListKeywordsResponses, GoogleListKeywordsErrors, ThrowOnError>;
|
|
618
|
-
/**
|
|
619
|
-
* Create a Google Ads keyword
|
|
620
|
-
*
|
|
621
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
622
|
-
*
|
|
623
|
-
* Creates a keyword (an `ad_group_criterion` of type KEYWORD) under an ad group on the connection’s account. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
624
|
-
*/
|
|
625
|
-
declare const googleCreateKeyword: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateKeywordData, ThrowOnError>) => RequestResult<GoogleCreateKeywordResponses, GoogleCreateKeywordErrors, ThrowOnError>;
|
|
626
|
-
/**
|
|
627
|
-
* Retrieve a Google Ads keyword
|
|
628
|
-
*
|
|
629
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
630
|
-
*
|
|
631
|
-
* Returns one keyword (`ad_group_criterion` of type KEYWORD) by its composite id ({ad_group_id}~{criterion_id}), from the connection’s account — text, match type, status, negative flag, and owning ad group.
|
|
632
|
-
*/
|
|
633
|
-
declare const googleGetKeyword: <ThrowOnError extends boolean = true>(options: Options<GoogleGetKeywordData, ThrowOnError>) => RequestResult<GoogleGetKeywordResponses, GoogleGetKeywordErrors, ThrowOnError>;
|
|
634
|
-
/**
|
|
635
|
-
* Set a Google Ads keyword’s bid
|
|
219
|
+
* Retry a post
|
|
636
220
|
*
|
|
637
|
-
* **Authentication.** Secret `pr_` API key
|
|
638
|
-
*
|
|
639
|
-
* Sets a keyword’s manual CPC bid (in micros) by its composite id ({ad_group_id}~{criterion_id}). Money write — secret-key-only. Pass `dry_run: true` to validate without applying.
|
|
640
|
-
*/
|
|
641
|
-
declare const googleSetKeywordBid: <ThrowOnError extends boolean = true>(options: Options<GoogleSetKeywordBidData, ThrowOnError>) => RequestResult<GoogleSetKeywordBidResponses, GoogleSetKeywordBidErrors, ThrowOnError>;
|
|
642
|
-
/**
|
|
643
|
-
* Remove a Google Ads keyword
|
|
644
|
-
*
|
|
645
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
646
|
-
*
|
|
647
|
-
* Removes a keyword (an `ad_group_criterion`) by its composite id ({ad_group_id}~{criterion_id}) (Google’s native remove). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
648
|
-
*/
|
|
649
|
-
declare const googleRemoveKeyword: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveKeywordData, ThrowOnError>) => RequestResult<GoogleRemoveKeywordResponses, GoogleRemoveKeywordErrors, ThrowOnError>;
|
|
650
|
-
/**
|
|
651
|
-
* Pause a Google Ads keyword
|
|
652
|
-
*
|
|
653
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
654
|
-
*
|
|
655
|
-
* Pauses a keyword (`ad_group_criterion`) by its composite id ({ad_group_id}~{criterion_id}) (reversible). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
656
|
-
*/
|
|
657
|
-
declare const googlePauseKeyword: <ThrowOnError extends boolean = true>(options: Options<GooglePauseKeywordData, ThrowOnError>) => RequestResult<GooglePauseKeywordResponses, GooglePauseKeywordErrors, ThrowOnError>;
|
|
658
|
-
/**
|
|
659
|
-
* Enable a Google Ads keyword
|
|
660
|
-
*
|
|
661
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
662
|
-
*
|
|
663
|
-
* Enables (resumes) a keyword (`ad_group_criterion`) by its composite id ({ad_group_id}~{criterion_id}). Pass `dry_run: true` to preview without applying. Returns the new status and whether it executed.
|
|
664
|
-
*/
|
|
665
|
-
declare const googleEnableKeyword: <ThrowOnError extends boolean = true>(options: Options<GoogleEnableKeywordData, ThrowOnError>) => RequestResult<GoogleEnableKeywordResponses, GoogleEnableKeywordErrors, ThrowOnError>;
|
|
666
|
-
/**
|
|
667
|
-
* List Google Ads conversion actions
|
|
668
|
-
*
|
|
669
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
670
|
-
*
|
|
671
|
-
* Returns the conversion actions (the `conversion_action` resource) on the connection’s account — id, name, status, type, category, origin, primary-goal flag, counting type, value settings, and tag snippets.
|
|
672
|
-
*/
|
|
673
|
-
declare const googleListConversionActions: <ThrowOnError extends boolean = true>(options: Options<GoogleListConversionActionsData, ThrowOnError>) => RequestResult<GoogleListConversionActionsResponses, GoogleListConversionActionsErrors, ThrowOnError>;
|
|
674
|
-
/**
|
|
675
|
-
* Create a Google Ads conversion action
|
|
676
|
-
*
|
|
677
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
678
|
-
*
|
|
679
|
-
* Creates a conversion action (the `conversion_action` resource) — a website tag (WEBPAGE) or an offline/API-reported action (UPLOAD_CLICKS) — on the connection’s account. Pass `dry_run: true` to validate against Google without creating. Returns the new resource id + resource_name.
|
|
680
|
-
*/
|
|
681
|
-
declare const googleCreateConversionAction: <ThrowOnError extends boolean = true>(options: Options<GoogleCreateConversionActionData, ThrowOnError>) => RequestResult<GoogleCreateConversionActionResponses, GoogleCreateConversionActionErrors, ThrowOnError>;
|
|
682
|
-
/**
|
|
683
|
-
* Retrieve a Google Ads conversion action
|
|
684
|
-
*
|
|
685
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
686
|
-
*
|
|
687
|
-
* Returns a single conversion action (the `conversion_action` resource) by its numeric id on the connection’s account.
|
|
688
|
-
*/
|
|
689
|
-
declare const googleGetConversionAction: <ThrowOnError extends boolean = true>(options: Options<GoogleGetConversionActionData, ThrowOnError>) => RequestResult<GoogleGetConversionActionResponses, GoogleGetConversionActionErrors, ThrowOnError>;
|
|
690
|
-
/**
|
|
691
|
-
* Update a Google Ads conversion action
|
|
692
|
-
*
|
|
693
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
694
|
-
*
|
|
695
|
-
* Updates the mutable fields of a conversion action (name, category, status, value settings, counting type, lookback windows, primary-for-goal) by numeric id. Only the supplied fields change. Pass `dry_run: true` to validate against Google without applying.
|
|
696
|
-
*/
|
|
697
|
-
declare const googleUpdateConversionAction: <ThrowOnError extends boolean = true>(options: Options<GoogleUpdateConversionActionData, ThrowOnError>) => RequestResult<GoogleUpdateConversionActionResponses, GoogleUpdateConversionActionErrors, ThrowOnError>;
|
|
698
|
-
/**
|
|
699
|
-
* Remove a Google Ads conversion action
|
|
700
|
-
*
|
|
701
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
702
|
-
*
|
|
703
|
-
* Removes a conversion action by numeric id (Google’s native remove — a soft delete to status REMOVED). Set `dry_run: true` in the body to validate the removal against Google without applying it.
|
|
704
|
-
*/
|
|
705
|
-
declare const googleRemoveConversionAction: <ThrowOnError extends boolean = true>(options: Options<GoogleRemoveConversionActionData, ThrowOnError>) => RequestResult<GoogleRemoveConversionActionResponses, GoogleRemoveConversionActionErrors, ThrowOnError>;
|
|
706
|
-
/**
|
|
707
|
-
* Send Google Ads conversion events
|
|
708
|
-
*
|
|
709
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
710
|
-
*
|
|
711
|
-
* Sends a batch of conversion events (1–2000) for one conversion action on the connection’s account, via the Data Manager API. Plaintext identifiers (email / phone / address) are hashed server-side. Pass `dry_run: true` to validate against Google without sending. Returns a request id; poll the status read with it for per-reason processing results.
|
|
712
|
-
*/
|
|
713
|
-
declare const googleSendConversions: <ThrowOnError extends boolean = true>(options: Options<GoogleSendConversionsData, ThrowOnError>) => RequestResult<GoogleSendConversionsResponses, GoogleSendConversionsErrors, ThrowOnError>;
|
|
714
|
-
/**
|
|
715
|
-
* Retrieve Google Ads conversion send status
|
|
716
|
-
*
|
|
717
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
718
|
-
*
|
|
719
|
-
* Returns the per-destination, count-by-reason processing status for a prior conversion send (by its `request_id`) — the total events submitted, the error breakdown (with typed codes), and informational warnings. `destinations` is EMPTY for the first ~minute after a send (Google registers the request asynchronously) — poll until it populates.
|
|
720
|
-
*/
|
|
721
|
-
declare const googleGetConversionStatus: <ThrowOnError extends boolean = true>(options: Options<GoogleGetConversionStatusData, ThrowOnError>) => RequestResult<GoogleGetConversionStatusResponses, GoogleGetConversionStatusErrors, ThrowOnError>;
|
|
722
|
-
/**
|
|
723
|
-
* List Google Ads conversion sends
|
|
724
|
-
*
|
|
725
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
726
|
-
*
|
|
727
|
-
* Returns the history of conversion sends made on this connection (newest first) — each with its `request_id`, the conversion action it targeted, and how many events you submitted. Poll the status read with a `request_id` for that send’s per-destination processing result.
|
|
728
|
-
*/
|
|
729
|
-
declare const googleListConversionRequests: <ThrowOnError extends boolean = true>(options: Options<GoogleListConversionRequestsData, ThrowOnError>) => RequestResult<GoogleListConversionRequestsResponses, GoogleListConversionRequestsErrors, ThrowOnError>;
|
|
730
|
-
/**
|
|
731
|
-
* List Google Ads conversion goals
|
|
732
|
-
*
|
|
733
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:read` scoped to the profile that owns the connection.
|
|
734
|
-
*
|
|
735
|
-
* Returns the conversion goals (the `customer_conversion_goal` resource) on the connection’s account — category, origin, and whether each is biddable. Google auto-creates these per category × origin.
|
|
736
|
-
*/
|
|
737
|
-
declare const googleListConversionGoals: <ThrowOnError extends boolean = true>(options: Options<GoogleListConversionGoalsData, ThrowOnError>) => RequestResult<GoogleListConversionGoalsResponses, GoogleListConversionGoalsErrors, ThrowOnError>;
|
|
738
|
-
/**
|
|
739
|
-
* Set a Google Ads conversion goal’s biddable flag
|
|
740
|
-
*
|
|
741
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `ads:write` scoped to the profile that owns the connection.
|
|
221
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `posts:write` scoped to the profile that owns the post.
|
|
742
222
|
*
|
|
743
|
-
*
|
|
223
|
+
* Re-publishes the post’s failed variants now, through the same path as `publish: "now"`. Published variants are never touched, and a failure that may already be live on the platform (e.g. `x_publish_failed`) is never re-sent, so a retry can’t post twice. Failed attempts are never billed.
|
|
744
224
|
*/
|
|
745
|
-
declare const
|
|
225
|
+
declare const postsRetry: <ThrowOnError extends boolean = true>(options: Options<PostsRetryData, ThrowOnError>) => RequestResult<PostsRetryResponses, PostsRetryErrors, ThrowOnError>;
|
|
746
226
|
/**
|
|
747
|
-
*
|
|
227
|
+
* Validate a post
|
|
748
228
|
*
|
|
749
|
-
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `
|
|
229
|
+
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `posts:read` scoped to the target profile.
|
|
750
230
|
*
|
|
751
|
-
*
|
|
231
|
+
* Runs the exact ownership + publish-readiness checks the create path runs under dry_run, with no side effects. Returns a per-issue verdict (`publishable` + `issues[]`) on 200; a reference to a connection/media outside the profile is a typed 422.
|
|
752
232
|
*/
|
|
753
|
-
declare const
|
|
233
|
+
declare const postsValidate: <ThrowOnError extends boolean = true>(options: Options<PostsValidateData, ThrowOnError>) => RequestResult<PostsValidateResponses, PostsValidateErrors, ThrowOnError>;
|
|
754
234
|
/**
|
|
755
235
|
* Retrieve TikTok creator info
|
|
756
236
|
*
|
|
757
237
|
* **Authentication.** Secret `pr_` API key, or a browser-safe frontend token granting `connections:read` scoped to the profile that owns the connection.
|
|
758
238
|
*
|
|
759
|
-
* Retrieves
|
|
239
|
+
* Retrieves a TikTok account’s publish options live from TikTok: the creator nickname + avatar, the audiences (`privacy_options`) available for photo posts, the Comment/Duet/Stitch availability, and the maximum video length. Returns 404 if the connection does not exist in your account or is not a TikTok connection, 409 if the TikTok account must be reconnected, and 502 if TikTok’s call fails.
|
|
760
240
|
*/
|
|
761
241
|
declare const tiktokCreatorInfo: <ThrowOnError extends boolean = true>(options: Options<TiktokCreatorInfoData, ThrowOnError>) => RequestResult<TiktokCreatorInfoResponses, TiktokCreatorInfoErrors, ThrowOnError>;
|
|
762
242
|
/**
|
|
@@ -930,8 +410,8 @@ type ConnectablePlatform = NonNullable<ConnectionsConnectData['body']>['platform
|
|
|
930
410
|
type DiscoverableAccountList = ConnectionsListAccountsResponse;
|
|
931
411
|
/**
|
|
932
412
|
* A TikTok creator's live publish options for a connection — the data TikTok's
|
|
933
|
-
*
|
|
934
|
-
*
|
|
413
|
+
* publishing UI renders: `creator` (nickname + avatar), the `privacy_options` to
|
|
414
|
+
* offer for PHOTO posts (with NO default — videos publish publicly), the
|
|
935
415
|
* positive `interaction` (allowed) flags for Comment/Duet/Stitch toggles, and
|
|
936
416
|
* `max_video_duration_sec`. Derived from the contract, never hand-declared.
|
|
937
417
|
*/
|
|
@@ -969,8 +449,8 @@ type LinkedInPostVariant = Extract<PostVariantInput, {
|
|
|
969
449
|
platform: 'linkedin';
|
|
970
450
|
}>;
|
|
971
451
|
/** The TikTok member of the write variant union — typed native settings
|
|
972
|
-
* (`privacy_level`, `disable_comment`/`disable_duet`/`disable_stitch`,
|
|
973
|
-
* `
|
|
452
|
+
* (photo-only `privacy_level`, `disable_comment`/`disable_duet`/`disable_stitch`,
|
|
453
|
+
* `is_branded_content`/`is_brand_organic`, `is_ai_generated`, photo/video cover).
|
|
974
454
|
* Narrowed from the contract, never hand-declared — it is the compose-time shape a
|
|
975
455
|
* live TikTok preview renders. */
|
|
976
456
|
type TikTokPostVariant = Extract<PostVariantInput, {
|
|
@@ -1208,32 +688,12 @@ type XPoll = NonNullable<NonNullable<XPostVariant['settings']>['poll']>;
|
|
|
1208
688
|
declare function xPollDurationLabel(durationMinutes: number): string;
|
|
1209
689
|
|
|
1210
690
|
/**
|
|
1211
|
-
* The
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
* a redeclared shape, so it can't drift from the API. */
|
|
1218
|
-
interface AdTreeNode extends GoogleAdTreeNode {
|
|
1219
|
-
children: AdTreeNode[];
|
|
1220
|
-
}
|
|
1221
|
-
/**
|
|
1222
|
-
* Group flat tree nodes into a nested tree by `parent_id`. A node whose parent is
|
|
1223
|
-
* NOT in the set is a root — so a campaign-level page (campaigns have
|
|
1224
|
-
* `parent_id: null`) and a per-campaign subtree page (ad groups whose campaign is
|
|
1225
|
-
* absent) each group correctly on their own, and concatenating a campaign page with
|
|
1226
|
-
* an expanded campaign's subtree page nests the subtree under that campaign. Input
|
|
1227
|
-
* order is preserved within every level. Pure — the input is not mutated.
|
|
1228
|
-
*/
|
|
1229
|
-
declare function groupAdTree(nodes: GoogleAdTreeNode[]): AdTreeNode[];
|
|
1230
|
-
|
|
1231
|
-
/**
|
|
1232
|
-
* TikTok's mandatory publish-options model — the framework-agnostic glue between
|
|
1233
|
-
* the live `creator-info` payload and a TikTok post's settings. This is the
|
|
1234
|
-
* SINGLE source for the no-default / creator-gated / commercial-disclosure rules
|
|
1235
|
-
* TikTok's Required UX mandates; the React panel and the dashboard composer both
|
|
1236
|
-
* consume it (never re-implement it).
|
|
691
|
+
* The TikTok composer's publish-options model — the framework-agnostic glue
|
|
692
|
+
* between the live `creator-info` payload and a TikTok post's settings. This is
|
|
693
|
+
* the SINGLE source for the audience / creator-gated interaction / commercial
|
|
694
|
+
* disclosure rules; the React panel and the dashboard composer both consume it
|
|
695
|
+
* (never re-implement it). The no-default audience and explicit-consent flow are
|
|
696
|
+
* Postrun's own UX choices, not API requirements.
|
|
1237
697
|
*
|
|
1238
698
|
* The creator-info shape, the privacy union, and the privacy label come from the
|
|
1239
699
|
* contract (`./resources`, `./tiktok`) — never re-declared. This module owns the
|
|
@@ -1252,18 +712,18 @@ declare const TIKTOK_CAPTION_MAX: {
|
|
|
1252
712
|
* `post_type` is server-derived from the media (read-only) — the composer passes
|
|
1253
713
|
* the shape it knows it's building (a video post vs a photo post). */
|
|
1254
714
|
declare function captionMaxFor(postType: PostType): number;
|
|
1255
|
-
/** The creator-gated interactions
|
|
1256
|
-
*
|
|
1257
|
-
*
|
|
715
|
+
/** The creator-gated interactions we surface — DERIVED from the creator-info
|
|
716
|
+
* contract (`interaction` keys), never hand-listed, so it can never drift from
|
|
717
|
+
* the API shape. */
|
|
1258
718
|
type TikTokInteractionKey = keyof TikTokCreatorInfo['interaction'];
|
|
1259
719
|
/** Which commercial-disclosure brand option a control maps to. */
|
|
1260
720
|
type TikTokBrandKind = 'your_brand' | 'branded_content';
|
|
1261
721
|
/**
|
|
1262
722
|
* The controlled value a TikTok composer/preview owns. `privacy_level` is
|
|
1263
|
-
*
|
|
1264
|
-
* absent value is the "must choose"
|
|
1265
|
-
*
|
|
1266
|
-
* `disable_*` shape.
|
|
723
|
+
* PHOTO-ONLY (TikTok publishes every video publicly) and optional because we
|
|
724
|
+
* make the user pick — there is NO default (an absent value is the "must choose"
|
|
725
|
+
* state the photo publish gate keys off). Interaction flags are POSITIVE
|
|
726
|
+
* ("allow"); `tiktokSettings` inverts them to the API's `disable_*` shape.
|
|
1267
727
|
*/
|
|
1268
728
|
interface TikTokOptionsValue {
|
|
1269
729
|
privacy_level?: TikTokPrivacyLevel;
|
|
@@ -1275,13 +735,16 @@ interface TikTokOptionsValue {
|
|
|
1275
735
|
commercial_disclosure: boolean;
|
|
1276
736
|
your_brand: boolean;
|
|
1277
737
|
branded_content: boolean;
|
|
1278
|
-
/** AI-generated content disclosure → the API's `
|
|
1279
|
-
* default. */
|
|
1280
|
-
|
|
738
|
+
/** AI-generated content disclosure → the API's `is_ai_generated`. Video-only,
|
|
739
|
+
* off by default. */
|
|
740
|
+
ai_generated: boolean;
|
|
1281
741
|
}
|
|
1282
|
-
interface
|
|
742
|
+
interface AudiencePrivacyChoice {
|
|
1283
743
|
level: TikTokPrivacyLevel;
|
|
1284
744
|
label: string;
|
|
745
|
+
disabled: boolean;
|
|
746
|
+
/** Why the option is disabled; present only when disabled. */
|
|
747
|
+
disabledReason?: string;
|
|
1285
748
|
}
|
|
1286
749
|
interface TikTokInteractionRow {
|
|
1287
750
|
key: TikTokInteractionKey;
|
|
@@ -1295,31 +758,32 @@ declare const TIKTOK_MUSIC_CONFIRMATION_URL = "https://www.tiktok.com/legal/page
|
|
|
1295
758
|
declare const TIKTOK_BRANDED_CONTENT_POLICY_URL = "https://www.tiktok.com/legal/page/global/bc-policy/en";
|
|
1296
759
|
/** TikTok's exact required prompt when disclosure is on but nothing is chosen. */
|
|
1297
760
|
declare const TIKTOK_DISCLOSURE_REQUIRED_HINT = "You need to indicate if your content promotes yourself, a third party, or both.";
|
|
1298
|
-
/**
|
|
1299
|
-
declare const TIKTOK_AUDIENCE_REQUIRED_HINT = "Choose who can view this
|
|
1300
|
-
/**
|
|
1301
|
-
|
|
761
|
+
/** Shown when a photo post has no audience picked yet. */
|
|
762
|
+
declare const TIKTOK_AUDIENCE_REQUIRED_HINT = "Choose who can view this post before publishing.";
|
|
763
|
+
/** Why branded content can't be combined with a private audience. */
|
|
764
|
+
declare const TIKTOK_BRANDED_CONTENT_PRIVATE_DISABLED_REASON = "Branded content visibility cannot be set to private.";
|
|
765
|
+
/** A published post may take a few minutes to process; tells the user so. */
|
|
1302
766
|
declare const TIKTOK_PROCESSING_NOTICE = "After you publish, it may take a few minutes for your post to process and appear on your TikTok profile.";
|
|
1303
767
|
/**
|
|
1304
|
-
* The initial value for a TikTok post: nothing pre-selected.
|
|
1305
|
-
*
|
|
1306
|
-
*
|
|
768
|
+
* The initial value for a TikTok post: nothing pre-selected. We make the user
|
|
769
|
+
* actively choose — no default audience, every interaction OFF, no disclosure.
|
|
770
|
+
* The panel still greys the interactions the creator forbids.
|
|
1307
771
|
*/
|
|
1308
772
|
declare function defaultTikTokOptions(): TikTokOptionsValue;
|
|
1309
|
-
/** The audience choices for the dropdown — one per level the creator allows. */
|
|
1310
|
-
declare function privacyChoices(options: readonly TikTokPrivacyLevel[]): TikTokPrivacyChoice[];
|
|
1311
773
|
/** Narrow a raw dropdown value to a `TikTokPrivacyLevel` against the creator's
|
|
1312
774
|
* allowed options — returns `undefined` for anything not offered (no cast). */
|
|
1313
775
|
declare function parsePrivacyLevel(value: string, options: readonly TikTokPrivacyLevel[]): TikTokPrivacyLevel | undefined;
|
|
1314
776
|
/**
|
|
1315
|
-
* The audience
|
|
1316
|
-
*
|
|
1317
|
-
* branded content
|
|
777
|
+
* The audience choices for a PHOTO post — one per creator-allowed level. While
|
|
778
|
+
* branded content is disclosed, `SELF_ONLY` stays visible but disabled with the
|
|
779
|
+
* reason (branded content can't be private); it is never silently removed or
|
|
780
|
+
* swapped, so the user's selection is never changed behind their back.
|
|
1318
781
|
*/
|
|
1319
|
-
declare function audiencePrivacyOptions(options: readonly TikTokPrivacyLevel[], value: TikTokOptionsValue):
|
|
1320
|
-
/**
|
|
1321
|
-
*
|
|
1322
|
-
|
|
782
|
+
declare function audiencePrivacyOptions(options: readonly TikTokPrivacyLevel[], value: TikTokOptionsValue): AudiencePrivacyChoice[];
|
|
783
|
+
/** A photo post with no audience picked yet — must BLOCK publish (the API
|
|
784
|
+
* requires `privacy_level` on photos and we offer no default). A video never
|
|
785
|
+
* needs one: TikTok publishes every video publicly. */
|
|
786
|
+
declare function audienceUnselected(value: TikTokOptionsValue, isVideo: boolean): boolean;
|
|
1323
787
|
/** Disclosure is on but neither brand option is chosen — TikTok requires ≥1. */
|
|
1324
788
|
declare function commercialDisclosureIncomplete(value: TikTokOptionsValue): boolean;
|
|
1325
789
|
/** True when the post is disclosed as branded content (drives the BC declaration). */
|
|
@@ -1333,12 +797,15 @@ declare function commercialLabelNotice(value: TikTokOptionsValue): string | null
|
|
|
1333
797
|
/** Toggle the master disclosure switch. Turning it OFF clears both brand
|
|
1334
798
|
* selections (a hidden control must not keep sending a stale selection). */
|
|
1335
799
|
declare function setCommercialDisclosure(value: TikTokOptionsValue, on: boolean): TikTokOptionsValue;
|
|
800
|
+
/** Set one brand option. Never touches the audience (see
|
|
801
|
+
* `brandedContentDisabledReason` for how a private audience locks branded content). */
|
|
802
|
+
declare function setBrandKind(value: TikTokOptionsValue, kind: TikTokBrandKind, on: boolean): TikTokOptionsValue;
|
|
1336
803
|
/**
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
804
|
+
* Why "Branded content" is locked, or undefined when it can be toggled. With a
|
|
805
|
+
* private audience already picked the option stays visible but disabled WITH the
|
|
806
|
+
* reason — an already-checked box stays untickable.
|
|
1340
807
|
*/
|
|
1341
|
-
declare function
|
|
808
|
+
declare function brandedContentDisabledReason(value: TikTokOptionsValue): string | undefined;
|
|
1342
809
|
/** True when the creator does NOT permit this interaction (so it's locked off). */
|
|
1343
810
|
declare function isInteractionForbidden(info: TikTokCreatorInfo, key: TikTokInteractionKey): boolean;
|
|
1344
811
|
/** The interaction toggles to render — video shows Comment/Duet/Stitch (each
|
|
@@ -1350,17 +817,38 @@ declare function interactionValueKey(key: TikTokInteractionKey): keyof TikTokOpt
|
|
|
1350
817
|
declare function toggleInteraction(value: TikTokOptionsValue, key: TikTokInteractionKey, on: boolean): TikTokOptionsValue;
|
|
1351
818
|
/**
|
|
1352
819
|
* Map the composer's positive value into the SDK's `tiktok` settings — INVERTING
|
|
1353
|
-
* `allow_*` into TikTok's `disable_*`.
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
820
|
+
* `allow_*` into TikTok's `disable_*`. The API rejects video-only fields
|
|
821
|
+
* (`disable_duet`/`disable_stitch`/`is_ai_generated`) on a photo and
|
|
822
|
+
* `privacy_level` on a video (`field_placement_invalid`), so each post kind sends
|
|
823
|
+
* only its own.
|
|
1356
824
|
*/
|
|
1357
825
|
declare function tiktokSettings(value: TikTokOptionsValue, isVideo: boolean): NonNullable<SettingsFor<'tiktok'>>;
|
|
826
|
+
/** A fetched post's TikTok variant settings (the read shape) — derived from the
|
|
827
|
+
* contract, never re-declared. */
|
|
828
|
+
type TikTokVariantSettings = Extract<Post['variants'][number], {
|
|
829
|
+
platform: 'tiktok';
|
|
830
|
+
}>['settings'];
|
|
831
|
+
/**
|
|
832
|
+
* The inverse of {@link tiktokSettings}: rebuild the composer's controlled
|
|
833
|
+
* options from a fetched post's TikTok settings — the open-a-draft / scheduled
|
|
834
|
+
* path. `disable_*` flags invert back to positive "allow"; disclosure is on when
|
|
835
|
+
* either brand flag is.
|
|
836
|
+
*/
|
|
837
|
+
declare function tiktokOptionsFromSettings(settings: TikTokVariantSettings): TikTokOptionsValue;
|
|
838
|
+
/**
|
|
839
|
+
* A render-ready block message when the selected video exceeds the creator's
|
|
840
|
+
* `max_video_duration_sec`, else `null`. Video-only. Never false-blocks: missing
|
|
841
|
+
* creator-info (still loading), no video asset, or a duration the probe hasn't
|
|
842
|
+
* reported yet (`source.duration_ms === null`) all return `null` — it only fires
|
|
843
|
+
* on a KNOWN over-limit duration.
|
|
844
|
+
*/
|
|
845
|
+
declare function tiktokDurationError(media: readonly MediaResource[], info: TikTokCreatorInfo | null, isVideo: boolean): string | null;
|
|
1358
846
|
/**
|
|
1359
847
|
* Is the TikTok post ready to publish (client-side gate mirroring the API)?
|
|
1360
|
-
*
|
|
848
|
+
* A photo needs an audience; any post with disclosure on needs a brand kind.
|
|
1361
849
|
* The caption-cap + media-count checks live with their own components.
|
|
1362
850
|
*/
|
|
1363
|
-
declare function tiktokOptionsReady(value: TikTokOptionsValue): boolean;
|
|
851
|
+
declare function tiktokOptionsReady(value: TikTokOptionsValue, isVideo: boolean): boolean;
|
|
1364
852
|
|
|
1365
853
|
/**
|
|
1366
854
|
* A media attachment — just the uploaded asset's id. The post SHAPE (`post_type`
|
|
@@ -1448,4 +936,4 @@ declare function buildCreatePost(input: ComposePostInput, connections: readonly
|
|
|
1448
936
|
*/
|
|
1449
937
|
declare function buildUpdatePost(input: ComposeUpdateInput, connections?: readonly ConnectionRef[]): UpdatePostInput;
|
|
1450
938
|
|
|
1451
|
-
export { type AdTreeNode, type ChannelConfig, type Channels, ComposeError, type ComposePostInput, type ComposeUpdateInput, type ConnectSession, type ConnectablePlatform, type Connection, type ConnectionKind, type ConnectionList, type ConnectionRef, type ConnectionStatus, ConnectionsConnectData, ConnectionsConnectErrors, ConnectionsConnectResponse, ConnectionsConnectResponses, ConnectionsDeleteData, ConnectionsDeleteErrors, ConnectionsDeleteResponses, ConnectionsGetData, ConnectionsGetErrors, ConnectionsGetResponse, ConnectionsGetResponses, ConnectionsListAccountsData, ConnectionsListAccountsErrors, ConnectionsListAccountsResponse, ConnectionsListAccountsResponses, ConnectionsListByProfileData, ConnectionsListByProfileErrors, ConnectionsListByProfileResponse, ConnectionsListByProfileResponses, ConnectionsSelectData, ConnectionsSelectErrors, ConnectionsSelectResponses, type CreateMediaInput, type CreateMediaResult, type CreatePostInput, type CreateProfileInput, type DiscoverableAccountList, ErrorCode, GoogleAdTreeNode, GoogleCreateAdData, GoogleCreateAdErrors, GoogleCreateAdGroupCriterionData, GoogleCreateAdGroupCriterionErrors, GoogleCreateAdGroupCriterionResponses, GoogleCreateAdGroupData, GoogleCreateAdGroupErrors, GoogleCreateAdGroupResponses, GoogleCreateAdResponses, GoogleCreateBudgetData, GoogleCreateBudgetErrors, GoogleCreateBudgetResponses, GoogleCreateCampaignCriterionData, GoogleCreateCampaignCriterionErrors, GoogleCreateCampaignCriterionResponses, GoogleCreateCampaignData, GoogleCreateCampaignErrors, GoogleCreateCampaignResponses, GoogleCreateConversionActionData, GoogleCreateConversionActionErrors, GoogleCreateConversionActionResponses, GoogleCreateDisplayAdData, GoogleCreateDisplayAdErrors, GoogleCreateDisplayAdResponses, GoogleCreateKeywordData, GoogleCreateKeywordErrors, GoogleCreateKeywordResponses, GoogleEditAccountData, GoogleEditAccountErrors, GoogleEditAccountResponses, GoogleEditAdGroupData, GoogleEditAdGroupErrors, GoogleEditAdGroupResponses, GoogleEditBudgetData, GoogleEditBudgetErrors, GoogleEditBudgetResponses, GoogleEditCampaignData, GoogleEditCampaignErrors, GoogleEditCampaignResponses, GoogleEnableAdData, GoogleEnableAdErrors, GoogleEnableAdGroupData, GoogleEnableAdGroupErrors, GoogleEnableAdGroupResponses, GoogleEnableAdResponses, GoogleEnableCampaignData, GoogleEnableCampaignErrors, GoogleEnableCampaignResponses, GoogleEnableKeywordData, GoogleEnableKeywordErrors, GoogleEnableKeywordResponses, GoogleGetAccountData, GoogleGetAccountErrors, GoogleGetAccountResponses, GoogleGetAdData, GoogleGetAdErrors, GoogleGetAdGroupData, GoogleGetAdGroupErrors, GoogleGetAdGroupResponses, GoogleGetAdResponses, GoogleGetAdTreeData, GoogleGetAdTreeErrors, GoogleGetAdTreeResponses, GoogleGetCampaignData, GoogleGetCampaignErrors, GoogleGetCampaignResponses, GoogleGetConversionActionData, GoogleGetConversionActionErrors, GoogleGetConversionActionResponses, GoogleGetConversionStatusData, GoogleGetConversionStatusErrors, GoogleGetConversionStatusResponses, GoogleGetInsightsData, GoogleGetInsightsErrors, GoogleGetInsightsResponses, GoogleGetKeywordData, GoogleGetKeywordErrors, GoogleGetKeywordResponses, GoogleListAdGroupCriteriaData, GoogleListAdGroupCriteriaErrors, GoogleListAdGroupCriteriaResponses, GoogleListAdGroupsData, GoogleListAdGroupsErrors, GoogleListAdGroupsResponses, GoogleListAdsData, GoogleListAdsErrors, GoogleListAdsResponses, GoogleListAudiencesData, GoogleListAudiencesErrors, GoogleListAudiencesResponses, GoogleListCampaignCriteriaData, GoogleListCampaignCriteriaErrors, GoogleListCampaignCriteriaResponses, GoogleListCampaignsData, GoogleListCampaignsErrors, GoogleListCampaignsResponses, GoogleListConversionActionsData, GoogleListConversionActionsErrors, GoogleListConversionActionsResponses, GoogleListConversionGoalsData, GoogleListConversionGoalsErrors, GoogleListConversionGoalsResponses, GoogleListConversionRequestsData, GoogleListConversionRequestsErrors, GoogleListConversionRequestsResponses, GoogleListKeywordsData, GoogleListKeywordsErrors, GoogleListKeywordsResponses, GooglePauseAdData, GooglePauseAdErrors, GooglePauseAdGroupData, GooglePauseAdGroupErrors, GooglePauseAdGroupResponses, GooglePauseAdResponses, GooglePauseCampaignData, GooglePauseCampaignErrors, GooglePauseCampaignResponses, GooglePauseKeywordData, GooglePauseKeywordErrors, GooglePauseKeywordResponses, GoogleRemoveAdData, GoogleRemoveAdErrors, GoogleRemoveAdGroupCriterionData, GoogleRemoveAdGroupCriterionErrors, GoogleRemoveAdGroupCriterionResponses, GoogleRemoveAdGroupData, GoogleRemoveAdGroupErrors, GoogleRemoveAdGroupResponses, GoogleRemoveAdResponses, GoogleRemoveBudgetData, GoogleRemoveBudgetErrors, GoogleRemoveBudgetResponses, GoogleRemoveCampaignCriterionData, GoogleRemoveCampaignCriterionErrors, GoogleRemoveCampaignCriterionResponses, GoogleRemoveCampaignData, GoogleRemoveCampaignErrors, GoogleRemoveCampaignResponses, GoogleRemoveConversionActionData, GoogleRemoveConversionActionErrors, GoogleRemoveConversionActionResponses, GoogleRemoveKeywordData, GoogleRemoveKeywordErrors, GoogleRemoveKeywordResponses, GoogleRunGaqlData, GoogleRunGaqlErrors, GoogleRunGaqlResponses, GoogleSearchGeoTargetsData, GoogleSearchGeoTargetsErrors, GoogleSearchGeoTargetsResponses, GoogleSendConversionsData, GoogleSendConversionsErrors, GoogleSendConversionsResponses, GoogleSetAdGroupBidsData, GoogleSetAdGroupBidsErrors, GoogleSetAdGroupBidsResponses, GoogleSetCampaignGeoSettingsData, GoogleSetCampaignGeoSettingsErrors, GoogleSetCampaignGeoSettingsResponses, GoogleSetCampaignTargetingSettingData, GoogleSetCampaignTargetingSettingErrors, GoogleSetCampaignTargetingSettingResponses, GoogleSetConversionGoalData, GoogleSetConversionGoalErrors, GoogleSetConversionGoalResponses, GoogleSetKeywordBidData, GoogleSetKeywordBidErrors, GoogleSetKeywordBidResponses, GoogleUpdateConversionActionData, GoogleUpdateConversionActionErrors, GoogleUpdateConversionActionResponses, GoogleUploadImageAssetData, GoogleUploadImageAssetErrors, GoogleUploadImageAssetResponses, type InstagramPostVariant, type LinkedInPollDuration, type LinkedInPostVariant, type ListConnectionsQuery, type ListMediaQuery, type ListPostsQuery, type ListProfilesQuery, LogsGetData, LogsGetErrors, LogsGetResponses, LogsListData, LogsListErrors, LogsListResponses, MediaAbortData, MediaAbortErrors, MediaAbortResponses, MediaCompleteData, MediaCompleteErrors, MediaCompleteResponses, MediaCreateData, MediaCreateErrors, MediaCreateResponse, MediaCreateResponses, MediaDeleteData, MediaDeleteErrors, MediaDeleteResponses, MediaGetData, MediaGetErrors, MediaGetResponse, MediaGetResponses, type MediaInput, type MediaKind, type MediaList, MediaListData, MediaListErrors, MediaListPartsData, MediaListPartsErrors, MediaListPartsResponses, MediaListResponse, MediaListResponses, type MediaResource, MediaSignPartData, MediaSignPartErrors, MediaSignPartResponses, type MediaStatus, type MediaTarget, MediaUpdateData, MediaUpdateErrors, MediaUpdateResponses, MetaAccountData, MetaAccountErrors, MetaAccountResponses, MetaAdData, MetaAdErrors, MetaAdResponses, MetaAdsData, MetaAdsErrors, MetaAdsResponses, MetaAdsetData, MetaAdsetErrors, MetaAdsetResponses, MetaAdsetsData, MetaAdsetsErrors, MetaAdsetsResponses, MetaCampaignData, MetaCampaignErrors, MetaCampaignResponses, MetaCampaignsData, MetaCampaignsErrors, MetaCampaignsResponses, MetaInsightsData, MetaInsightsErrors, MetaInsightsResponses, type Metadata, type MetadataFilter, type MultipartSession, type Options, POST_PLATFORMS, type Post, type PostContent, type PostList, type PostMetadata, type PostPlatform, type PostStatus, type PostType, type PostValidation, type PostVariant, type PostVariantError, type PostVariantInput, PostrunClient, PostrunError, type PostrunErrorCode, type PostrunFieldError, type PostrunProblem, PostsCreateData, PostsCreateErrors, PostsCreateResponses, PostsDeleteData, PostsDeleteErrors, PostsDeleteResponses, PostsGetData, PostsGetErrors, PostsGetResponse, PostsGetResponses, PostsListData, PostsListErrors, PostsListResponse, PostsListResponses, PostsUpdateData, PostsUpdateErrors, PostsUpdateResponses, PostsValidateData, PostsValidateErrors, PostsValidateResponse, PostsValidateResponses, type Profile, type ProfileList, ProfilesCreateData, ProfilesCreateErrors, ProfilesCreateResponses, ProfilesDeleteData, ProfilesDeleteErrors, ProfilesDeleteResponses, ProfilesGetData, ProfilesGetErrors, ProfilesGetResponse, ProfilesGetResponses, ProfilesListData, ProfilesListErrors, ProfilesListResponse, ProfilesListResponses, ProfilesUpdateData, ProfilesUpdateErrors, ProfilesUpdateResponses, type PublishMode, type SelectAccountInput, type SettingsFor, TIKTOK_AUDIENCE_REQUIRED_HINT, TIKTOK_BRANDED_CONTENT_POLICY_URL, TIKTOK_CAPTION_MAX, TIKTOK_DISCLOSURE_REQUIRED_HINT, TIKTOK_MUSIC_CONFIRMATION_URL, TIKTOK_PROCESSING_NOTICE, type TikTokBrandKind, type TikTokCreatorInfo, type TikTokInteractionKey, type TikTokInteractionRow, type TikTokOptionsValue, type TikTokPostVariant, type TikTokPrivacyChoice, type TikTokPrivacyLevel, TiktokCreatorInfoData, TiktokCreatorInfoErrors, TiktokCreatorInfoResponse, TiktokCreatorInfoResponses, TokensMintData, TokensMintErrors, TokensMintResponses, type UpdateMediaInput, type UpdatePostInput, type UpdateProfileInput, UploadError, type UploadFileOptions, type ValidatePostInput, type ValidationIssue, type WaitForMediaOptions, WebhooksCreateEndpointData, WebhooksCreateEndpointErrors, WebhooksCreateEndpointResponses, WebhooksCreatePortalData, WebhooksCreatePortalErrors, WebhooksCreatePortalResponses, WebhooksDeleteEndpointData, WebhooksDeleteEndpointErrors, WebhooksDeleteEndpointResponses, WebhooksGetEndpointData, WebhooksGetEndpointErrors, WebhooksGetEndpointResponses, WebhooksListEndpointsData, WebhooksListEndpointsErrors, WebhooksListEndpointsResponses, WebhooksListEventTypesData, WebhooksListEventTypesErrors, WebhooksListEventTypesResponses, WebhooksPingData, WebhooksPingErrors, WebhooksPingResponses, WebhooksUpdateEndpointData, WebhooksUpdateEndpointErrors, WebhooksUpdateEndpointResponses, type XPoll, type XPostVariant, audiencePrivacyOptions, audienceUnselected, brandedContentDeclared, buildCreatePost, buildUpdatePost, captionMaxFor, commercialDisclosureIncomplete, commercialLabelNotice, connectionsConnect, connectionsDelete, connectionsGet, connectionsListAccounts, connectionsListByProfile, connectionsSelect, defaultTikTokOptions, failedVariants, googleCreateAd, googleCreateAdGroup, googleCreateAdGroupCriterion, googleCreateBudget, googleCreateCampaign, googleCreateCampaignCriterion, googleCreateConversionAction, googleCreateDisplayAd, googleCreateKeyword, googleEditAccount, googleEditAdGroup, googleEditBudget, googleEditCampaign, googleEnableAd, googleEnableAdGroup, googleEnableCampaign, googleEnableKeyword, googleGetAccount, googleGetAd, googleGetAdGroup, googleGetAdTree, googleGetCampaign, googleGetConversionAction, googleGetConversionStatus, googleGetInsights, googleGetKeyword, googleListAdGroupCriteria, googleListAdGroups, googleListAds, googleListAudiences, googleListCampaignCriteria, googleListCampaigns, googleListConversionActions, googleListConversionGoals, googleListConversionRequests, googleListKeywords, googlePauseAd, googlePauseAdGroup, googlePauseCampaign, googlePauseKeyword, googleRemoveAd, googleRemoveAdGroup, googleRemoveAdGroupCriterion, googleRemoveBudget, googleRemoveCampaign, googleRemoveCampaignCriterion, googleRemoveConversionAction, googleRemoveKeyword, googleRunGaql, googleSearchGeoTargets, googleSendConversions, googleSetAdGroupBids, googleSetCampaignGeoSettings, googleSetCampaignTargetingSetting, googleSetConversionGoal, googleSetKeywordBid, googleUpdateConversionAction, googleUploadImageAsset, groupAdTree, interactionRows, interactionValueKey, isInteractionForbidden, isPostPlatform, isPublished, linkedinPollDurationLabel, logsGet, logsList, mediaAbort, mediaComplete, mediaCreate, mediaDelete, mediaGet, mediaList, mediaListParts, mediaSignPart, mediaUpdate, metaAccount, metaAd, metaAds, metaAdset, metaAdsets, metaCampaign, metaCampaigns, metaInsights, parsePrivacyLevel, postsCreate, postsDelete, postsGet, postsList, postsUpdate, postsValidate, privacyChoices, profilesCreate, profilesDelete, profilesGet, profilesList, profilesUpdate, setBrandKind, setCommercialDisclosure, tiktokCreatorInfo, tiktokOptionsReady, tiktokPrivacyLabel, tiktokSettings, toggleInteraction, tokensMint, uploadFile, waitForMedia, webhooksCreateEndpoint, webhooksCreatePortal, webhooksDeleteEndpoint, webhooksGetEndpoint, webhooksListEndpoints, webhooksListEventTypes, webhooksPing, webhooksUpdateEndpoint, xPollDurationLabel };
|
|
939
|
+
export { type AudiencePrivacyChoice, type ChannelConfig, type Channels, ComposeError, type ComposePostInput, type ComposeUpdateInput, type ConnectSession, type ConnectablePlatform, type Connection, type ConnectionKind, type ConnectionList, type ConnectionRef, type ConnectionStatus, ConnectionsConnectData, ConnectionsConnectErrors, ConnectionsConnectResponse, ConnectionsConnectResponses, ConnectionsDeleteData, ConnectionsDeleteErrors, ConnectionsDeleteResponses, ConnectionsGetData, ConnectionsGetErrors, ConnectionsGetResponse, ConnectionsGetResponses, ConnectionsListAccountsData, ConnectionsListAccountsErrors, ConnectionsListAccountsResponse, ConnectionsListAccountsResponses, ConnectionsListByProfileData, ConnectionsListByProfileErrors, ConnectionsListByProfileResponse, ConnectionsListByProfileResponses, ConnectionsSelectData, ConnectionsSelectErrors, ConnectionsSelectResponses, type CreateMediaInput, type CreateMediaResult, type CreatePostInput, type CreateProfileInput, type DiscoverableAccountList, ErrorCode, type InstagramPostVariant, type LinkedInPollDuration, type LinkedInPostVariant, type ListConnectionsQuery, type ListMediaQuery, type ListPostsQuery, type ListProfilesQuery, LogsGetData, LogsGetErrors, LogsGetResponses, LogsListData, LogsListErrors, LogsListResponses, MediaAbortData, MediaAbortErrors, MediaAbortResponses, MediaCompleteData, MediaCompleteErrors, MediaCompleteResponses, MediaCreateData, MediaCreateErrors, MediaCreateResponse, MediaCreateResponses, MediaDeleteData, MediaDeleteErrors, MediaDeleteResponses, MediaGetData, MediaGetErrors, MediaGetResponse, MediaGetResponses, type MediaInput, type MediaKind, type MediaList, MediaListData, MediaListErrors, MediaListPartsData, MediaListPartsErrors, MediaListPartsResponses, MediaListResponse, MediaListResponses, type MediaResource, MediaSignPartData, MediaSignPartErrors, MediaSignPartResponses, type MediaStatus, type MediaTarget, MediaUpdateData, MediaUpdateErrors, MediaUpdateResponses, type Metadata, type MetadataFilter, type MultipartSession, type Options, POST_PLATFORMS, type Post, type PostContent, type PostList, type PostMetadata, type PostPlatform, type PostStatus, type PostType, type PostValidation, type PostVariant, type PostVariantError, type PostVariantInput, PostrunClient, PostrunError, type PostrunErrorCode, type PostrunFieldError, type PostrunProblem, PostsCreateData, PostsCreateErrors, PostsCreateResponses, PostsDeleteData, PostsDeleteErrors, PostsDeleteResponses, PostsGetData, PostsGetErrors, PostsGetResponse, PostsGetResponses, PostsListData, PostsListErrors, PostsListResponse, PostsListResponses, PostsRetryData, PostsRetryErrors, PostsRetryResponses, PostsUpdateData, PostsUpdateErrors, PostsUpdateResponses, PostsValidateData, PostsValidateErrors, PostsValidateResponse, PostsValidateResponses, type Profile, type ProfileList, ProfilesCreateData, ProfilesCreateErrors, ProfilesCreateResponses, ProfilesDeleteData, ProfilesDeleteErrors, ProfilesDeleteResponses, ProfilesGetData, ProfilesGetErrors, ProfilesGetResponse, ProfilesGetResponses, ProfilesListData, ProfilesListErrors, ProfilesListResponse, ProfilesListResponses, ProfilesUpdateData, ProfilesUpdateErrors, ProfilesUpdateResponses, type PublishMode, type SelectAccountInput, type SettingsFor, TIKTOK_AUDIENCE_REQUIRED_HINT, TIKTOK_BRANDED_CONTENT_POLICY_URL, TIKTOK_BRANDED_CONTENT_PRIVATE_DISABLED_REASON, TIKTOK_CAPTION_MAX, TIKTOK_DISCLOSURE_REQUIRED_HINT, TIKTOK_MUSIC_CONFIRMATION_URL, TIKTOK_PROCESSING_NOTICE, type TikTokBrandKind, type TikTokCreatorInfo, type TikTokInteractionKey, type TikTokInteractionRow, type TikTokOptionsValue, type TikTokPostVariant, type TikTokPrivacyLevel, TiktokCreatorInfoData, TiktokCreatorInfoErrors, TiktokCreatorInfoResponse, TiktokCreatorInfoResponses, TokensMintData, TokensMintErrors, TokensMintResponses, type UpdateMediaInput, type UpdatePostInput, type UpdateProfileInput, UploadError, type UploadFileOptions, type ValidatePostInput, type ValidationIssue, type WaitForMediaOptions, WebhooksCreateEndpointData, WebhooksCreateEndpointErrors, WebhooksCreateEndpointResponses, WebhooksCreatePortalData, WebhooksCreatePortalErrors, WebhooksCreatePortalResponses, WebhooksDeleteEndpointData, WebhooksDeleteEndpointErrors, WebhooksDeleteEndpointResponses, WebhooksGetEndpointData, WebhooksGetEndpointErrors, WebhooksGetEndpointResponses, WebhooksListEndpointsData, WebhooksListEndpointsErrors, WebhooksListEndpointsResponses, WebhooksListEventTypesData, WebhooksListEventTypesErrors, WebhooksListEventTypesResponses, WebhooksPingData, WebhooksPingErrors, WebhooksPingResponses, WebhooksUpdateEndpointData, WebhooksUpdateEndpointErrors, WebhooksUpdateEndpointResponses, type XPoll, type XPostVariant, audiencePrivacyOptions, audienceUnselected, brandedContentDeclared, brandedContentDisabledReason, buildCreatePost, buildUpdatePost, captionMaxFor, commercialDisclosureIncomplete, commercialLabelNotice, connectionsConnect, connectionsDelete, connectionsGet, connectionsListAccounts, connectionsListByProfile, connectionsSelect, defaultTikTokOptions, failedVariants, interactionRows, interactionValueKey, isInteractionForbidden, isPostPlatform, isPublished, linkedinPollDurationLabel, logsGet, logsList, mediaAbort, mediaComplete, mediaCreate, mediaDelete, mediaGet, mediaList, mediaListParts, mediaSignPart, mediaUpdate, parsePrivacyLevel, postsCreate, postsDelete, postsGet, postsList, postsRetry, postsUpdate, postsValidate, profilesCreate, profilesDelete, profilesGet, profilesList, profilesUpdate, setBrandKind, setCommercialDisclosure, tiktokCreatorInfo, tiktokDurationError, tiktokOptionsFromSettings, tiktokOptionsReady, tiktokPrivacyLabel, tiktokSettings, toggleInteraction, tokensMint, uploadFile, waitForMedia, webhooksCreateEndpoint, webhooksCreatePortal, webhooksDeleteEndpoint, webhooksGetEndpoint, webhooksListEndpoints, webhooksListEventTypes, webhooksPing, webhooksUpdateEndpoint, xPollDurationLabel };
|