@apostra/sdk 0.0.0-stage → 0.38.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/LICENSE +201 -0
- package/README.md +117 -2
- package/SKILL.md +29 -0
- package/dist/generated/client.d.ts +1092 -0
- package/dist/generated/client.js +606 -0
- package/dist/generated/metadata.d.ts +989 -0
- package/dist/generated/metadata.js +1339 -0
- package/dist/generated/types.gen.d.ts +35171 -0
- package/dist/generated/types.gen.js +2 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +3 -0
- package/dist/transport.d.ts +142 -0
- package/dist/transport.js +600 -0
- package/dist/webhooks.d.ts +24 -0
- package/dist/webhooks.js +49 -0
- package/examples/first-value.ts +58 -0
- package/llms.txt +11 -0
- package/package.json +60 -4
|
@@ -0,0 +1,989 @@
|
|
|
1
|
+
export declare const version = "0.38.0";
|
|
2
|
+
export declare const baseUrl = "https://api.apostra.com/api/v3";
|
|
3
|
+
export declare const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
|
|
4
|
+
export declare const operations: {
|
|
5
|
+
readonly downloadV3PublicDocumentRevision: {
|
|
6
|
+
readonly path: "/documents/{documentId}/revisions/{revisionId}/download";
|
|
7
|
+
readonly method: "GET";
|
|
8
|
+
readonly body: false;
|
|
9
|
+
readonly binary: true;
|
|
10
|
+
readonly idempotencyKey: false;
|
|
11
|
+
readonly parameters: readonly [{
|
|
12
|
+
readonly name: "documentId";
|
|
13
|
+
readonly location: "path";
|
|
14
|
+
readonly required: true;
|
|
15
|
+
}, {
|
|
16
|
+
readonly name: "revisionId";
|
|
17
|
+
readonly location: "path";
|
|
18
|
+
readonly required: true;
|
|
19
|
+
}];
|
|
20
|
+
readonly security: readonly [{
|
|
21
|
+
readonly apiKeyAuth: readonly [];
|
|
22
|
+
}, {
|
|
23
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
24
|
+
}];
|
|
25
|
+
readonly summary: "Download a public immutable document revision";
|
|
26
|
+
};
|
|
27
|
+
readonly generate_variants: {
|
|
28
|
+
readonly path: "/tools/generate_variants";
|
|
29
|
+
readonly method: "POST";
|
|
30
|
+
readonly body: true;
|
|
31
|
+
readonly binary: false;
|
|
32
|
+
readonly idempotencyKey: true;
|
|
33
|
+
readonly parameters: readonly [];
|
|
34
|
+
readonly security: readonly [{
|
|
35
|
+
readonly apiKeyAuth: readonly [];
|
|
36
|
+
}, {
|
|
37
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
38
|
+
}];
|
|
39
|
+
readonly summary: "Generate variants from a saved brief; use Creative Sessions for voice/audio, radio spots, and voiceovers. Send kind, scope, and variantAction; reuse actionKey only on retries.";
|
|
40
|
+
};
|
|
41
|
+
readonly get: {
|
|
42
|
+
readonly path: "/tools/get";
|
|
43
|
+
readonly method: "POST";
|
|
44
|
+
readonly body: true;
|
|
45
|
+
readonly binary: false;
|
|
46
|
+
readonly idempotencyKey: false;
|
|
47
|
+
readonly parameters: readonly [];
|
|
48
|
+
readonly security: readonly [{
|
|
49
|
+
readonly apiKeyAuth: readonly [];
|
|
50
|
+
}, {
|
|
51
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
52
|
+
}];
|
|
53
|
+
readonly summary: "Read one object by kind and id, or an account singleton without id. Never guess ids. Campaign reads return targetingOverlay to verify before proposals. include adds detail only for kinds that serve it.";
|
|
54
|
+
};
|
|
55
|
+
readonly getV3PublicDocumentRevisionSections: {
|
|
56
|
+
readonly path: "/documents/{documentId}/revisions/{revisionId}/sections";
|
|
57
|
+
readonly method: "GET";
|
|
58
|
+
readonly body: false;
|
|
59
|
+
readonly binary: false;
|
|
60
|
+
readonly idempotencyKey: false;
|
|
61
|
+
readonly parameters: readonly [{
|
|
62
|
+
readonly name: "documentId";
|
|
63
|
+
readonly location: "path";
|
|
64
|
+
readonly required: true;
|
|
65
|
+
}, {
|
|
66
|
+
readonly name: "revisionId";
|
|
67
|
+
readonly location: "path";
|
|
68
|
+
readonly required: true;
|
|
69
|
+
}, {
|
|
70
|
+
readonly name: "section";
|
|
71
|
+
readonly location: "query";
|
|
72
|
+
readonly required: false;
|
|
73
|
+
}, {
|
|
74
|
+
readonly name: "query";
|
|
75
|
+
readonly location: "query";
|
|
76
|
+
readonly required: false;
|
|
77
|
+
}, {
|
|
78
|
+
readonly name: "cursor";
|
|
79
|
+
readonly location: "query";
|
|
80
|
+
readonly required: false;
|
|
81
|
+
}, {
|
|
82
|
+
readonly name: "asOf";
|
|
83
|
+
readonly location: "query";
|
|
84
|
+
readonly required: false;
|
|
85
|
+
}];
|
|
86
|
+
readonly security: readonly [{
|
|
87
|
+
readonly apiKeyAuth: readonly [];
|
|
88
|
+
}, {
|
|
89
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
90
|
+
}];
|
|
91
|
+
readonly summary: "Read a bounded public immutable document revision";
|
|
92
|
+
};
|
|
93
|
+
readonly getV3PublicMutationReceipt: {
|
|
94
|
+
readonly path: "/receipts/{receiptId}";
|
|
95
|
+
readonly method: "GET";
|
|
96
|
+
readonly body: false;
|
|
97
|
+
readonly binary: false;
|
|
98
|
+
readonly idempotencyKey: false;
|
|
99
|
+
readonly parameters: readonly [{
|
|
100
|
+
readonly name: "receiptId";
|
|
101
|
+
readonly location: "path";
|
|
102
|
+
readonly required: true;
|
|
103
|
+
}];
|
|
104
|
+
readonly security: readonly [{
|
|
105
|
+
readonly apiKeyAuth: readonly [];
|
|
106
|
+
}, {
|
|
107
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
108
|
+
}, {
|
|
109
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
110
|
+
}];
|
|
111
|
+
readonly summary: "Read the state of a V3 HTTP write receipt";
|
|
112
|
+
};
|
|
113
|
+
readonly get_delivery: {
|
|
114
|
+
readonly path: "/tools/get_delivery";
|
|
115
|
+
readonly method: "POST";
|
|
116
|
+
readonly body: true;
|
|
117
|
+
readonly binary: false;
|
|
118
|
+
readonly idempotencyKey: false;
|
|
119
|
+
readonly parameters: readonly [];
|
|
120
|
+
readonly security: readonly [{
|
|
121
|
+
readonly apiKeyAuth: readonly [];
|
|
122
|
+
}, {
|
|
123
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
124
|
+
}];
|
|
125
|
+
readonly summary: "Query seller delivery, stored or live buyer campaign delivery, or margin facts. Use live_campaign_delivery with one campaignId for the connected provider's current response. campaign_delivery preserves stored rows, totals, and paging. Buyer measurement is excluded.";
|
|
126
|
+
};
|
|
127
|
+
readonly get_rfp_performance: {
|
|
128
|
+
readonly path: "/tools/get_rfp_performance";
|
|
129
|
+
readonly method: "POST";
|
|
130
|
+
readonly body: true;
|
|
131
|
+
readonly binary: false;
|
|
132
|
+
readonly idempotencyKey: false;
|
|
133
|
+
readonly parameters: readonly [];
|
|
134
|
+
readonly security: readonly [{
|
|
135
|
+
readonly apiKeyAuth: readonly [];
|
|
136
|
+
}, {
|
|
137
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
138
|
+
}];
|
|
139
|
+
readonly summary: "Query grouped Seller RFP quality, efficiency, and commercial metrics with metric-specific availability and immutable pages. Defaults to live terminal turns; synthetic purposes are opt-in and excluded from commercial metrics. Use get for individual RFPs or turns.";
|
|
140
|
+
};
|
|
141
|
+
readonly get_seller_reporting_receipts: {
|
|
142
|
+
readonly path: "/tools/get_seller_reporting_receipts";
|
|
143
|
+
readonly method: "POST";
|
|
144
|
+
readonly body: true;
|
|
145
|
+
readonly binary: false;
|
|
146
|
+
readonly idempotencyKey: false;
|
|
147
|
+
readonly parameters: readonly [];
|
|
148
|
+
readonly security: readonly [{
|
|
149
|
+
readonly apiKeyAuth: readonly [];
|
|
150
|
+
}, {
|
|
151
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
152
|
+
}];
|
|
153
|
+
readonly summary: "Show a seller what reporting we received for one buyer media buy, whether each receipt was accepted, and the current computed daily totals. Opens the Media Buy Timeline Glance.";
|
|
154
|
+
};
|
|
155
|
+
readonly get_status: {
|
|
156
|
+
readonly path: "/tools/get_status";
|
|
157
|
+
readonly method: "POST";
|
|
158
|
+
readonly body: true;
|
|
159
|
+
readonly binary: false;
|
|
160
|
+
readonly idempotencyKey: false;
|
|
161
|
+
readonly parameters: readonly [];
|
|
162
|
+
readonly security: readonly [{
|
|
163
|
+
readonly apiKeyAuth: readonly [];
|
|
164
|
+
}, {
|
|
165
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
166
|
+
}];
|
|
167
|
+
readonly summary: "Current account, state, blockers, exact fixes, and reachable accounts. For seller demand, use it to tell whether readiness stops requests before source calls; read before diagnosing source health, empty responses, or demand.";
|
|
168
|
+
};
|
|
169
|
+
readonly open_advertisers_page: {
|
|
170
|
+
readonly path: "/tools/open_advertisers_page";
|
|
171
|
+
readonly method: "POST";
|
|
172
|
+
readonly body: true;
|
|
173
|
+
readonly binary: false;
|
|
174
|
+
readonly idempotencyKey: false;
|
|
175
|
+
readonly parameters: readonly [];
|
|
176
|
+
readonly security: readonly [{
|
|
177
|
+
readonly apiKeyAuth: readonly [];
|
|
178
|
+
}, {
|
|
179
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
180
|
+
}];
|
|
181
|
+
readonly summary: "Open the Advertisers Page: every advertiser with its campaign and draft counts and one next action each. Use it for \"show my advertisers\" or \"where do I start\"; the Page self-fetches. To add or set up an advertiser, pass intent: \"add\". For a text answer use search(kind: \"advertiser\").";
|
|
182
|
+
};
|
|
183
|
+
readonly open_agent_page: {
|
|
184
|
+
readonly path: "/tools/open_agent_page";
|
|
185
|
+
readonly method: "POST";
|
|
186
|
+
readonly body: true;
|
|
187
|
+
readonly binary: false;
|
|
188
|
+
readonly idempotencyKey: false;
|
|
189
|
+
readonly parameters: readonly [];
|
|
190
|
+
readonly security: readonly [{
|
|
191
|
+
readonly apiKeyAuth: readonly [];
|
|
192
|
+
}, {
|
|
193
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
194
|
+
}];
|
|
195
|
+
readonly summary: "Open one agent owned by this Developer account.";
|
|
196
|
+
};
|
|
197
|
+
readonly open_agents_page: {
|
|
198
|
+
readonly path: "/tools/open_agents_page";
|
|
199
|
+
readonly method: "POST";
|
|
200
|
+
readonly body: true;
|
|
201
|
+
readonly binary: false;
|
|
202
|
+
readonly idempotencyKey: false;
|
|
203
|
+
readonly parameters: readonly [];
|
|
204
|
+
readonly security: readonly [{
|
|
205
|
+
readonly apiKeyAuth: readonly [];
|
|
206
|
+
}, {
|
|
207
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
208
|
+
}];
|
|
209
|
+
readonly summary: "Open Build an agent for this Developer account.";
|
|
210
|
+
};
|
|
211
|
+
readonly open_approvals: {
|
|
212
|
+
readonly path: "/tools/open_approvals";
|
|
213
|
+
readonly method: "POST";
|
|
214
|
+
readonly body: true;
|
|
215
|
+
readonly binary: false;
|
|
216
|
+
readonly idempotencyKey: false;
|
|
217
|
+
readonly parameters: readonly [];
|
|
218
|
+
readonly security: readonly [{
|
|
219
|
+
readonly apiKeyAuth: readonly [];
|
|
220
|
+
}, {
|
|
221
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
222
|
+
}];
|
|
223
|
+
readonly summary: "Open the Approvals Page for reviews, assignments, routing, evidence, decisions, and forward recovery. Focus by exact media-buy identity or reviewRef; creativeId works only for one loaded version.";
|
|
224
|
+
};
|
|
225
|
+
readonly open_campaign_receipt: {
|
|
226
|
+
readonly path: "/tools/open_campaign_receipt";
|
|
227
|
+
readonly method: "POST";
|
|
228
|
+
readonly body: true;
|
|
229
|
+
readonly binary: false;
|
|
230
|
+
readonly idempotencyKey: false;
|
|
231
|
+
readonly parameters: readonly [];
|
|
232
|
+
readonly security: readonly [{
|
|
233
|
+
readonly apiKeyAuth: readonly [];
|
|
234
|
+
}, {
|
|
235
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
236
|
+
}];
|
|
237
|
+
readonly summary: "Open Review & go live for one draft campaign: budget, flight, staged media buys and their budget split, why each buy is not live yet, and the readiness blockers. Use when a buyer asks if a draft is ready to launch. Refuses non-draft campaigns; launching stays a separate confirmed save_campaign.";
|
|
238
|
+
};
|
|
239
|
+
readonly open_campaigns_page: {
|
|
240
|
+
readonly path: "/tools/open_campaigns_page";
|
|
241
|
+
readonly method: "POST";
|
|
242
|
+
readonly body: true;
|
|
243
|
+
readonly binary: false;
|
|
244
|
+
readonly idempotencyKey: false;
|
|
245
|
+
readonly parameters: readonly [];
|
|
246
|
+
readonly security: readonly [{
|
|
247
|
+
readonly apiKeyAuth: readonly [];
|
|
248
|
+
}, {
|
|
249
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
250
|
+
}];
|
|
251
|
+
readonly summary: "Open the Campaigns Page: campaigns with status, flight, and budget; open one for its media buys and creatives. The Page self-fetches, so do not list campaigns in prose. advertiserId scopes to one advertiser; campaignId focuses one campaign. A draft's go-live review is open_campaign_receipt.";
|
|
252
|
+
};
|
|
253
|
+
readonly open_connections_page: {
|
|
254
|
+
readonly path: "/tools/open_connections_page";
|
|
255
|
+
readonly method: "POST";
|
|
256
|
+
readonly body: true;
|
|
257
|
+
readonly binary: false;
|
|
258
|
+
readonly idempotencyKey: false;
|
|
259
|
+
readonly parameters: readonly [];
|
|
260
|
+
readonly security: readonly [{
|
|
261
|
+
readonly apiKeyAuth: readonly [];
|
|
262
|
+
}, {
|
|
263
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
264
|
+
}];
|
|
265
|
+
readonly summary: "Open the buyer Media Partners Page. Optionally scope to an advertiser or seller; connectionAction \"connect\" opens that media partner at connection setup without mutating until the user confirms.";
|
|
266
|
+
};
|
|
267
|
+
readonly open_creative_engines_page: {
|
|
268
|
+
readonly path: "/tools/open_creative_engines_page";
|
|
269
|
+
readonly method: "POST";
|
|
270
|
+
readonly body: true;
|
|
271
|
+
readonly binary: false;
|
|
272
|
+
readonly idempotencyKey: false;
|
|
273
|
+
readonly parameters: readonly [];
|
|
274
|
+
readonly security: readonly [{
|
|
275
|
+
readonly apiKeyAuth: readonly [];
|
|
276
|
+
}, {
|
|
277
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
278
|
+
}];
|
|
279
|
+
readonly summary: "Open the buyer Creative Engines Page. Optionally focus an engine, connection, or its secure setup control; the buyer starts setup in the Page, and this does not authorize a provider or start generation.";
|
|
280
|
+
};
|
|
281
|
+
readonly open_creative_library: {
|
|
282
|
+
readonly path: "/tools/open_creative_library";
|
|
283
|
+
readonly method: "POST";
|
|
284
|
+
readonly body: true;
|
|
285
|
+
readonly binary: false;
|
|
286
|
+
readonly idempotencyKey: true;
|
|
287
|
+
readonly parameters: readonly [];
|
|
288
|
+
readonly security: readonly [{
|
|
289
|
+
readonly apiKeyAuth: readonly [];
|
|
290
|
+
}, {
|
|
291
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
292
|
+
}];
|
|
293
|
+
readonly summary: "Open Creative Library. Use search for a plain object answer. Composer needs campaignId; assembly needs no Creative Engine. To save a draft, use exactly one format: a canonical format such as image, hosted video, or hosted audio, or a seller format.";
|
|
294
|
+
};
|
|
295
|
+
readonly open_media_buys_page: {
|
|
296
|
+
readonly path: "/tools/open_media_buys_page";
|
|
297
|
+
readonly method: "POST";
|
|
298
|
+
readonly body: true;
|
|
299
|
+
readonly binary: false;
|
|
300
|
+
readonly idempotencyKey: false;
|
|
301
|
+
readonly parameters: readonly [];
|
|
302
|
+
readonly security: readonly [{
|
|
303
|
+
readonly apiKeyAuth: readonly [];
|
|
304
|
+
}, {
|
|
305
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
306
|
+
}];
|
|
307
|
+
readonly summary: "Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches.";
|
|
308
|
+
};
|
|
309
|
+
readonly open_page: {
|
|
310
|
+
readonly path: "/tools/open_page";
|
|
311
|
+
readonly method: "POST";
|
|
312
|
+
readonly body: true;
|
|
313
|
+
readonly binary: false;
|
|
314
|
+
readonly idempotencyKey: false;
|
|
315
|
+
readonly parameters: readonly [];
|
|
316
|
+
readonly security: readonly [{
|
|
317
|
+
readonly apiKeyAuth: readonly [];
|
|
318
|
+
}, {
|
|
319
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
320
|
+
}];
|
|
321
|
+
readonly summary: "Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies.";
|
|
322
|
+
};
|
|
323
|
+
readonly open_proposal_pass: {
|
|
324
|
+
readonly path: "/tools/open_proposal_pass";
|
|
325
|
+
readonly method: "POST";
|
|
326
|
+
readonly body: true;
|
|
327
|
+
readonly binary: false;
|
|
328
|
+
readonly idempotencyKey: false;
|
|
329
|
+
readonly parameters: readonly [];
|
|
330
|
+
readonly security: readonly [{
|
|
331
|
+
readonly apiKeyAuth: readonly [];
|
|
332
|
+
}, {
|
|
333
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
334
|
+
}];
|
|
335
|
+
readonly summary: "Open Proposal Pass on one exact immutable RFP turn. Supply the matching rfpId and turnId from save_rfp or get; the Page loads the private response itself.";
|
|
336
|
+
};
|
|
337
|
+
readonly open_seller_dashboard: {
|
|
338
|
+
readonly path: "/tools/open_seller_dashboard";
|
|
339
|
+
readonly method: "POST";
|
|
340
|
+
readonly body: true;
|
|
341
|
+
readonly binary: false;
|
|
342
|
+
readonly idempotencyKey: false;
|
|
343
|
+
readonly parameters: readonly [];
|
|
344
|
+
readonly security: readonly [{
|
|
345
|
+
readonly apiKeyAuth: readonly [];
|
|
346
|
+
}, {
|
|
347
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
348
|
+
}];
|
|
349
|
+
readonly summary: "Open the Seller Dashboard Page: seller analytics, or the synthetic evaluation view of practice runs while this is an active demo Seller Account. The Page self-fetches.";
|
|
350
|
+
};
|
|
351
|
+
readonly open_variant_gallery: {
|
|
352
|
+
readonly path: "/tools/open_variant_gallery";
|
|
353
|
+
readonly method: "POST";
|
|
354
|
+
readonly body: true;
|
|
355
|
+
readonly binary: false;
|
|
356
|
+
readonly idempotencyKey: false;
|
|
357
|
+
readonly parameters: readonly [];
|
|
358
|
+
readonly security: readonly [{
|
|
359
|
+
readonly apiKeyAuth: readonly [];
|
|
360
|
+
}, {
|
|
361
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
362
|
+
}];
|
|
363
|
+
readonly summary: "Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants.";
|
|
364
|
+
};
|
|
365
|
+
readonly refresh_inventory_source_health: {
|
|
366
|
+
readonly path: "/tools/refresh_inventory_source_health";
|
|
367
|
+
readonly method: "POST";
|
|
368
|
+
readonly body: true;
|
|
369
|
+
readonly binary: false;
|
|
370
|
+
readonly idempotencyKey: true;
|
|
371
|
+
readonly parameters: readonly [];
|
|
372
|
+
readonly security: readonly [{
|
|
373
|
+
readonly apiKeyAuth: readonly [];
|
|
374
|
+
}, {
|
|
375
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
376
|
+
}];
|
|
377
|
+
readonly summary: "Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy.";
|
|
378
|
+
};
|
|
379
|
+
readonly request_buyer_child_account: {
|
|
380
|
+
readonly path: "/tools/request_buyer_child_account";
|
|
381
|
+
readonly method: "POST";
|
|
382
|
+
readonly body: true;
|
|
383
|
+
readonly binary: false;
|
|
384
|
+
readonly idempotencyKey: true;
|
|
385
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
386
|
+
readonly parameters: readonly [];
|
|
387
|
+
readonly security: readonly [{
|
|
388
|
+
readonly apiKeyAuth: readonly [];
|
|
389
|
+
}, {
|
|
390
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
391
|
+
}];
|
|
392
|
+
readonly summary: "Request a Buyer child under the selected Organization. Nothing is created until an Organization administrator approves it on our site; the result is approval_required with a link to show the person. Repeat with the same idempotencyKey and name for the outcome.";
|
|
393
|
+
};
|
|
394
|
+
readonly request_proposals: {
|
|
395
|
+
readonly path: "/tools/request_proposals";
|
|
396
|
+
readonly method: "POST";
|
|
397
|
+
readonly body: true;
|
|
398
|
+
readonly binary: false;
|
|
399
|
+
readonly idempotencyKey: true;
|
|
400
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
401
|
+
readonly parameters: readonly [];
|
|
402
|
+
readonly security: readonly [{
|
|
403
|
+
readonly apiKeyAuth: readonly [];
|
|
404
|
+
}, {
|
|
405
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
406
|
+
}];
|
|
407
|
+
readonly summary: "Request quotes/products. With a MediaBuy cap, only quotes confirming the exact cap are usable. sellerIds fail closed; campaign-only lists use eligible subset. Broadcast needs confirmBroadcast:true.";
|
|
408
|
+
};
|
|
409
|
+
readonly request_seller_reporting_update: {
|
|
410
|
+
readonly path: "/tools/request_seller_reporting_update";
|
|
411
|
+
readonly method: "POST";
|
|
412
|
+
readonly body: true;
|
|
413
|
+
readonly binary: false;
|
|
414
|
+
readonly idempotencyKey: true;
|
|
415
|
+
readonly parameters: readonly [];
|
|
416
|
+
readonly security: readonly [{
|
|
417
|
+
readonly apiKeyAuth: readonly [];
|
|
418
|
+
}, {
|
|
419
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
420
|
+
}];
|
|
421
|
+
readonly summary: "Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.";
|
|
422
|
+
};
|
|
423
|
+
readonly review_buyer_child_account: {
|
|
424
|
+
readonly path: "/tools/review_buyer_child_account";
|
|
425
|
+
readonly method: "POST";
|
|
426
|
+
readonly body: true;
|
|
427
|
+
readonly binary: false;
|
|
428
|
+
readonly idempotencyKey: false;
|
|
429
|
+
readonly parameters: readonly [];
|
|
430
|
+
readonly security: readonly [{
|
|
431
|
+
readonly apiKeyAuth: readonly [];
|
|
432
|
+
}, {
|
|
433
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
434
|
+
}];
|
|
435
|
+
readonly summary: "Review a Buyer child under the selected Organization: name, role, capacity, plan coverage, operator, inherited access and other effects. Read-only; nothing is created. Show the review to the person, then call request_buyer_child_account.";
|
|
436
|
+
};
|
|
437
|
+
readonly save_account: {
|
|
438
|
+
readonly path: "/tools/save_account";
|
|
439
|
+
readonly method: "POST";
|
|
440
|
+
readonly body: true;
|
|
441
|
+
readonly binary: false;
|
|
442
|
+
readonly idempotencyKey: true;
|
|
443
|
+
readonly parameters: readonly [];
|
|
444
|
+
readonly security: readonly [{
|
|
445
|
+
readonly apiKeyAuth: readonly [];
|
|
446
|
+
}, {
|
|
447
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
448
|
+
}];
|
|
449
|
+
readonly summary: "Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes.";
|
|
450
|
+
};
|
|
451
|
+
readonly save_advertiser: {
|
|
452
|
+
readonly path: "/tools/save_advertiser";
|
|
453
|
+
readonly method: "POST";
|
|
454
|
+
readonly body: true;
|
|
455
|
+
readonly binary: false;
|
|
456
|
+
readonly idempotencyKey: true;
|
|
457
|
+
readonly parameters: readonly [];
|
|
458
|
+
readonly security: readonly [{
|
|
459
|
+
readonly apiKeyAuth: readonly [];
|
|
460
|
+
}, {
|
|
461
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
462
|
+
}];
|
|
463
|
+
readonly summary: "Save an advertiser or mappings. Buyer privateNotes: owning Buyer Account only; /v3/manage-ads#private-advertiser-notes. Confirm markets/channels (footprintProposal); needs_input=ask; never recreate for currency. Brand: identityContract:confirmed-v1; preview: resolveBrand; read advertiser.brandRef.";
|
|
464
|
+
};
|
|
465
|
+
readonly save_advertiser_access: {
|
|
466
|
+
readonly path: "/tools/save_advertiser_access";
|
|
467
|
+
readonly method: "POST";
|
|
468
|
+
readonly body: true;
|
|
469
|
+
readonly binary: false;
|
|
470
|
+
readonly idempotencyKey: true;
|
|
471
|
+
readonly parameters: readonly [];
|
|
472
|
+
readonly security: readonly [{
|
|
473
|
+
readonly apiKeyAuth: readonly [];
|
|
474
|
+
}, {
|
|
475
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
476
|
+
}];
|
|
477
|
+
readonly summary: "Invite a client to one of your advertisers, approve, suspend, reactivate, or revoke a client, or change a client's role. Read get kind advertiser_access first and use only what it offers. Needs an organization administrator signed in directly.";
|
|
478
|
+
};
|
|
479
|
+
readonly save_advertiser_grant: {
|
|
480
|
+
readonly path: "/tools/save_advertiser_grant";
|
|
481
|
+
readonly method: "POST";
|
|
482
|
+
readonly body: true;
|
|
483
|
+
readonly binary: false;
|
|
484
|
+
readonly idempotencyKey: true;
|
|
485
|
+
readonly parameters: readonly [];
|
|
486
|
+
readonly security: readonly [{
|
|
487
|
+
readonly apiKeyAuth: readonly [];
|
|
488
|
+
}, {
|
|
489
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
490
|
+
}];
|
|
491
|
+
readonly summary: "Invite another Organization to exact advertisers, accept/reject an invitation, or revoke a grant. Limited beta: eligible Organization, entitlement, server-side exposure, and direct human-admin authority are required.";
|
|
492
|
+
};
|
|
493
|
+
readonly save_advertiser_instructions: {
|
|
494
|
+
readonly path: "/tools/save_advertiser_instructions";
|
|
495
|
+
readonly method: "POST";
|
|
496
|
+
readonly body: true;
|
|
497
|
+
readonly binary: false;
|
|
498
|
+
readonly idempotencyKey: true;
|
|
499
|
+
readonly parameters: readonly [];
|
|
500
|
+
readonly security: readonly [{
|
|
501
|
+
readonly apiKeyAuth: readonly [];
|
|
502
|
+
}, {
|
|
503
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
504
|
+
}];
|
|
505
|
+
readonly summary: "Seller-only CRM notes for an exact brand × operator pair. Buyers use save_advertiser.privateNotes; see /v3/manage-ads#private-advertiser-notes. Effective discounts, routing, access and trust are read-only.";
|
|
506
|
+
};
|
|
507
|
+
readonly save_agent: {
|
|
508
|
+
readonly path: "/tools/save_agent";
|
|
509
|
+
readonly method: "POST";
|
|
510
|
+
readonly body: true;
|
|
511
|
+
readonly binary: false;
|
|
512
|
+
readonly idempotencyKey: true;
|
|
513
|
+
readonly parameters: readonly [];
|
|
514
|
+
readonly security: readonly [{
|
|
515
|
+
readonly apiKeyAuth: readonly [];
|
|
516
|
+
}, {
|
|
517
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
518
|
+
}];
|
|
519
|
+
readonly summary: "Save a Sales Agent mode, register an Agent, or update an owned Agent: rename it or say it is ready for certification. Select seller_save, developer_create, or developer_update.";
|
|
520
|
+
};
|
|
521
|
+
readonly save_ask: {
|
|
522
|
+
readonly path: "/tools/save_ask";
|
|
523
|
+
readonly method: "POST";
|
|
524
|
+
readonly body: true;
|
|
525
|
+
readonly binary: false;
|
|
526
|
+
readonly idempotencyKey: true;
|
|
527
|
+
readonly parameters: readonly [];
|
|
528
|
+
readonly security: readonly [{
|
|
529
|
+
readonly apiKeyAuth: readonly [];
|
|
530
|
+
}, {
|
|
531
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
532
|
+
}];
|
|
533
|
+
readonly summary: "File or update a typed ask in the Apostra Support workflow; returns askId. Supply is buyer inventory. Call immediately with type support when a person explicitly asks for a human; do not diagnose first.";
|
|
534
|
+
};
|
|
535
|
+
readonly save_audience: {
|
|
536
|
+
readonly path: "/tools/save_audience";
|
|
537
|
+
readonly method: "POST";
|
|
538
|
+
readonly body: true;
|
|
539
|
+
readonly binary: false;
|
|
540
|
+
readonly idempotencyKey: true;
|
|
541
|
+
readonly parameters: readonly [];
|
|
542
|
+
readonly security: readonly [{
|
|
543
|
+
readonly apiKeyAuth: readonly [];
|
|
544
|
+
}, {
|
|
545
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
546
|
+
}];
|
|
547
|
+
readonly summary: "Sync first-party CRM audiences for a buyer advertiser. Each audiences[] item may add, remove, or delete members. Returns an operationId; use get(kind: audience, advertiserId: \"...\") to read match status after it settles.";
|
|
548
|
+
};
|
|
549
|
+
readonly save_billing: {
|
|
550
|
+
readonly path: "/tools/save_billing";
|
|
551
|
+
readonly method: "POST";
|
|
552
|
+
readonly body: true;
|
|
553
|
+
readonly binary: false;
|
|
554
|
+
readonly idempotencyKey: true;
|
|
555
|
+
readonly parameters: readonly [];
|
|
556
|
+
readonly security: readonly [{
|
|
557
|
+
readonly apiKeyAuth: readonly [];
|
|
558
|
+
}, {
|
|
559
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
560
|
+
}];
|
|
561
|
+
readonly summary: "Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP.";
|
|
562
|
+
};
|
|
563
|
+
readonly save_business_rules: {
|
|
564
|
+
readonly path: "/tools/save_business_rules";
|
|
565
|
+
readonly method: "POST";
|
|
566
|
+
readonly body: true;
|
|
567
|
+
readonly binary: false;
|
|
568
|
+
readonly idempotencyKey: true;
|
|
569
|
+
readonly parameters: readonly [];
|
|
570
|
+
readonly security: readonly [{
|
|
571
|
+
readonly apiKeyAuth: readonly [];
|
|
572
|
+
}, {
|
|
573
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
574
|
+
}];
|
|
575
|
+
readonly summary: "Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.";
|
|
576
|
+
};
|
|
577
|
+
readonly save_buyer_agent: {
|
|
578
|
+
readonly path: "/tools/save_buyer_agent";
|
|
579
|
+
readonly method: "POST";
|
|
580
|
+
readonly body: true;
|
|
581
|
+
readonly binary: false;
|
|
582
|
+
readonly idempotencyKey: true;
|
|
583
|
+
readonly parameters: readonly [];
|
|
584
|
+
readonly security: readonly [{
|
|
585
|
+
readonly apiKeyAuth: readonly [];
|
|
586
|
+
}, {
|
|
587
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
588
|
+
}];
|
|
589
|
+
readonly summary: "Create or manage one buyer agent.";
|
|
590
|
+
};
|
|
591
|
+
readonly save_buyer_operator: {
|
|
592
|
+
readonly path: "/tools/save_buyer_operator";
|
|
593
|
+
readonly method: "POST";
|
|
594
|
+
readonly body: true;
|
|
595
|
+
readonly binary: false;
|
|
596
|
+
readonly idempotencyKey: true;
|
|
597
|
+
readonly parameters: readonly [];
|
|
598
|
+
readonly security: readonly [{
|
|
599
|
+
readonly apiKeyAuth: readonly [];
|
|
600
|
+
}, {
|
|
601
|
+
readonly m2mOAuth: readonly ["interchange:admin"];
|
|
602
|
+
}];
|
|
603
|
+
readonly summary: "Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.";
|
|
604
|
+
};
|
|
605
|
+
readonly save_campaign: {
|
|
606
|
+
readonly path: "/tools/save_campaign";
|
|
607
|
+
readonly method: "POST";
|
|
608
|
+
readonly body: true;
|
|
609
|
+
readonly binary: false;
|
|
610
|
+
readonly idempotencyKey: true;
|
|
611
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
612
|
+
readonly parameters: readonly [];
|
|
613
|
+
readonly security: readonly [{
|
|
614
|
+
readonly apiKeyAuth: readonly [];
|
|
615
|
+
}, {
|
|
616
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
617
|
+
}];
|
|
618
|
+
readonly summary: "Save a campaign. To create, send advertiserId and name; flight and budget are optional. Split inventory into media buys. Set desiredPhase: active to launch; omit confirmLaunch to preview. Cancellation is irreversible: desiredPhase: canceled cancels the campaign and every live media buy.";
|
|
619
|
+
};
|
|
620
|
+
readonly save_catalog: {
|
|
621
|
+
readonly path: "/tools/save_catalog";
|
|
622
|
+
readonly method: "POST";
|
|
623
|
+
readonly body: true;
|
|
624
|
+
readonly binary: false;
|
|
625
|
+
readonly idempotencyKey: true;
|
|
626
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
627
|
+
readonly parameters: readonly [];
|
|
628
|
+
readonly security: readonly [{
|
|
629
|
+
readonly apiKeyAuth: readonly [];
|
|
630
|
+
}, {
|
|
631
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
632
|
+
}];
|
|
633
|
+
readonly summary: "Create or replace a catalog: type and exactly one of url (feed URL) or non-empty items are required. If missing, ask the buyer for the feed URL or items before calling. URL saves refetch the feed. To archive, set isArchived: true with identity only; type, url and items are not needed.";
|
|
634
|
+
};
|
|
635
|
+
readonly save_connection: {
|
|
636
|
+
readonly path: "/tools/save_connection";
|
|
637
|
+
readonly method: "POST";
|
|
638
|
+
readonly body: true;
|
|
639
|
+
readonly binary: false;
|
|
640
|
+
readonly idempotencyKey: true;
|
|
641
|
+
readonly parameters: readonly [];
|
|
642
|
+
readonly security: readonly [{
|
|
643
|
+
readonly apiKeyAuth: readonly [];
|
|
644
|
+
}, {
|
|
645
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
646
|
+
}];
|
|
647
|
+
readonly summary: "Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.";
|
|
648
|
+
};
|
|
649
|
+
readonly save_coverage: {
|
|
650
|
+
readonly path: "/tools/save_coverage";
|
|
651
|
+
readonly method: "POST";
|
|
652
|
+
readonly body: true;
|
|
653
|
+
readonly binary: false;
|
|
654
|
+
readonly idempotencyKey: true;
|
|
655
|
+
readonly parameters: readonly [];
|
|
656
|
+
readonly security: readonly [{
|
|
657
|
+
readonly apiKeyAuth: readonly [];
|
|
658
|
+
}, {
|
|
659
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
660
|
+
}];
|
|
661
|
+
readonly summary: "Declare publisher domains this Seller sells and its claimed properties. `domains` replaces the complete set; `add`, `remove`, `declareProperties`, and `removeProperties` change named items only. Read authorization; never assume it.";
|
|
662
|
+
};
|
|
663
|
+
readonly save_creative: {
|
|
664
|
+
readonly path: "/tools/save_creative";
|
|
665
|
+
readonly method: "POST";
|
|
666
|
+
readonly body: true;
|
|
667
|
+
readonly binary: false;
|
|
668
|
+
readonly idempotencyKey: true;
|
|
669
|
+
readonly parameters: readonly [];
|
|
670
|
+
readonly security: readonly [{
|
|
671
|
+
readonly apiKeyAuth: readonly [];
|
|
672
|
+
}, {
|
|
673
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
674
|
+
}];
|
|
675
|
+
readonly summary: "Save creative in advertiserId/campaignId with name, message, assets, clickUrl, social, sourceAssetRef/sourceAssets. Use exactly one format selector: formatKind/formatParams, creativeFormatId, formatOptionRef. Supplied content/assets only; generate new media (radio spots) via save_creative_session.";
|
|
676
|
+
};
|
|
677
|
+
readonly save_creative_collection: {
|
|
678
|
+
readonly path: "/tools/save_creative_collection";
|
|
679
|
+
readonly method: "POST";
|
|
680
|
+
readonly body: true;
|
|
681
|
+
readonly binary: false;
|
|
682
|
+
readonly idempotencyKey: true;
|
|
683
|
+
readonly parameters: readonly [];
|
|
684
|
+
readonly security: readonly [{
|
|
685
|
+
readonly apiKeyAuth: readonly [];
|
|
686
|
+
}, {
|
|
687
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
688
|
+
}];
|
|
689
|
+
readonly summary: "Manage collections. Create with one owner and name: campaignId or advertiserId. Only advertiser mutations of an existing collection need expectedUpdatedAt; campaign writes and creates do not. isArchived archives or restores advertiser collections.";
|
|
690
|
+
};
|
|
691
|
+
readonly save_creative_session: {
|
|
692
|
+
readonly path: "/tools/save_creative_session";
|
|
693
|
+
readonly method: "POST";
|
|
694
|
+
readonly body: true;
|
|
695
|
+
readonly binary: false;
|
|
696
|
+
readonly idempotencyKey: true;
|
|
697
|
+
readonly parameters: readonly [];
|
|
698
|
+
readonly security: readonly [{
|
|
699
|
+
readonly apiKeyAuth: readonly [];
|
|
700
|
+
}, {
|
|
701
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
702
|
+
}];
|
|
703
|
+
readonly summary: "Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId.";
|
|
704
|
+
};
|
|
705
|
+
readonly save_dimension: {
|
|
706
|
+
readonly path: "/tools/save_dimension";
|
|
707
|
+
readonly method: "POST";
|
|
708
|
+
readonly body: true;
|
|
709
|
+
readonly binary: false;
|
|
710
|
+
readonly idempotencyKey: true;
|
|
711
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
712
|
+
readonly parameters: readonly [];
|
|
713
|
+
readonly security: readonly [{
|
|
714
|
+
readonly apiKeyAuth: readonly [];
|
|
715
|
+
}, {
|
|
716
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
717
|
+
}];
|
|
718
|
+
readonly summary: "Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo.";
|
|
719
|
+
};
|
|
720
|
+
readonly save_directed_campaign_subscription: {
|
|
721
|
+
readonly path: "/tools/save_directed_campaign_subscription";
|
|
722
|
+
readonly method: "POST";
|
|
723
|
+
readonly body: true;
|
|
724
|
+
readonly binary: false;
|
|
725
|
+
readonly idempotencyKey: true;
|
|
726
|
+
readonly parameters: readonly [];
|
|
727
|
+
readonly security: readonly [{
|
|
728
|
+
readonly apiKeyAuth: readonly [];
|
|
729
|
+
}, {
|
|
730
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
731
|
+
}];
|
|
732
|
+
readonly summary: "Import native campaigns from Spotify Ads Manager or other platforms, including future-start campaigns, as read-only mirrors. Confirm ongoing sync first. No provider changes. /v3/import-existing-campaigns.";
|
|
733
|
+
};
|
|
734
|
+
readonly save_event_source: {
|
|
735
|
+
readonly path: "/tools/save_event_source";
|
|
736
|
+
readonly method: "POST";
|
|
737
|
+
readonly body: true;
|
|
738
|
+
readonly binary: false;
|
|
739
|
+
readonly idempotencyKey: true;
|
|
740
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
741
|
+
readonly parameters: readonly [];
|
|
742
|
+
readonly security: readonly [{
|
|
743
|
+
readonly apiKeyAuth: readonly [];
|
|
744
|
+
}, {
|
|
745
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
746
|
+
}];
|
|
747
|
+
readonly summary: "Create, change, archive, or restore up to 50 advertiser conversion event sources (pixels, server feeds). Each entry is keyed by eventSourceId and succeeds or fails alone. Setup is not proof events flow: check health with get, then use eventSourceId in an optimization goal.";
|
|
748
|
+
};
|
|
749
|
+
readonly save_inventory_source: {
|
|
750
|
+
readonly path: "/tools/save_inventory_source";
|
|
751
|
+
readonly method: "POST";
|
|
752
|
+
readonly body: true;
|
|
753
|
+
readonly binary: false;
|
|
754
|
+
readonly idempotencyKey: true;
|
|
755
|
+
readonly parameters: readonly [];
|
|
756
|
+
readonly security: readonly [{
|
|
757
|
+
readonly apiKeyAuth: readonly [];
|
|
758
|
+
}, {
|
|
759
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
760
|
+
}];
|
|
761
|
+
readonly summary: "Create or update where a seller's inventory comes from. Pass `id` to change an existing source, omit it to add one. Credentials are never passed here — a source that needs a secret comes back with the state and the page that collects it.";
|
|
762
|
+
};
|
|
763
|
+
readonly save_lesson: {
|
|
764
|
+
readonly path: "/tools/save_lesson";
|
|
765
|
+
readonly method: "POST";
|
|
766
|
+
readonly body: true;
|
|
767
|
+
readonly binary: false;
|
|
768
|
+
readonly idempotencyKey: true;
|
|
769
|
+
readonly parameters: readonly [];
|
|
770
|
+
readonly security: readonly [{
|
|
771
|
+
readonly apiKeyAuth: readonly [];
|
|
772
|
+
}, {
|
|
773
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
774
|
+
}];
|
|
775
|
+
readonly summary: "Manage seller lessons. propose requires lesson; approve and retire require lessonId; preview requires lessonId and brief. Preserve seller words from a private Session note and ask if kind or scope is unclear.";
|
|
776
|
+
};
|
|
777
|
+
readonly save_library_request: {
|
|
778
|
+
readonly path: "/tools/save_library_request";
|
|
779
|
+
readonly method: "POST";
|
|
780
|
+
readonly body: true;
|
|
781
|
+
readonly binary: false;
|
|
782
|
+
readonly idempotencyKey: true;
|
|
783
|
+
readonly parameters: readonly [];
|
|
784
|
+
readonly security: readonly [{
|
|
785
|
+
readonly apiKeyAuth: readonly [];
|
|
786
|
+
}, {
|
|
787
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
788
|
+
}];
|
|
789
|
+
readonly summary: "Open a seller library request or close it with seller Material.";
|
|
790
|
+
};
|
|
791
|
+
readonly save_material: {
|
|
792
|
+
readonly path: "/tools/save_material";
|
|
793
|
+
readonly method: "POST";
|
|
794
|
+
readonly body: true;
|
|
795
|
+
readonly binary: false;
|
|
796
|
+
readonly idempotencyKey: true;
|
|
797
|
+
readonly parameters: readonly [];
|
|
798
|
+
readonly security: readonly [{
|
|
799
|
+
readonly apiKeyAuth: readonly [];
|
|
800
|
+
}, {
|
|
801
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
802
|
+
}];
|
|
803
|
+
readonly summary: "Register, revise, archive, restore, or reprocess seller Materials; manage candidate decisions and receipts; mark a slide, page, or sheet reusable only when it has no commercial figures (UNIT_NOT_REUSABLE_KIND rejects document containers, UNIT_CONTAINS_PRICING rejects priced units).";
|
|
804
|
+
};
|
|
805
|
+
readonly save_media_buy: {
|
|
806
|
+
readonly path: "/tools/save_media_buy";
|
|
807
|
+
readonly method: "POST";
|
|
808
|
+
readonly body: true;
|
|
809
|
+
readonly binary: false;
|
|
810
|
+
readonly idempotencyKey: true;
|
|
811
|
+
readonly bodyKeyField: "idempotencyKey";
|
|
812
|
+
readonly parameters: readonly [];
|
|
813
|
+
readonly security: readonly [{
|
|
814
|
+
readonly apiKeyAuth: readonly [];
|
|
815
|
+
}, {
|
|
816
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
817
|
+
}];
|
|
818
|
+
readonly summary: "Create DRAFT buy; no spend until confirmed. Meta: shared campaign=seller_optimized; ad sets=fixed; ask if unclear. Shared: omit buy/product budgets. Pause/resume: mediaBuyId + isPaused. Proposal: flight + total budget; omit products. channelGroupId: required if grouped; invalid ungrouped/updates.";
|
|
819
|
+
};
|
|
820
|
+
readonly save_media_kit: {
|
|
821
|
+
readonly path: "/tools/save_media_kit";
|
|
822
|
+
readonly method: "POST";
|
|
823
|
+
readonly body: true;
|
|
824
|
+
readonly binary: false;
|
|
825
|
+
readonly idempotencyKey: true;
|
|
826
|
+
readonly parameters: readonly [];
|
|
827
|
+
readonly security: readonly [{
|
|
828
|
+
readonly apiKeyAuth: readonly [];
|
|
829
|
+
}, {
|
|
830
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
831
|
+
}];
|
|
832
|
+
readonly summary: "Deprecated compatibility tool (\"listing\" is the modern term). It writes only the legacy businessProfile and does not update the canonical buyer-visible listing. New clients must read with `get({ kind: \"seller\", include: [\"listing\"] })` and write with `save_seller`.";
|
|
833
|
+
};
|
|
834
|
+
readonly save_notification_config: {
|
|
835
|
+
readonly path: "/tools/save_notification_config";
|
|
836
|
+
readonly method: "POST";
|
|
837
|
+
readonly body: true;
|
|
838
|
+
readonly binary: false;
|
|
839
|
+
readonly idempotencyKey: true;
|
|
840
|
+
readonly parameters: readonly [];
|
|
841
|
+
readonly security: readonly [{
|
|
842
|
+
readonly apiKeyAuth: readonly [];
|
|
843
|
+
}, {
|
|
844
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
845
|
+
}];
|
|
846
|
+
readonly summary: "Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.";
|
|
847
|
+
};
|
|
848
|
+
readonly save_playbook: {
|
|
849
|
+
readonly path: "/tools/save_playbook";
|
|
850
|
+
readonly method: "POST";
|
|
851
|
+
readonly body: true;
|
|
852
|
+
readonly binary: false;
|
|
853
|
+
readonly idempotencyKey: true;
|
|
854
|
+
readonly parameters: readonly [];
|
|
855
|
+
readonly security: readonly [{
|
|
856
|
+
readonly apiKeyAuth: readonly [];
|
|
857
|
+
}, {
|
|
858
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
859
|
+
}];
|
|
860
|
+
readonly summary: "Write how the seller sells. `active` creates and activates a new version in one step — no separate activate; the response names the version created and replaced. `pricing` replaces the whole fact list. `discounts` sets or removes brand/operator rules one by one. Halves never roll back each other.";
|
|
861
|
+
};
|
|
862
|
+
readonly save_property_list: {
|
|
863
|
+
readonly path: "/tools/save_property_list";
|
|
864
|
+
readonly method: "POST";
|
|
865
|
+
readonly body: true;
|
|
866
|
+
readonly binary: false;
|
|
867
|
+
readonly idempotencyKey: true;
|
|
868
|
+
readonly parameters: readonly [];
|
|
869
|
+
readonly security: readonly [{
|
|
870
|
+
readonly apiKeyAuth: readonly [];
|
|
871
|
+
}, {
|
|
872
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
873
|
+
}];
|
|
874
|
+
readonly summary: "Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.";
|
|
875
|
+
};
|
|
876
|
+
readonly save_rfp: {
|
|
877
|
+
readonly path: "/tools/save_rfp";
|
|
878
|
+
readonly method: "POST";
|
|
879
|
+
readonly body: true;
|
|
880
|
+
readonly binary: false;
|
|
881
|
+
readonly idempotencyKey: true;
|
|
882
|
+
readonly parameters: readonly [];
|
|
883
|
+
readonly security: readonly [{
|
|
884
|
+
readonly apiKeyAuth: readonly [];
|
|
885
|
+
}, {
|
|
886
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
887
|
+
}];
|
|
888
|
+
readonly summary: "Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.";
|
|
889
|
+
};
|
|
890
|
+
readonly save_seller: {
|
|
891
|
+
readonly path: "/tools/save_seller";
|
|
892
|
+
readonly method: "POST";
|
|
893
|
+
readonly body: true;
|
|
894
|
+
readonly binary: false;
|
|
895
|
+
readonly idempotencyKey: true;
|
|
896
|
+
readonly parameters: readonly [];
|
|
897
|
+
readonly security: readonly [{
|
|
898
|
+
readonly apiKeyAuth: readonly [];
|
|
899
|
+
}, {
|
|
900
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
901
|
+
}];
|
|
902
|
+
readonly summary: "Save Seller identity, capabilities, Apostra listing, buyer-visible listing (mediaKit is a deprecated alias), Distribution's OpenAI challenge token, or a seller-controlled admission. Scope3 eligibility and Market Maker entitlements are read-only here. Read Distribution with get(kind:\"distribution\").";
|
|
903
|
+
};
|
|
904
|
+
readonly save_signal: {
|
|
905
|
+
readonly path: "/tools/save_signal";
|
|
906
|
+
readonly method: "POST";
|
|
907
|
+
readonly body: true;
|
|
908
|
+
readonly binary: false;
|
|
909
|
+
readonly idempotencyKey: true;
|
|
910
|
+
readonly parameters: readonly [];
|
|
911
|
+
readonly security: readonly [{
|
|
912
|
+
readonly apiKeyAuth: readonly [];
|
|
913
|
+
}, {
|
|
914
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
915
|
+
}];
|
|
916
|
+
readonly summary: "Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.";
|
|
917
|
+
};
|
|
918
|
+
readonly save_wholesale_product: {
|
|
919
|
+
readonly path: "/tools/save_wholesale_product";
|
|
920
|
+
readonly method: "POST";
|
|
921
|
+
readonly body: true;
|
|
922
|
+
readonly binary: false;
|
|
923
|
+
readonly idempotencyKey: true;
|
|
924
|
+
readonly parameters: readonly [];
|
|
925
|
+
readonly security: readonly [{
|
|
926
|
+
readonly apiKeyAuth: readonly [];
|
|
927
|
+
}, {
|
|
928
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
929
|
+
}];
|
|
930
|
+
readonly summary: "Create, change, or delete one wholesale product on an ad-server source — what buyers discover and buy. Omit `id` to create: needs `name` and `inventory`, validated first. Pass `id` to change only the fields you name. `active` = buyable, `archived` = off the market and reversible, `delete` is not.";
|
|
931
|
+
};
|
|
932
|
+
readonly save_work_item: {
|
|
933
|
+
readonly path: "/tools/save_work_item";
|
|
934
|
+
readonly method: "POST";
|
|
935
|
+
readonly body: true;
|
|
936
|
+
readonly binary: false;
|
|
937
|
+
readonly idempotencyKey: true;
|
|
938
|
+
readonly parameters: readonly [];
|
|
939
|
+
readonly security: readonly [{
|
|
940
|
+
readonly apiKeyAuth: readonly [];
|
|
941
|
+
}, {
|
|
942
|
+
readonly m2mOAuth: readonly ["interchange:write"];
|
|
943
|
+
}];
|
|
944
|
+
readonly summary: "Decide a creative or media-buy approval, or complete a modular-source follow-up. Repeats preserve evidence; retry, evaluation, and reassignment stay on the approvals Page.";
|
|
945
|
+
};
|
|
946
|
+
readonly search: {
|
|
947
|
+
readonly path: "/tools/search";
|
|
948
|
+
readonly method: "POST";
|
|
949
|
+
readonly body: true;
|
|
950
|
+
readonly binary: false;
|
|
951
|
+
readonly idempotencyKey: false;
|
|
952
|
+
readonly parameters: readonly [];
|
|
953
|
+
readonly security: readonly [{
|
|
954
|
+
readonly apiKeyAuth: readonly [];
|
|
955
|
+
}, {
|
|
956
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
957
|
+
}];
|
|
958
|
+
readonly summary: "Find objects in this account, or answer questions from the docs. Pass kind to list one object type, query to match text, or both. Before a multi-step task, search kind skill for a workflow. Reread a docs hit with its document (and revision, for agreements) before you cite it.";
|
|
959
|
+
};
|
|
960
|
+
readonly test_creative_macros: {
|
|
961
|
+
readonly path: "/tools/test_creative_macros";
|
|
962
|
+
readonly method: "POST";
|
|
963
|
+
readonly body: true;
|
|
964
|
+
readonly binary: false;
|
|
965
|
+
readonly idempotencyKey: false;
|
|
966
|
+
readonly parameters: readonly [];
|
|
967
|
+
readonly security: readonly [{
|
|
968
|
+
readonly apiKeyAuth: readonly [];
|
|
969
|
+
}, {
|
|
970
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
971
|
+
}];
|
|
972
|
+
readonly summary: "Dry-runs one tracker URL through exact raw input, canonical AdCP compilation, recipient translation, and deterministic synthetic substitution. Use it before preview or trafficking; unresolved required macros fail closed.";
|
|
973
|
+
};
|
|
974
|
+
readonly upload_creative_asset: {
|
|
975
|
+
readonly path: "/tools/upload_creative_asset";
|
|
976
|
+
readonly method: "POST";
|
|
977
|
+
readonly body: true;
|
|
978
|
+
readonly binary: false;
|
|
979
|
+
readonly idempotencyKey: true;
|
|
980
|
+
readonly parameters: readonly [];
|
|
981
|
+
readonly security: readonly [{
|
|
982
|
+
readonly apiKeyAuth: readonly [];
|
|
983
|
+
}, {
|
|
984
|
+
readonly m2mOAuth: readonly ["interchange:read"];
|
|
985
|
+
}];
|
|
986
|
+
readonly summary: "Open the embedded Task for an advertiser. Returns accepted MIME types and exact byte limits by type. max_size_bytes is only the largest. Use fallback_url if the Task does not render. Uploading never creates or delivers a Creative.";
|
|
987
|
+
};
|
|
988
|
+
};
|
|
989
|
+
export type OperationId = keyof typeof operations;
|