@jacobhumston/roblox-openapi-ts 1.0.33 → 1.0.35
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/types.d.ts +23 -254
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -240,7 +240,7 @@ export interface paths {
|
|
|
240
240
|
/** @description Universe ID to check eligibility for */
|
|
241
241
|
universeId?: string;
|
|
242
242
|
/** @description Objective filter (ENGAGEMENT in v1) */
|
|
243
|
-
objective?:
|
|
243
|
+
objective?: "ENGAGEMENT";
|
|
244
244
|
};
|
|
245
245
|
header?: never;
|
|
246
246
|
path?: never;
|
|
@@ -622,176 +622,6 @@ export interface paths {
|
|
|
622
622
|
};
|
|
623
623
|
trace?: never;
|
|
624
624
|
};
|
|
625
|
-
"/ads-management/v1/campaigns/{id}/performance": {
|
|
626
|
-
parameters: {
|
|
627
|
-
query?: never;
|
|
628
|
-
header?: never;
|
|
629
|
-
path?: never;
|
|
630
|
-
cookie?: never;
|
|
631
|
-
};
|
|
632
|
-
/**
|
|
633
|
-
* Get campaign performance
|
|
634
|
-
* @description Returns aggregate performance for a single campaign over the requested period: impressions, clicks, plays, spend, CPM (cost per 1,000 impressions), CPP (cost per play), playRate, and CTR (click-through rate). Metrics are calculated in the billing account's time zone. Money fields (spendMicros, cpmMicros, cppMicros) are micro-USD returned as decimal strings (e.g. "5000000" = $5.00). Set the period query parameter to choose the window (defaults to LAST_7_DAYS).
|
|
635
|
-
*/
|
|
636
|
-
get: {
|
|
637
|
-
parameters: {
|
|
638
|
-
query?: {
|
|
639
|
-
/** @description Reporting period (TODAY, YESTERDAY, LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, YEAR_TO_DATE, PREVIOUS_YEAR; default LAST_7_DAYS) */
|
|
640
|
-
period?: string;
|
|
641
|
-
};
|
|
642
|
-
header?: never;
|
|
643
|
-
path: {
|
|
644
|
-
/** @description Campaign ID */
|
|
645
|
-
id: string;
|
|
646
|
-
};
|
|
647
|
-
cookie?: never;
|
|
648
|
-
};
|
|
649
|
-
requestBody?: never;
|
|
650
|
-
responses: {
|
|
651
|
-
/** @description OK */
|
|
652
|
-
200: {
|
|
653
|
-
headers: {
|
|
654
|
-
[name: string]: unknown;
|
|
655
|
-
};
|
|
656
|
-
content: {
|
|
657
|
-
"application/json": components["schemas"]["internal_public_v1.PerformanceResponse"];
|
|
658
|
-
};
|
|
659
|
-
};
|
|
660
|
-
/** @description Invalid period value */
|
|
661
|
-
400: {
|
|
662
|
-
headers: {
|
|
663
|
-
[name: string]: unknown;
|
|
664
|
-
};
|
|
665
|
-
content: {
|
|
666
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
667
|
-
};
|
|
668
|
-
};
|
|
669
|
-
/** @description Permission denied */
|
|
670
|
-
403: {
|
|
671
|
-
headers: {
|
|
672
|
-
[name: string]: unknown;
|
|
673
|
-
};
|
|
674
|
-
content: {
|
|
675
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
676
|
-
};
|
|
677
|
-
};
|
|
678
|
-
/** @description Campaign not found */
|
|
679
|
-
404: {
|
|
680
|
-
headers: {
|
|
681
|
-
[name: string]: unknown;
|
|
682
|
-
};
|
|
683
|
-
content: {
|
|
684
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
685
|
-
};
|
|
686
|
-
};
|
|
687
|
-
/** @description Rate limit exceeded */
|
|
688
|
-
429: {
|
|
689
|
-
headers: {
|
|
690
|
-
[name: string]: unknown;
|
|
691
|
-
};
|
|
692
|
-
content: {
|
|
693
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
694
|
-
};
|
|
695
|
-
};
|
|
696
|
-
/** @description Internal server error */
|
|
697
|
-
500: {
|
|
698
|
-
headers: {
|
|
699
|
-
[name: string]: unknown;
|
|
700
|
-
};
|
|
701
|
-
content: {
|
|
702
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
703
|
-
};
|
|
704
|
-
};
|
|
705
|
-
};
|
|
706
|
-
};
|
|
707
|
-
put?: never;
|
|
708
|
-
post?: never;
|
|
709
|
-
delete?: never;
|
|
710
|
-
options?: never;
|
|
711
|
-
head?: never;
|
|
712
|
-
patch?: never;
|
|
713
|
-
trace?: never;
|
|
714
|
-
};
|
|
715
|
-
"/ads-management/v1/campaigns:batchGetPerformance": {
|
|
716
|
-
parameters: {
|
|
717
|
-
query?: never;
|
|
718
|
-
header?: never;
|
|
719
|
-
path?: never;
|
|
720
|
-
cookie?: never;
|
|
721
|
-
};
|
|
722
|
-
get?: never;
|
|
723
|
-
put?: never;
|
|
724
|
-
/**
|
|
725
|
-
* Batch get campaign performance
|
|
726
|
-
* @description Returns aggregate performance for up to 100 campaigns over a single shared period (default LAST_7_DAYS), calculated in the billing account's time zone. Each result carries the same metrics as the single-campaign performance endpoint: impressions, clicks, plays, spend, CPM (cost per 1,000 impressions), CPP (cost per play), playRate, and CTR (click-through rate). Provide the campaign IDs in campaignIds; any ID that is not found or is not owned by the caller is returned in the failures array with reason NOT_FOUND. Prefer this over calling the single-campaign endpoint in a loop when building account-wide dashboards.
|
|
727
|
-
*/
|
|
728
|
-
post: {
|
|
729
|
-
parameters: {
|
|
730
|
-
query?: never;
|
|
731
|
-
header?: never;
|
|
732
|
-
path?: never;
|
|
733
|
-
cookie?: never;
|
|
734
|
-
};
|
|
735
|
-
/** @description Campaign IDs (max 100) and optional period */
|
|
736
|
-
requestBody: {
|
|
737
|
-
content: {
|
|
738
|
-
"application/json": components["schemas"]["internal_public_v1.BatchGetPerformanceRequest"];
|
|
739
|
-
};
|
|
740
|
-
};
|
|
741
|
-
responses: {
|
|
742
|
-
/** @description OK */
|
|
743
|
-
200: {
|
|
744
|
-
headers: {
|
|
745
|
-
[name: string]: unknown;
|
|
746
|
-
};
|
|
747
|
-
content: {
|
|
748
|
-
"application/json": components["schemas"]["internal_public_v1.BatchGetPerformanceResponse"];
|
|
749
|
-
};
|
|
750
|
-
};
|
|
751
|
-
/** @description Invalid request, exceeds 100 IDs, or invalid period */
|
|
752
|
-
400: {
|
|
753
|
-
headers: {
|
|
754
|
-
[name: string]: unknown;
|
|
755
|
-
};
|
|
756
|
-
content: {
|
|
757
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
758
|
-
};
|
|
759
|
-
};
|
|
760
|
-
/** @description Permission denied */
|
|
761
|
-
403: {
|
|
762
|
-
headers: {
|
|
763
|
-
[name: string]: unknown;
|
|
764
|
-
};
|
|
765
|
-
content: {
|
|
766
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
767
|
-
};
|
|
768
|
-
};
|
|
769
|
-
/** @description Rate limit exceeded */
|
|
770
|
-
429: {
|
|
771
|
-
headers: {
|
|
772
|
-
[name: string]: unknown;
|
|
773
|
-
};
|
|
774
|
-
content: {
|
|
775
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
776
|
-
};
|
|
777
|
-
};
|
|
778
|
-
/** @description Internal server error */
|
|
779
|
-
500: {
|
|
780
|
-
headers: {
|
|
781
|
-
[name: string]: unknown;
|
|
782
|
-
};
|
|
783
|
-
content: {
|
|
784
|
-
"application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
|
|
785
|
-
};
|
|
786
|
-
};
|
|
787
|
-
};
|
|
788
|
-
};
|
|
789
|
-
delete?: never;
|
|
790
|
-
options?: never;
|
|
791
|
-
head?: never;
|
|
792
|
-
patch?: never;
|
|
793
|
-
trace?: never;
|
|
794
|
-
};
|
|
795
625
|
"/ads-management/v1/campaigns:batchGetStatus": {
|
|
796
626
|
parameters: {
|
|
797
627
|
query?: never;
|
|
@@ -44244,6 +44074,7 @@ export interface components {
|
|
|
44244
44074
|
/** Format: int64 */
|
|
44245
44075
|
expectedPrice?: number;
|
|
44246
44076
|
isPurchaseConfirmed?: boolean | null;
|
|
44077
|
+
idempotencyKey?: string | null;
|
|
44247
44078
|
};
|
|
44248
44079
|
/** @description Request model for creating a save */
|
|
44249
44080
|
CreateSaveRequest: {
|
|
@@ -58067,40 +57898,9 @@ export interface components {
|
|
|
58067
57898
|
*/
|
|
58068
57899
|
universeId?: string;
|
|
58069
57900
|
};
|
|
58070
|
-
"internal_public_v1.BatchGetPerformanceRequest": {
|
|
58071
|
-
/** @description The campaign IDs to report on. Required. At most 100 per request. */
|
|
58072
|
-
campaignIds?: string[];
|
|
58073
|
-
/**
|
|
58074
|
-
* @description The reporting window applied to every campaign in the batch. Optional; defaults
|
|
58075
|
-
* to `LAST_7_DAYS`. Can be `TODAY`, `YESTERDAY`, `LAST_7_DAYS`, `LAST_30_DAYS`,
|
|
58076
|
-
* `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
|
|
58077
|
-
* @enum {string}
|
|
58078
|
-
*/
|
|
58079
|
-
period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
|
|
58080
|
-
};
|
|
58081
|
-
"internal_public_v1.BatchGetPerformanceResponse": {
|
|
58082
|
-
/** @description The time the metrics were current, as an RFC 3339 UTC timestamp. */
|
|
58083
|
-
dataAsOf?: string;
|
|
58084
|
-
/** @description The last day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
|
|
58085
|
-
endDate?: string;
|
|
58086
|
-
/** @description The IDs that could not be resolved. Omitted when every ID resolved. */
|
|
58087
|
-
failures?: components["schemas"]["internal_public_v1.CampaignIDFailure"][];
|
|
58088
|
-
/**
|
|
58089
|
-
* @description The reporting window applied to every campaign. Can be `TODAY`, `YESTERDAY`,
|
|
58090
|
-
* `LAST_7_DAYS`, `LAST_30_DAYS`, `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
|
|
58091
|
-
* @enum {string}
|
|
58092
|
-
*/
|
|
58093
|
-
period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
|
|
58094
|
-
/** @description One entry per successfully resolved campaign. */
|
|
58095
|
-
results?: components["schemas"]["internal_public_v1.CampaignPerformance"][];
|
|
58096
|
-
/** @description The first day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
|
|
58097
|
-
startDate?: string;
|
|
58098
|
-
/** @description The IANA time zone the window and metrics are computed in. */
|
|
58099
|
-
timeZone?: string;
|
|
58100
|
-
};
|
|
58101
57901
|
"internal_public_v1.BatchGetStatusRequest": {
|
|
58102
57902
|
/** @description The campaign IDs to look up. Required. At most 100 per request. */
|
|
58103
|
-
campaignIds
|
|
57903
|
+
campaignIds: string[];
|
|
58104
57904
|
};
|
|
58105
57905
|
"internal_public_v1.BatchGetStatusResponse": {
|
|
58106
57906
|
/** @description The IDs that could not be resolved. Omitted when every ID resolved. */
|
|
@@ -58245,11 +58045,6 @@ export interface components {
|
|
|
58245
58045
|
paymentTypes?: ("CREDIT_CARD" | "ADS_CREDIT" | "INVOICE")[];
|
|
58246
58046
|
targetingDimensions?: components["schemas"]["internal_public_v1.TargetingDimensions"];
|
|
58247
58047
|
};
|
|
58248
|
-
"internal_public_v1.CampaignPerformance": {
|
|
58249
|
-
/** @description The campaign these metrics belong to. */
|
|
58250
|
-
campaignId?: string;
|
|
58251
|
-
totals?: components["schemas"]["internal_public_v1.PerformanceTotals"];
|
|
58252
|
-
};
|
|
58253
58048
|
"internal_public_v1.CampaignStatus": {
|
|
58254
58049
|
/**
|
|
58255
58050
|
* @description The current serving state. Can be `SERVING`, `IN_REVIEW`, `NOT_SERVING`, or `REJECTED`.
|
|
@@ -58269,28 +58064,28 @@ export interface components {
|
|
|
58269
58064
|
"internal_public_v1.CreateCampaignRequest": {
|
|
58270
58065
|
/** @description Optional bidding strategy. Only `AUTOMATED` is accepted in v1; may be omitted. */
|
|
58271
58066
|
bid?: components["schemas"]["internal_public_v1.Bid"];
|
|
58272
|
-
budget
|
|
58067
|
+
budget: components["schemas"]["internal_public_v1.Budget"];
|
|
58273
58068
|
/**
|
|
58274
58069
|
* @description The Open Cloud image asset IDs to advertise, as decimal strings. Required. The
|
|
58275
58070
|
* assets must already exist and be usable by the caller.
|
|
58276
58071
|
*/
|
|
58277
|
-
creativeAssetIds
|
|
58072
|
+
creativeAssetIds: string[];
|
|
58278
58073
|
/** @description The display name of the campaign. Required. */
|
|
58279
|
-
name
|
|
58074
|
+
name: string;
|
|
58280
58075
|
/**
|
|
58281
58076
|
* @description The advertising goal. Required. Only `ENGAGEMENT` is supported in v1.
|
|
58282
58077
|
* @enum {string}
|
|
58283
58078
|
*/
|
|
58284
|
-
objective
|
|
58079
|
+
objective: "ENGAGEMENT";
|
|
58285
58080
|
/**
|
|
58286
58081
|
* @description How the campaign is paid for. Required. Can be `CREDIT_CARD`, `ADS_CREDIT`, or
|
|
58287
58082
|
* `INVOICE`, subject to what the billing account supports.
|
|
58288
58083
|
* @enum {string}
|
|
58289
58084
|
*/
|
|
58290
|
-
paymentType
|
|
58291
|
-
schedule
|
|
58085
|
+
paymentType: "CREDIT_CARD" | "ADS_CREDIT" | "INVOICE";
|
|
58086
|
+
schedule: components["schemas"]["internal_public_v1.Schedule"];
|
|
58292
58087
|
/** @description The identifier of the experience to advertise. Required. */
|
|
58293
|
-
targetUniverseId
|
|
58088
|
+
targetUniverseId: string;
|
|
58294
58089
|
/** @description Optional audience targeting. Omit it, or send an empty object, to reach all audiences. */
|
|
58295
58090
|
targeting?: components["schemas"]["internal_public_v1.Targeting"];
|
|
58296
58091
|
};
|
|
@@ -58376,43 +58171,6 @@ export interface components {
|
|
|
58376
58171
|
*/
|
|
58377
58172
|
nextPageToken?: string;
|
|
58378
58173
|
};
|
|
58379
|
-
"internal_public_v1.PerformanceResponse": {
|
|
58380
|
-
/** @description The campaign these metrics belong to. */
|
|
58381
|
-
campaignId?: string;
|
|
58382
|
-
/** @description The time the metrics were current, as an RFC 3339 UTC timestamp. */
|
|
58383
|
-
dataAsOf?: string;
|
|
58384
|
-
/** @description The last day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
|
|
58385
|
-
endDate?: string;
|
|
58386
|
-
/**
|
|
58387
|
-
* @description The reporting window applied. Can be `TODAY`, `YESTERDAY`, `LAST_7_DAYS`,
|
|
58388
|
-
* `LAST_30_DAYS`, `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
|
|
58389
|
-
* @enum {string}
|
|
58390
|
-
*/
|
|
58391
|
-
period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
|
|
58392
|
-
/** @description The first day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
|
|
58393
|
-
startDate?: string;
|
|
58394
|
-
/** @description The IANA time zone the window and metrics are computed in. */
|
|
58395
|
-
timeZone?: string;
|
|
58396
|
-
totals?: components["schemas"]["internal_public_v1.PerformanceTotals"];
|
|
58397
|
-
};
|
|
58398
|
-
"internal_public_v1.PerformanceTotals": {
|
|
58399
|
-
/** @description The number of clicks on an ad. */
|
|
58400
|
-
clicks?: number;
|
|
58401
|
-
/** @description Cost per 1,000 impressions in micro-USD, as a decimal string. */
|
|
58402
|
-
cpmMicros?: string;
|
|
58403
|
-
/** @description Cost per play in micro-USD, as a decimal string. */
|
|
58404
|
-
cppMicros?: string;
|
|
58405
|
-
/** @description The click-through rate: clicks divided by impressions, from 0 to 1. */
|
|
58406
|
-
ctr?: number;
|
|
58407
|
-
/** @description The number of times an ad was shown. */
|
|
58408
|
-
impressions?: number;
|
|
58409
|
-
/** @description The play rate: plays divided by impressions, from 0 to 1. */
|
|
58410
|
-
playRate?: number;
|
|
58411
|
-
/** @description The number of resulting experience plays. */
|
|
58412
|
-
plays?: number;
|
|
58413
|
-
/** @description Total spend in micro-USD, as a decimal string (for example, `5000000` = $5.00). */
|
|
58414
|
-
spendMicros?: string;
|
|
58415
|
-
};
|
|
58416
58174
|
"internal_public_v1.PublicError": {
|
|
58417
58175
|
/**
|
|
58418
58176
|
* @description A stable, machine-readable error code (for example, `INVALID_ARGUMENT`,
|
|
@@ -58475,11 +58233,22 @@ export interface components {
|
|
|
58475
58233
|
/** @description The identifier of the experience that was checked. */
|
|
58476
58234
|
universeId?: string;
|
|
58477
58235
|
};
|
|
58236
|
+
"internal_public_v1.UpdateBudget": {
|
|
58237
|
+
/**
|
|
58238
|
+
* @description The new budget amount in micro-USD, as a decimal string (for example,
|
|
58239
|
+
* `5000000` = $5.00). Money is sent as a string so large values keep full
|
|
58240
|
+
* precision in every client. Must be a numeric string of micro-USD.
|
|
58241
|
+
*/
|
|
58242
|
+
amountMicros?: string;
|
|
58243
|
+
};
|
|
58478
58244
|
"internal_public_v1.UpdateCampaignRequest": {
|
|
58479
58245
|
/** @description Immutable in v1; including it returns 400. */
|
|
58480
58246
|
bid?: components["schemas"]["internal_public_v1.Bid"];
|
|
58481
|
-
/**
|
|
58482
|
-
|
|
58247
|
+
/**
|
|
58248
|
+
* @description A budget change. Only the amount is mutable; the budget type is fixed at
|
|
58249
|
+
* creation, so it is not part of this object. Sending `type` returns 400.
|
|
58250
|
+
*/
|
|
58251
|
+
budget?: components["schemas"]["internal_public_v1.UpdateBudget"];
|
|
58483
58252
|
/** @description Immutable in v1; including it returns 400. */
|
|
58484
58253
|
creativeAssetIds?: string[];
|
|
58485
58254
|
/** @description A new display name for the campaign. */
|