@getlatedev/node 0.2.373 → 0.2.375
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/index.d.mts +42 -15
- package/dist/index.d.ts +42 -15
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +5 -2
- package/src/generated/types.gen.ts +42 -15
package/dist/index.d.mts
CHANGED
|
@@ -4420,19 +4420,19 @@ type TargetingSpec = {
|
|
|
4420
4420
|
name?: string;
|
|
4421
4421
|
}>;
|
|
4422
4422
|
/**
|
|
4423
|
-
* City targeting. Optional `radius` + `
|
|
4423
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits; both must be set together or both omitted. `radius` is only honoured on platforms whose capability map allows city radius (Meta).
|
|
4424
4424
|
*/
|
|
4425
4425
|
cities?: Array<{
|
|
4426
4426
|
key: string;
|
|
4427
4427
|
name?: string;
|
|
4428
4428
|
/**
|
|
4429
|
-
* Radius around the city. Requires
|
|
4429
|
+
* Radius around the city. Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng), which allows a smaller radius.
|
|
4430
4430
|
*/
|
|
4431
4431
|
radius?: number;
|
|
4432
4432
|
/**
|
|
4433
4433
|
* Required if radius is set.
|
|
4434
4434
|
*/
|
|
4435
|
-
|
|
4435
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
4436
4436
|
}>;
|
|
4437
4437
|
/**
|
|
4438
4438
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`). Supported on Meta, Google, TikTok, Pinterest, X.
|
|
@@ -4475,18 +4475,18 @@ type TargetingSpec = {
|
|
|
4475
4475
|
name?: string;
|
|
4476
4476
|
}>;
|
|
4477
4477
|
/**
|
|
4478
|
-
* Cities to exclude. Optional `radius` + `
|
|
4478
|
+
* Cities to exclude. Optional `radius` + `distanceUnit` exclude a catchment around the city (both must be set together or both omitted); Meta honours the radius on excluded cities.
|
|
4479
4479
|
*/
|
|
4480
4480
|
cities?: Array<{
|
|
4481
4481
|
key: string;
|
|
4482
4482
|
/**
|
|
4483
|
-
* Radius around the excluded city. Requires
|
|
4483
|
+
* Radius around the excluded city. Requires distanceUnit.
|
|
4484
4484
|
*/
|
|
4485
4485
|
radius?: number;
|
|
4486
4486
|
/**
|
|
4487
4487
|
* Required if radius is set.
|
|
4488
4488
|
*/
|
|
4489
|
-
|
|
4489
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
4490
4490
|
}>;
|
|
4491
4491
|
zips?: Array<{
|
|
4492
4492
|
key: string;
|
|
@@ -4538,7 +4538,7 @@ type TargetingSpec = {
|
|
|
4538
4538
|
*/
|
|
4539
4539
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
4540
4540
|
/**
|
|
4541
|
-
* Language codes (e.g. ['en']).
|
|
4541
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code ("en_GB", "pt_BR") for a specific one. Unknown codes are rejected.
|
|
4542
4542
|
*/
|
|
4543
4543
|
languages?: Array<(string)>;
|
|
4544
4544
|
/**
|
|
@@ -7195,6 +7195,18 @@ type YouTubeDemographicsResponse = {
|
|
|
7195
7195
|
*/
|
|
7196
7196
|
accountId?: string;
|
|
7197
7197
|
platform?: string;
|
|
7198
|
+
/**
|
|
7199
|
+
* Present only when demographics are scoped to a single video
|
|
7200
|
+
*/
|
|
7201
|
+
videoId?: string;
|
|
7202
|
+
/**
|
|
7203
|
+
* Video title (video mode only)
|
|
7204
|
+
*/
|
|
7205
|
+
title?: (string) | null;
|
|
7206
|
+
/**
|
|
7207
|
+
* Video publish date (video mode only)
|
|
7208
|
+
*/
|
|
7209
|
+
publishedAt?: (string) | null;
|
|
7198
7210
|
/**
|
|
7199
7211
|
* Object keyed by breakdown dimension (age, gender, country)
|
|
7200
7212
|
*/
|
|
@@ -7910,10 +7922,17 @@ type GetYouTubeDemographicsData = {
|
|
|
7910
7922
|
*/
|
|
7911
7923
|
endDate?: string;
|
|
7912
7924
|
/**
|
|
7913
|
-
* Start date in YYYY-MM-DD format. Defaults to 90 days ago
|
|
7925
|
+
* Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's
|
|
7926
|
+
* publish date (lifetime) when videoId is provided.
|
|
7914
7927
|
*
|
|
7915
7928
|
*/
|
|
7916
7929
|
startDate?: string;
|
|
7930
|
+
/**
|
|
7931
|
+
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
7932
|
+
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
7933
|
+
*
|
|
7934
|
+
*/
|
|
7935
|
+
videoId?: string;
|
|
7917
7936
|
};
|
|
7918
7937
|
};
|
|
7919
7938
|
type GetYouTubeDemographicsResponse = (YouTubeDemographicsResponse);
|
|
@@ -12654,6 +12673,10 @@ type GetGmbLocationsData = {
|
|
|
12654
12673
|
* Raw Google Business Information API filter expression (advanced; takes precedence over search), e.g. storeCode="LH279411".
|
|
12655
12674
|
*/
|
|
12656
12675
|
filter?: string;
|
|
12676
|
+
/**
|
|
12677
|
+
* Max locations to return (default 100, max 500). Raise it to enumerate an account with more than 100 locations; for accounts with thousands, use search/filter instead.
|
|
12678
|
+
*/
|
|
12679
|
+
limit?: number;
|
|
12657
12680
|
/**
|
|
12658
12681
|
* Free-text search on the business name, applied server-side by Google. Use for accounts with many locations.
|
|
12659
12682
|
*/
|
|
@@ -12678,9 +12701,9 @@ type GetGmbLocationsResponse = ({
|
|
|
12678
12701
|
selectedLocationId?: string;
|
|
12679
12702
|
cached?: boolean;
|
|
12680
12703
|
});
|
|
12681
|
-
type GetGmbLocationsError = ({
|
|
12704
|
+
type GetGmbLocationsError = (unknown | {
|
|
12682
12705
|
error?: string;
|
|
12683
|
-
}
|
|
12706
|
+
});
|
|
12684
12707
|
type UpdateGmbLocationData = {
|
|
12685
12708
|
body: {
|
|
12686
12709
|
selectedLocationId: string;
|
|
@@ -23423,16 +23446,16 @@ type BoostPostData = {
|
|
|
23423
23446
|
name?: string;
|
|
23424
23447
|
}>;
|
|
23425
23448
|
/**
|
|
23426
|
-
* City targeting. Optional `radius` + `
|
|
23449
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits (both set together, Meta only).
|
|
23427
23450
|
*/
|
|
23428
23451
|
cities?: Array<{
|
|
23429
23452
|
key: string;
|
|
23430
23453
|
name?: string;
|
|
23431
23454
|
/**
|
|
23432
|
-
* Requires
|
|
23455
|
+
* Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
23433
23456
|
*/
|
|
23434
23457
|
radius?: number;
|
|
23435
|
-
|
|
23458
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
23436
23459
|
}>;
|
|
23437
23460
|
/**
|
|
23438
23461
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`).
|
|
@@ -23835,7 +23858,7 @@ type CreateStandaloneAdData = {
|
|
|
23835
23858
|
*/
|
|
23836
23859
|
key: string;
|
|
23837
23860
|
/**
|
|
23838
|
-
* Optional radius around the city. Must be set together with distance_unit.
|
|
23861
|
+
* Optional radius around the city. Must be set together with distance_unit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
23839
23862
|
*/
|
|
23840
23863
|
radius?: number;
|
|
23841
23864
|
/**
|
|
@@ -23902,7 +23925,7 @@ type CreateStandaloneAdData = {
|
|
|
23902
23925
|
*/
|
|
23903
23926
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
23904
23927
|
/**
|
|
23905
|
-
* Language codes (e.g. ['en']).
|
|
23928
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en'], ['de']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code for a specific one ("en_GB", "pt_BR", "zh_TW"). Unknown codes are rejected. Other ad platforms use their own language-code systems.
|
|
23906
23929
|
*/
|
|
23907
23930
|
languages?: Array<(string)>;
|
|
23908
23931
|
/**
|
|
@@ -25874,6 +25897,10 @@ type CreateCtwaAdData = {
|
|
|
25874
25897
|
* TargetingGeoLocationCity. `key` is Meta's city ID
|
|
25875
25898
|
* (lookupable via GET /v1/ads/targeting/search). `radius`
|
|
25876
25899
|
* and `distance_unit` are coupled: set both or neither.
|
|
25900
|
+
* Meta enforces a minimum city radius (~17 km / 10 mi);
|
|
25901
|
+
* smaller values resolve to a 0-size audience and the ad
|
|
25902
|
+
* fails at launch. For a tighter catchment use customLocations
|
|
25903
|
+
* (lat/lng).
|
|
25877
25904
|
*
|
|
25878
25905
|
*/
|
|
25879
25906
|
cities?: Array<{
|
package/dist/index.d.ts
CHANGED
|
@@ -4420,19 +4420,19 @@ type TargetingSpec = {
|
|
|
4420
4420
|
name?: string;
|
|
4421
4421
|
}>;
|
|
4422
4422
|
/**
|
|
4423
|
-
* City targeting. Optional `radius` + `
|
|
4423
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits; both must be set together or both omitted. `radius` is only honoured on platforms whose capability map allows city radius (Meta).
|
|
4424
4424
|
*/
|
|
4425
4425
|
cities?: Array<{
|
|
4426
4426
|
key: string;
|
|
4427
4427
|
name?: string;
|
|
4428
4428
|
/**
|
|
4429
|
-
* Radius around the city. Requires
|
|
4429
|
+
* Radius around the city. Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng), which allows a smaller radius.
|
|
4430
4430
|
*/
|
|
4431
4431
|
radius?: number;
|
|
4432
4432
|
/**
|
|
4433
4433
|
* Required if radius is set.
|
|
4434
4434
|
*/
|
|
4435
|
-
|
|
4435
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
4436
4436
|
}>;
|
|
4437
4437
|
/**
|
|
4438
4438
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`). Supported on Meta, Google, TikTok, Pinterest, X.
|
|
@@ -4475,18 +4475,18 @@ type TargetingSpec = {
|
|
|
4475
4475
|
name?: string;
|
|
4476
4476
|
}>;
|
|
4477
4477
|
/**
|
|
4478
|
-
* Cities to exclude. Optional `radius` + `
|
|
4478
|
+
* Cities to exclude. Optional `radius` + `distanceUnit` exclude a catchment around the city (both must be set together or both omitted); Meta honours the radius on excluded cities.
|
|
4479
4479
|
*/
|
|
4480
4480
|
cities?: Array<{
|
|
4481
4481
|
key: string;
|
|
4482
4482
|
/**
|
|
4483
|
-
* Radius around the excluded city. Requires
|
|
4483
|
+
* Radius around the excluded city. Requires distanceUnit.
|
|
4484
4484
|
*/
|
|
4485
4485
|
radius?: number;
|
|
4486
4486
|
/**
|
|
4487
4487
|
* Required if radius is set.
|
|
4488
4488
|
*/
|
|
4489
|
-
|
|
4489
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
4490
4490
|
}>;
|
|
4491
4491
|
zips?: Array<{
|
|
4492
4492
|
key: string;
|
|
@@ -4538,7 +4538,7 @@ type TargetingSpec = {
|
|
|
4538
4538
|
*/
|
|
4539
4539
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
4540
4540
|
/**
|
|
4541
|
-
* Language codes (e.g. ['en']).
|
|
4541
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code ("en_GB", "pt_BR") for a specific one. Unknown codes are rejected.
|
|
4542
4542
|
*/
|
|
4543
4543
|
languages?: Array<(string)>;
|
|
4544
4544
|
/**
|
|
@@ -7195,6 +7195,18 @@ type YouTubeDemographicsResponse = {
|
|
|
7195
7195
|
*/
|
|
7196
7196
|
accountId?: string;
|
|
7197
7197
|
platform?: string;
|
|
7198
|
+
/**
|
|
7199
|
+
* Present only when demographics are scoped to a single video
|
|
7200
|
+
*/
|
|
7201
|
+
videoId?: string;
|
|
7202
|
+
/**
|
|
7203
|
+
* Video title (video mode only)
|
|
7204
|
+
*/
|
|
7205
|
+
title?: (string) | null;
|
|
7206
|
+
/**
|
|
7207
|
+
* Video publish date (video mode only)
|
|
7208
|
+
*/
|
|
7209
|
+
publishedAt?: (string) | null;
|
|
7198
7210
|
/**
|
|
7199
7211
|
* Object keyed by breakdown dimension (age, gender, country)
|
|
7200
7212
|
*/
|
|
@@ -7910,10 +7922,17 @@ type GetYouTubeDemographicsData = {
|
|
|
7910
7922
|
*/
|
|
7911
7923
|
endDate?: string;
|
|
7912
7924
|
/**
|
|
7913
|
-
* Start date in YYYY-MM-DD format. Defaults to 90 days ago
|
|
7925
|
+
* Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's
|
|
7926
|
+
* publish date (lifetime) when videoId is provided.
|
|
7914
7927
|
*
|
|
7915
7928
|
*/
|
|
7916
7929
|
startDate?: string;
|
|
7930
|
+
/**
|
|
7931
|
+
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
7932
|
+
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
7933
|
+
*
|
|
7934
|
+
*/
|
|
7935
|
+
videoId?: string;
|
|
7917
7936
|
};
|
|
7918
7937
|
};
|
|
7919
7938
|
type GetYouTubeDemographicsResponse = (YouTubeDemographicsResponse);
|
|
@@ -12654,6 +12673,10 @@ type GetGmbLocationsData = {
|
|
|
12654
12673
|
* Raw Google Business Information API filter expression (advanced; takes precedence over search), e.g. storeCode="LH279411".
|
|
12655
12674
|
*/
|
|
12656
12675
|
filter?: string;
|
|
12676
|
+
/**
|
|
12677
|
+
* Max locations to return (default 100, max 500). Raise it to enumerate an account with more than 100 locations; for accounts with thousands, use search/filter instead.
|
|
12678
|
+
*/
|
|
12679
|
+
limit?: number;
|
|
12657
12680
|
/**
|
|
12658
12681
|
* Free-text search on the business name, applied server-side by Google. Use for accounts with many locations.
|
|
12659
12682
|
*/
|
|
@@ -12678,9 +12701,9 @@ type GetGmbLocationsResponse = ({
|
|
|
12678
12701
|
selectedLocationId?: string;
|
|
12679
12702
|
cached?: boolean;
|
|
12680
12703
|
});
|
|
12681
|
-
type GetGmbLocationsError = ({
|
|
12704
|
+
type GetGmbLocationsError = (unknown | {
|
|
12682
12705
|
error?: string;
|
|
12683
|
-
}
|
|
12706
|
+
});
|
|
12684
12707
|
type UpdateGmbLocationData = {
|
|
12685
12708
|
body: {
|
|
12686
12709
|
selectedLocationId: string;
|
|
@@ -23423,16 +23446,16 @@ type BoostPostData = {
|
|
|
23423
23446
|
name?: string;
|
|
23424
23447
|
}>;
|
|
23425
23448
|
/**
|
|
23426
|
-
* City targeting. Optional `radius` + `
|
|
23449
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits (both set together, Meta only).
|
|
23427
23450
|
*/
|
|
23428
23451
|
cities?: Array<{
|
|
23429
23452
|
key: string;
|
|
23430
23453
|
name?: string;
|
|
23431
23454
|
/**
|
|
23432
|
-
* Requires
|
|
23455
|
+
* Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
23433
23456
|
*/
|
|
23434
23457
|
radius?: number;
|
|
23435
|
-
|
|
23458
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
23436
23459
|
}>;
|
|
23437
23460
|
/**
|
|
23438
23461
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`).
|
|
@@ -23835,7 +23858,7 @@ type CreateStandaloneAdData = {
|
|
|
23835
23858
|
*/
|
|
23836
23859
|
key: string;
|
|
23837
23860
|
/**
|
|
23838
|
-
* Optional radius around the city. Must be set together with distance_unit.
|
|
23861
|
+
* Optional radius around the city. Must be set together with distance_unit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
23839
23862
|
*/
|
|
23840
23863
|
radius?: number;
|
|
23841
23864
|
/**
|
|
@@ -23902,7 +23925,7 @@ type CreateStandaloneAdData = {
|
|
|
23902
23925
|
*/
|
|
23903
23926
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
23904
23927
|
/**
|
|
23905
|
-
* Language codes (e.g. ['en']).
|
|
23928
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en'], ['de']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code for a specific one ("en_GB", "pt_BR", "zh_TW"). Unknown codes are rejected. Other ad platforms use their own language-code systems.
|
|
23906
23929
|
*/
|
|
23907
23930
|
languages?: Array<(string)>;
|
|
23908
23931
|
/**
|
|
@@ -25874,6 +25897,10 @@ type CreateCtwaAdData = {
|
|
|
25874
25897
|
* TargetingGeoLocationCity. `key` is Meta's city ID
|
|
25875
25898
|
* (lookupable via GET /v1/ads/targeting/search). `radius`
|
|
25876
25899
|
* and `distance_unit` are coupled: set both or neither.
|
|
25900
|
+
* Meta enforces a minimum city radius (~17 km / 10 mi);
|
|
25901
|
+
* smaller values resolve to a 0-size audience and the ad
|
|
25902
|
+
* fails at launch. For a tighter catchment use customLocations
|
|
25903
|
+
* (lat/lng).
|
|
25877
25904
|
*
|
|
25878
25905
|
*/
|
|
25879
25906
|
cities?: Array<{
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.375",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.375",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -279,8 +279,11 @@ export const getInstagramDemographics = <ThrowOnError extends boolean = false>(o
|
|
|
279
279
|
/**
|
|
280
280
|
* Get YouTube demographics
|
|
281
281
|
* Returns audience demographic insights for a YouTube channel, broken down by age, gender, and/or country.
|
|
282
|
+
* Pass videoId to get the audience profile of a single video instead of the whole channel.
|
|
282
283
|
* Age and gender values are viewer percentages (0-100). Country values are view counts.
|
|
283
|
-
* Data is based on signed-in viewers only, with a 2-3 day delay.
|
|
284
|
+
* Data is based on signed-in viewers only, with a 2-3 day delay. YouTube suppresses demographics
|
|
285
|
+
* for videos with too few signed-in views, so low-traffic videos can return empty breakdowns.
|
|
286
|
+
* Requires the Analytics add-on.
|
|
284
287
|
*
|
|
285
288
|
*/
|
|
286
289
|
export const getYouTubeDemographics = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetYouTubeDemographicsData, ThrowOnError>) => {
|
|
@@ -2024,7 +2027,7 @@ export const updateYoutubeDefaultPlaylist = <ThrowOnError extends boolean = fals
|
|
|
2024
2027
|
|
|
2025
2028
|
/**
|
|
2026
2029
|
* List GBP locations
|
|
2027
|
-
* Returns Google Business Profile locations the connected account can access, plus the currently selected location. The list is bounded (see hasMore); for accounts that own many locations, use the search or filter query params to find a specific one instead of loading them all.
|
|
2030
|
+
* Returns Google Business Profile locations the connected account can access, plus the currently selected location. The list is bounded (see hasMore); for accounts that own many locations, use the search or filter query params to find a specific one instead of loading them all, or raise limit to enumerate an account with more than 100 locations.
|
|
2028
2031
|
*
|
|
2029
2032
|
*/
|
|
2030
2033
|
export const getGmbLocations = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGmbLocationsData, ThrowOnError>) => {
|
|
@@ -3692,19 +3692,19 @@ export type TargetingSpec = {
|
|
|
3692
3692
|
name?: string;
|
|
3693
3693
|
}>;
|
|
3694
3694
|
/**
|
|
3695
|
-
* City targeting. Optional `radius` + `
|
|
3695
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits; both must be set together or both omitted. `radius` is only honoured on platforms whose capability map allows city radius (Meta).
|
|
3696
3696
|
*/
|
|
3697
3697
|
cities?: Array<{
|
|
3698
3698
|
key: string;
|
|
3699
3699
|
name?: string;
|
|
3700
3700
|
/**
|
|
3701
|
-
* Radius around the city. Requires
|
|
3701
|
+
* Radius around the city. Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng), which allows a smaller radius.
|
|
3702
3702
|
*/
|
|
3703
3703
|
radius?: number;
|
|
3704
3704
|
/**
|
|
3705
3705
|
* Required if radius is set.
|
|
3706
3706
|
*/
|
|
3707
|
-
|
|
3707
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
3708
3708
|
}>;
|
|
3709
3709
|
/**
|
|
3710
3710
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`). Supported on Meta, Google, TikTok, Pinterest, X.
|
|
@@ -3747,18 +3747,18 @@ export type TargetingSpec = {
|
|
|
3747
3747
|
name?: string;
|
|
3748
3748
|
}>;
|
|
3749
3749
|
/**
|
|
3750
|
-
* Cities to exclude. Optional `radius` + `
|
|
3750
|
+
* Cities to exclude. Optional `radius` + `distanceUnit` exclude a catchment around the city (both must be set together or both omitted); Meta honours the radius on excluded cities.
|
|
3751
3751
|
*/
|
|
3752
3752
|
cities?: Array<{
|
|
3753
3753
|
key: string;
|
|
3754
3754
|
/**
|
|
3755
|
-
* Radius around the excluded city. Requires
|
|
3755
|
+
* Radius around the excluded city. Requires distanceUnit.
|
|
3756
3756
|
*/
|
|
3757
3757
|
radius?: number;
|
|
3758
3758
|
/**
|
|
3759
3759
|
* Required if radius is set.
|
|
3760
3760
|
*/
|
|
3761
|
-
|
|
3761
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
3762
3762
|
}>;
|
|
3763
3763
|
zips?: Array<{
|
|
3764
3764
|
key: string;
|
|
@@ -3810,7 +3810,7 @@ export type TargetingSpec = {
|
|
|
3810
3810
|
*/
|
|
3811
3811
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
3812
3812
|
/**
|
|
3813
|
-
* Language codes (e.g. ['en']).
|
|
3813
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code ("en_GB", "pt_BR") for a specific one. Unknown codes are rejected.
|
|
3814
3814
|
*/
|
|
3815
3815
|
languages?: Array<(string)>;
|
|
3816
3816
|
/**
|
|
@@ -6577,6 +6577,18 @@ export type YouTubeDemographicsResponse = {
|
|
|
6577
6577
|
*/
|
|
6578
6578
|
accountId?: string;
|
|
6579
6579
|
platform?: string;
|
|
6580
|
+
/**
|
|
6581
|
+
* Present only when demographics are scoped to a single video
|
|
6582
|
+
*/
|
|
6583
|
+
videoId?: string;
|
|
6584
|
+
/**
|
|
6585
|
+
* Video title (video mode only)
|
|
6586
|
+
*/
|
|
6587
|
+
title?: (string) | null;
|
|
6588
|
+
/**
|
|
6589
|
+
* Video publish date (video mode only)
|
|
6590
|
+
*/
|
|
6591
|
+
publishedAt?: (string) | null;
|
|
6580
6592
|
/**
|
|
6581
6593
|
* Object keyed by breakdown dimension (age, gender, country)
|
|
6582
6594
|
*/
|
|
@@ -7338,10 +7350,17 @@ export type GetYouTubeDemographicsData = {
|
|
|
7338
7350
|
*/
|
|
7339
7351
|
endDate?: string;
|
|
7340
7352
|
/**
|
|
7341
|
-
* Start date in YYYY-MM-DD format. Defaults to 90 days ago
|
|
7353
|
+
* Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's
|
|
7354
|
+
* publish date (lifetime) when videoId is provided.
|
|
7342
7355
|
*
|
|
7343
7356
|
*/
|
|
7344
7357
|
startDate?: string;
|
|
7358
|
+
/**
|
|
7359
|
+
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
7360
|
+
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
7361
|
+
*
|
|
7362
|
+
*/
|
|
7363
|
+
videoId?: string;
|
|
7345
7364
|
};
|
|
7346
7365
|
};
|
|
7347
7366
|
|
|
@@ -12437,6 +12456,10 @@ export type GetGmbLocationsData = {
|
|
|
12437
12456
|
* Raw Google Business Information API filter expression (advanced; takes precedence over search), e.g. storeCode="LH279411".
|
|
12438
12457
|
*/
|
|
12439
12458
|
filter?: string;
|
|
12459
|
+
/**
|
|
12460
|
+
* Max locations to return (default 100, max 500). Raise it to enumerate an account with more than 100 locations; for accounts with thousands, use search/filter instead.
|
|
12461
|
+
*/
|
|
12462
|
+
limit?: number;
|
|
12440
12463
|
/**
|
|
12441
12464
|
* Free-text search on the business name, applied server-side by Google. Use for accounts with many locations.
|
|
12442
12465
|
*/
|
|
@@ -12463,9 +12486,9 @@ export type GetGmbLocationsResponse = ({
|
|
|
12463
12486
|
cached?: boolean;
|
|
12464
12487
|
});
|
|
12465
12488
|
|
|
12466
|
-
export type GetGmbLocationsError = ({
|
|
12489
|
+
export type GetGmbLocationsError = (unknown | {
|
|
12467
12490
|
error?: string;
|
|
12468
|
-
}
|
|
12491
|
+
});
|
|
12469
12492
|
|
|
12470
12493
|
export type UpdateGmbLocationData = {
|
|
12471
12494
|
body: {
|
|
@@ -24082,16 +24105,16 @@ export type BoostPostData = {
|
|
|
24082
24105
|
name?: string;
|
|
24083
24106
|
}>;
|
|
24084
24107
|
/**
|
|
24085
|
-
* City targeting. Optional `radius` + `
|
|
24108
|
+
* City targeting. Optional `radius` + `distanceUnit` extend beyond the city limits (both set together, Meta only).
|
|
24086
24109
|
*/
|
|
24087
24110
|
cities?: Array<{
|
|
24088
24111
|
key: string;
|
|
24089
24112
|
name?: string;
|
|
24090
24113
|
/**
|
|
24091
|
-
* Requires
|
|
24114
|
+
* Requires distanceUnit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
24092
24115
|
*/
|
|
24093
24116
|
radius?: number;
|
|
24094
|
-
|
|
24117
|
+
distanceUnit?: 'mile' | 'kilometer';
|
|
24095
24118
|
}>;
|
|
24096
24119
|
/**
|
|
24097
24120
|
* Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`).
|
|
@@ -24497,7 +24520,7 @@ export type CreateStandaloneAdData = {
|
|
|
24497
24520
|
*/
|
|
24498
24521
|
key: string;
|
|
24499
24522
|
/**
|
|
24500
|
-
* Optional radius around the city. Must be set together with distance_unit.
|
|
24523
|
+
* Optional radius around the city. Must be set together with distance_unit. Meta enforces a minimum city radius (~17 km / 10 mi); smaller values resolve to a 0-size audience and the ad fails at launch. For a tighter catchment use customLocations (lat/lng).
|
|
24501
24524
|
*/
|
|
24502
24525
|
radius?: number;
|
|
24503
24526
|
/**
|
|
@@ -24564,7 +24587,7 @@ export type CreateStandaloneAdData = {
|
|
|
24564
24587
|
*/
|
|
24565
24588
|
incomeTier?: 'top_5' | 'top_10' | 'top_10_25' | 'top_25_50';
|
|
24566
24589
|
/**
|
|
24567
|
-
* Language codes (e.g. ['en']).
|
|
24590
|
+
* Language codes restricting the audience by language. On Meta, ISO 639-1 codes (e.g. ['en'], ['de']); a bare code targets all regional variants ("en" = all English), or use a region-qualified code for a specific one ("en_GB", "pt_BR", "zh_TW"). Unknown codes are rejected. Other ad platforms use their own language-code systems.
|
|
24568
24591
|
*/
|
|
24569
24592
|
languages?: Array<(string)>;
|
|
24570
24593
|
/**
|
|
@@ -26641,6 +26664,10 @@ export type CreateCtwaAdData = {
|
|
|
26641
26664
|
* TargetingGeoLocationCity. `key` is Meta's city ID
|
|
26642
26665
|
* (lookupable via GET /v1/ads/targeting/search). `radius`
|
|
26643
26666
|
* and `distance_unit` are coupled: set both or neither.
|
|
26667
|
+
* Meta enforces a minimum city radius (~17 km / 10 mi);
|
|
26668
|
+
* smaller values resolve to a 0-size audience and the ad
|
|
26669
|
+
* fails at launch. For a tighter catchment use customLocations
|
|
26670
|
+
* (lat/lng).
|
|
26644
26671
|
*
|
|
26645
26672
|
*/
|
|
26646
26673
|
cities?: Array<{
|