Game Internationalization v1

Reference for the Game Internationalization v1 endpoints on Roblox.

Base URL: https://gameinternationalization.roblox.com

Endpoints

Method	Path	Name
POST	/v1/autolocalization/games/:gameId/autolocalizationtable	postAutolocalizationGamesGameidAutolocalizationtable
PATCH	/v1/autolocalization/games/:gameId/autolocalizationtable	patchAutolocalizationGamesGameidAutolocalizationtable
PATCH	/v1/autolocalization/games/:gameId/settings	patchAutolocalizationGamesGameidSettings
GET	/v1/autolocalization/metadata	getAutolocalizationMetadata
GET	/v1/automatic-translation/games/:gameId/feature-status	getAutomaticTranslationGamesGameidFeatureStatus
GET	/v1/automatic-translation/games/:gameId/quota	getAutomaticTranslationGamesGameidQuota
GET	/v1/automatic-translation/languages/:languageCode/target-languages	getAutomaticTranslationLanguagesLanguagecodeTargetLanguages
PATCH	/v1/badges/:badgeId/description/language-codes/:languageCode	patchBadgesBadgeidDescriptionLanguageCodesLanguagecode
GET	/v1/badges/:badgeId/icons	getBadgesBadgeidIcons
POST	/v1/badges/:badgeId/icons/language-codes/:languageCode	postBadgesBadgeidIconsLanguageCodesLanguagecode
DELETE	/v1/badges/:badgeId/icons/language-codes/:languageCode	deleteBadgesBadgeidIconsLanguageCodesLanguagecode
GET	/v1/badges/:badgeId/name-description	getBadgesBadgeidNameDescription
DELETE	/v1/badges/:badgeId/name-description/language-codes/:languageCode	deleteBadgesBadgeidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/badges/:badgeId/name-description/language-codes/:languageCode	patchBadgesBadgeidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/badges/:badgeId/name/language-codes/:languageCode	patchBadgesBadgeidNameLanguageCodesLanguagecode
PATCH	/v1/developer-products/:developerProductId/description/language-codes/:languageCode	patchDeveloperProductsDeveloperproductidDescriptionLanguageCodesLanguagecode
GET	/v1/developer-products/:developerProductId/icons	getDeveloperProductsDeveloperproductidIcons
POST	/v1/developer-products/:developerProductId/icons/language-codes/:languageCode	postDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode
DELETE	/v1/developer-products/:developerProductId/icons/language-codes/:languageCode	deleteDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode
GET	/v1/developer-products/:developerProductId/name-description	getDeveloperProductsDeveloperproductidNameDescription
DELETE	/v1/developer-products/:developerProductId/name-description/language-codes/:languageCode	deleteDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/developer-products/:developerProductId/name-description/language-codes/:languageCode	patchDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/developer-products/:developerProductId/name/language-codes/:languageCode	patchDeveloperProductsDeveloperproductidNameLanguageCodesLanguagecode
GET	/v1/game-icon/games/:gameId	getGameIconGamesGameid
POST	/v1/game-icon/games/:gameId/language-codes/:languageCode	postGameIconGamesGameidLanguageCodesLanguagecode
DELETE	/v1/game-icon/games/:gameId/language-codes/:languageCode	deleteGameIconGamesGameidLanguageCodesLanguagecode
GET	/v1/game-localization-status/:gameId/translation-counts	getGameLocalizationStatusGameidTranslationCounts
GET	/v1/game-localization-status/translation-counts-for-language-or-locale	getGameLocalizationStatusTranslationCountsForLanguageOrLocale
PATCH	/v1/game-passes/:gamePassId/description/language-codes/:languageCode	patchGamePassesGamepassidDescriptionLanguageCodesLanguagecode
GET	/v1/game-passes/:gamePassId/icons	getGamePassesGamepassidIcons
POST	/v1/game-passes/:gamePassId/icons/language-codes/:languageCode	postGamePassesGamepassidIconsLanguageCodesLanguagecode
DELETE	/v1/game-passes/:gamePassId/icons/language-codes/:languageCode	deleteGamePassesGamepassidIconsLanguageCodesLanguagecode
GET	/v1/game-passes/:gamePassId/name-description	getGamePassesGamepassidNameDescription
DELETE	/v1/game-passes/:gamePassId/name-description/language-codes/:languageCode	deleteGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/game-passes/:gamePassId/name-description/language-codes/:languageCode	patchGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode
PATCH	/v1/game-passes/:gamePassId/name/language-codes/:languageCode	patchGamePassesGamepassidNameLanguageCodesLanguagecode
GET	/v1/game-thumbnails/games/:gameId/images	getGameThumbnailsGamesGameidImages
POST	/v1/game-thumbnails/games/:gameId/language-codes/:languageCode/alt-text	postGameThumbnailsGamesGameidLanguageCodesLanguagecodeAltText
POST	/v1/game-thumbnails/games/:gameId/language-codes/:languageCode/image	postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImage
DELETE	/v1/game-thumbnails/games/:gameId/language-codes/:languageCode/images/:imageId	deleteGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesImageid
POST	/v1/game-thumbnails/games/:gameId/language-codes/:languageCode/images/order	postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesOrder
PATCH	/v1/localizationtable/gametables/:gameId	patchLocalizationtableGametablesGameid
GET	/v1/name-description/games/:gameId	getNameDescriptionGamesGameid
PATCH	/v1/name-description/games/:gameId	patchNameDescriptionGamesGameid
POST	/v1/name-description/games/translation-history	postNameDescriptionGamesTranslationHistory
GET	/v1/name-description/metadata	getNameDescriptionMetadata
GET	/v1/source-language/games/:gameId	getSourceLanguageGamesGameid
PATCH	/v1/source-language/games/:gameId	patchSourceLanguageGamesGameid
GET	/v1/source-language/games/:gameId/language-with-locales	getSourceLanguageGamesGameidLanguageWithLocales
GET	/v1/supported-languages/games/:gameId	getSupportedLanguagesGamesGameid
PATCH	/v1/supported-languages/games/:gameId	patchSupportedLanguagesGamesGameid
GET	/v1/supported-languages/games/:gameId/automatic-translation-status	getSupportedLanguagesGamesGameidAutomaticTranslationStatus
GET	/v1/supported-languages/games/:gameId/in-experience-language-selection	getSupportedLanguagesGamesGameidInExperienceLanguageSelection
PATCH	/v1/supported-languages/games/:gameId/languages/:languageCode/automatic-translation-status	patchSupportedLanguagesGamesGameidLanguagesLanguagecodeAutomaticTranslationStatus
PATCH	/v1/supported-languages/games/:gameId/languages/:languageCode/universe-display-info-automatic-translation-settings	patchSupportedLanguagesGamesGameidLanguagesLanguagecodeUniverseDisplayInfoAutomaticTranslationSettings
GET	/v1/supported-languages/games/:gameId/universe-display-info-automatic-translation-settings	getSupportedLanguagesGamesGameidUniverseDisplayInfoAutomaticTranslationSettings
GET	/v1/supported-languages/metadata	getSupportedLanguagesMetadata
GET	/v1/translation-analytics/games/:gameId/download-translation-analytics-report	getTranslationAnalyticsGamesGameidDownloadTranslationAnalyticsReport
POST	/v1/translation-analytics/games/:gameId/request-translation-analytics-report	postTranslationAnalyticsGamesGameidRequestTranslationAnalyticsReport
GET	/v1/translation-analytics/metadata	getTranslationAnalyticsMetadata
GET	/v1/ui-configurations	getUiConfigurations
GET	/v1/user-localization-settings/player-choice/:universeId	getUserLocalizationSettingsPlayerChoiceUniverseid
GET	/v1/user-localization-settings/universe/:universeId	getUserLocalizationSettingsUniverseUniverseid
POST	/v1/user-localization-settings/universe/:universeId	postUserLocalizationSettingsUniverseUniverseid

postAutolocalizationGamesGameidAutolocalizationtable

POST /v1/autolocalization/games/:gameId/autolocalizationtable

Usage

import { fetchApi } from 'rozod';
import { postAutolocalizationGamesGameidAutolocalizationtable } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postAutolocalizationGamesGameidAutolocalizationtable, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes

Response

Field	Type	Description
isAutolocalizationEnabled	boolean
shouldUseLocalizationTable	boolean
autoLocalizationTableId	string
assetId	number

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

---

patchAutolocalizationGamesGameidAutolocalizationtable

PATCH /v1/autolocalization/games/:gameId/autolocalizationtable

Usage

import { fetchApi } from 'rozod';
import { patchAutolocalizationGamesGameidAutolocalizationtable } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchAutolocalizationGamesGameidAutolocalizationtable, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes

Request Body

Field	Type	Description
tableId	string

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

---

patchAutolocalizationGamesGameidSettings

PATCH /v1/autolocalization/games/:gameId/settings

Sets a game’s auto-localization related settings

Usage

import { fetchApi } from 'rozod';
import { patchAutolocalizationGamesGameidSettings } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchAutolocalizationGamesGameidSettings, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Request Body

Field	Type	Description
isAutolocalizationEnabled	boolean
shouldUseLocalizationTable	boolean

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

getAutolocalizationMetadata

GET /v1/autolocalization/metadata

Metadata for AutoLocalization Configuration

Usage

import { fetchApi } from 'rozod';
import { getAutolocalizationMetadata } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getAutolocalizationMetadata, undefined);

Response

Field	Type	Description
isReactVersionEnabledForAutoLocalizationSettings	boolean
isTabbedUIEnabledForConfigureLocalizationPage	boolean
isAutomaticTranslationToggleUIEnabled	boolean
isAutomaticTranslationQuotaUIEnabled	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.

---

getAutomaticTranslationGamesGameidFeatureStatus

GET /v1/automatic-translation/games/:gameId/feature-status

Checks if automatic translation can be enabled for a game.

Usage

import { fetchApi } from 'rozod';
import { getAutomaticTranslationGamesGameidFeatureStatus } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getAutomaticTranslationGamesGameidFeatureStatus, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game id.

Response

Field	Type	Description
gameId	number
isAutomaticTranslationAllowed	boolean
isAutomaticTranslationSwitchesUIEnabled	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	18: You do not have permission to manage this game
503	17: Feature is disabled

---

getAutomaticTranslationGamesGameidQuota

GET /v1/automatic-translation/games/:gameId/quota

Returns the automatic translation quota info for a game.

Usage

import { fetchApi } from 'rozod';
import { getAutomaticTranslationGamesGameidQuota } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getAutomaticTranslationGamesGameidQuota, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game id.

Response

Field	Type	Description
monthlyQuota	object	See below
bankQuota	object	See below

monthlyQuota fields:

Field	Type	Description
previousRefreshDate	string
nextRefreshDate	string
remaining	number
capacity	number

bankQuota fields:

Field	Type	Description
remaining	number
capacity	number

Errors

Status	Description
400	14: Invalid game id
401	0: Authorization has been denied for this request.
403	18: You do not have permission to manage this game
503	17: Feature is disabled

---

getAutomaticTranslationLanguagesLanguagecodeTargetLanguages

GET /v1/automatic-translation/languages/:languageCode/target-languages

Checks if the requested target languages are allowed for automatic translation based on the source language.

Usage

import { fetchApi } from 'rozod';
import { getAutomaticTranslationLanguagesLanguagecodeTargetLanguages } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getAutomaticTranslationLanguagesLanguagecodeTargetLanguages, {
  languageCode: /* string */,
  targetLanguages: /* string? */,
  gameId: /* integer? */
});

Parameters

Name	Type	Required	Description
languageCode	string	Yes	The source language.
targetLanguages	string?	No	Optional target languages. If not passed in, all allowed target languages for the source language will be returned.
gameId	integer?	No	Optional gameId. If not passed in, we’ll return the default list of languages allowed.

Response

Field	Type	Description
sourceLanguage	string
targetLanguages	object[]	See below

targetLanguages[] item fields:

Field	Type	Description
languageCode	string
isAutomaticTranslationAllowed	boolean

Errors

Status	Description
400	73: Maximum languages exceeded. Please keep the number of languages per request below the maximum. 74: A target language cannot be null or whitespace.
503	17: Feature is disabled

---

patchBadgesBadgeidDescriptionLanguageCodesLanguagecode

PATCH /v1/badges/:badgeId/description/language-codes/:languageCode

Update localized description of a badge

Usage

import { fetchApi } from 'rozod';
import { patchBadgesBadgeidDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchBadgesBadgeidDescriptionLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The badge id
languageCode	string	Yes	The language code of the description to update

Request Body

Field	Type	Description
description	string

Response

Field	Type	Description
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getBadgesBadgeidIcons

GET /v1/badges/:badgeId/icons

Get all icons for a badge

Usage

import { fetchApi } from 'rozod';
import { getBadgesBadgeidIcons } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getBadgesBadgeidIcons, {
  badgeId: /* integer */,
  width: /* integer? = 150 */,
  height: /* integer? = 150 */
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The id of the badge
width	integer? = 150	No	The width of the icon to request
height	integer? = 150	No	The height of the icon to request

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
imageId	string
imageUrl	string
state	`“Approved"	"PendingReview"
languageCode	string

Errors

Status	Description
400	52: Image dimensions are invalid 62: Invalid game badge id
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

postBadgesBadgeidIconsLanguageCodesLanguagecode

POST /v1/badges/:badgeId/icons/language-codes/:languageCode

Update a badge’s icon

Usage

import { fetchApi } from 'rozod';
import { postBadgesBadgeidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postBadgesBadgeidIconsLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The id of the badge
languageCode	string	Yes	The language code of this icon to update

Request Body

Field	Type	Description
Files	File

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 26: You can’t update translations for source language 45: File uploaded does not match known image format 46: File not present in request 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

deleteBadgesBadgeidIconsLanguageCodesLanguagecode

DELETE /v1/badges/:badgeId/icons/language-codes/:languageCode

Delete a localized icon from a badge

Usage

import { fetchApi } from 'rozod';
import { deleteBadgesBadgeidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteBadgesBadgeidIconsLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The id of the badge
languageCode	string	Yes	The language code of the localized icon to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getBadgesBadgeidNameDescription

GET /v1/badges/:badgeId/name-description

Usage

import { fetchApi } from 'rozod';
import { getBadgesBadgeidNameDescription } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getBadgesBadgeidNameDescription, {
  badgeId: /* integer */
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

Errors

Status	Description
400	62: Invalid game badge id
401	0: Authorization has been denied for this request.
503	17: Feature is disabled

---

deleteBadgesBadgeidNameDescriptionLanguageCodesLanguagecode

DELETE /v1/badges/:badgeId/name-description/language-codes/:languageCode

Delete localized name and description of a badge

Usage

import { fetchApi } from 'rozod';
import { deleteBadgesBadgeidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteBadgesBadgeidNameDescriptionLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The badge id
languageCode	string	Yes	The language code of the name and description to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

patchBadgesBadgeidNameDescriptionLanguageCodesLanguagecode

PATCH /v1/badges/:badgeId/name-description/language-codes/:languageCode

Update localized name and description of a badge

Usage

import { fetchApi } from 'rozod';
import { patchBadgesBadgeidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchBadgesBadgeidNameDescriptionLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The badge id
languageCode	string	Yes	The language code of the name and description to Update

Request Body

Field	Type	Description
name	string
description	string

Response

Field	Type	Description
name	string
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

patchBadgesBadgeidNameLanguageCodesLanguagecode

PATCH /v1/badges/:badgeId/name/language-codes/:languageCode

Update localized name of a badge

Usage

import { fetchApi } from 'rozod';
import { patchBadgesBadgeidNameLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchBadgesBadgeidNameLanguageCodesLanguagecode, {
  badgeId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
badgeId	integer	Yes	The badge id
languageCode	string	Yes	The language code of the name to update

Request Body

Field	Type	Description
name	string

Response

Field	Type	Description
name	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 62: Invalid game badge id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

patchDeveloperProductsDeveloperproductidDescriptionLanguageCodesLanguagecode

PATCH /v1/developer-products/:developerProductId/description/language-codes/:languageCode

Update localized description of a developer product

Usage

import { fetchApi } from 'rozod';
import { patchDeveloperProductsDeveloperproductidDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchDeveloperProductsDeveloperproductidDescriptionLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The developer product id
languageCode	string	Yes	The language code of the description to update

Request Body

Field	Type	Description
description	string

Response

Field	Type	Description
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getDeveloperProductsDeveloperproductidIcons

GET /v1/developer-products/:developerProductId/icons

Get all icons for a developer product

Usage

import { fetchApi } from 'rozod';
import { getDeveloperProductsDeveloperproductidIcons } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getDeveloperProductsDeveloperproductidIcons, {
  developerProductId: /* integer */,
  width: /* integer? = 150 */,
  height: /* integer? = 150 */
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The id of the developer product
width	integer? = 150	No	The width of the icon to request
height	integer? = 150	No	The height of the icon to request

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
imageId	string
imageUrl	string
state	`“Approved"	"PendingReview"
languageCode	string

Errors

Status	Description
400	52: Image dimensions are invalid 70: Invalid developer product id
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

postDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode

POST /v1/developer-products/:developerProductId/icons/language-codes/:languageCode

Update a developer product’s icon

Usage

import { fetchApi } from 'rozod';
import { postDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The id of the developer product
languageCode	string	Yes	The language code of this icon to update

Request Body

Field	Type	Description
Files	File

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 26: You can’t update translations for source language 45: File uploaded does not match known image format 46: File not present in request 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

deleteDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode

DELETE /v1/developer-products/:developerProductId/icons/language-codes/:languageCode

Delete a localized icon from a developer product

Usage

import { fetchApi } from 'rozod';
import { deleteDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteDeveloperProductsDeveloperproductidIconsLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The id of the developer product
languageCode	string	Yes	The language code of the localized icon to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getDeveloperProductsDeveloperproductidNameDescription

GET /v1/developer-products/:developerProductId/name-description

Get all names and descriptions of a developer product

Usage

import { fetchApi } from 'rozod';
import { getDeveloperProductsDeveloperproductidNameDescription } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getDeveloperProductsDeveloperproductidNameDescription, {
  developerProductId: /* integer */
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The developer product Id

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

Errors

Status	Description
400	70: Invalid developer product id
401	0: Authorization has been denied for this request.
503	17: Feature is disabled

---

deleteDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode

DELETE /v1/developer-products/:developerProductId/name-description/language-codes/:languageCode

Delete localized name and description of a developer product

Usage

import { fetchApi } from 'rozod';
import { deleteDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The developer product id
languageCode	string	Yes	The language code of the name and description to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

patchDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode

PATCH /v1/developer-products/:developerProductId/name-description/language-codes/:languageCode

Update localized name and description of a developer product

Usage

import { fetchApi } from 'rozod';
import { patchDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchDeveloperProductsDeveloperproductidNameDescriptionLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The developer product id
languageCode	string	Yes	The language code of the name and description to Update

Request Body

Field	Type	Description
name	string
description	string

Response

Field	Type	Description
name	string
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

patchDeveloperProductsDeveloperproductidNameLanguageCodesLanguagecode

PATCH /v1/developer-products/:developerProductId/name/language-codes/:languageCode

Update localized name of a developer product

Usage

import { fetchApi } from 'rozod';
import { patchDeveloperProductsDeveloperproductidNameLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchDeveloperProductsDeveloperproductidNameLanguageCodesLanguagecode, {
  developerProductId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
developerProductId	integer	Yes	The developer product id
languageCode	string	Yes	The language code of the name to update

Request Body

Field	Type	Description
name	string

Response

Field	Type	Description
name	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 70: Invalid developer product id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getGameIconGamesGameid

GET /v1/game-icon/games/:gameId

Get all icons for a game

Usage

import { fetchApi } from 'rozod';
import { getGameIconGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGameIconGamesGameid, {
  gameId: /* integer */,
  width: /* integer? = 512 */,
  height: /* integer? = 512 */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game
width	integer? = 512	No	The width of the icon to request
height	integer? = 512	No	The height of the icon to request

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
imageId	string
imageUrl	string
state	`“Approved"	"PendingReview"
languageCode	string

Errors

Status	Description
400	14: Invalid game id 52: Image dimensions are invalid
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

postGameIconGamesGameidLanguageCodesLanguagecode

POST /v1/game-icon/games/:gameId/language-codes/:languageCode

Update a game’s icon

Usage

import { fetchApi } from 'rozod';
import { postGameIconGamesGameidLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postGameIconGamesGameidLanguageCodesLanguagecode, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game
languageCode	string	Yes	The language code of this icon to update

Request Body

Field	Type	Description
Files	File

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 26: You can’t update translations for source language 45: File uploaded does not match known image format 46: File not present in request 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

deleteGameIconGamesGameidLanguageCodesLanguagecode

DELETE /v1/game-icon/games/:gameId/language-codes/:languageCode

Delete a localized icon from a game

Usage

import { fetchApi } from 'rozod';
import { deleteGameIconGamesGameidLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteGameIconGamesGameidLanguageCodesLanguagecode, {
  gameId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game
languageCode	string	Yes	The language code of the localized icon to delete

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getGameLocalizationStatusGameidTranslationCounts

GET /v1/game-localization-status/:gameId/translation-counts

Gets the language translation counts for all languages of a game

Usage

import { fetchApi } from 'rozod';
import { getGameLocalizationStatusGameidTranslationCounts } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGameLocalizationStatusGameidTranslationCounts, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	GameID of the game to get translation counts for

Response

Field	Type	Description
gameId	number
languagesOrLocales	object[]	See below

languagesOrLocales[] item fields:

Field	Type	Description
status	`“Success"	"LanguageOrLocaleNotSupportedForGame”`
categories	object[]	See below
name	string
languageCodeType	`“Language"	"Locale”`
languageCode	string

categories[] item fields:

Field	Type	Description
category	'InGameContent'
translationCounts	object[]	See below
totalTranslatableItemCount	number

translationCounts[] item fields:

Field	Type	Description
count	number
translationStatus	'Approved'
translatorType	`“Automation"	"User”`

Errors

Status	Description
400	4: Table does not exist. 14: Invalid game id
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.

---

getGameLocalizationStatusTranslationCountsForLanguageOrLocale

GET /v1/game-localization-status/translation-counts-for-language-or-locale

Gets the language translation counts for the specified table.

Usage

import { fetchApi } from 'rozod';
import { getGameLocalizationStatusTranslationCountsForLanguageOrLocale } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGameLocalizationStatusTranslationCountsForLanguageOrLocale, {
  gameIds: /* number */,
  languageOrLocaleCode: /* string */,
  languageOrLocaleType: /* enum */
});

Parameters

Name	Type	Required	Description
gameIds	number	Yes	List of game ids to retrieve translation counts for.
languageOrLocaleCode	string	Yes	The code for the language or locale.
languageOrLocaleType	enum	Yes	Indicates whether the languageOrLocaleCode represents a language or locale.

Response

Field	Type	Description
languageOrLocaleCode	string
languageOrLocaleType	`“Language"	"Locale”`
games	object[]	See below

games[] item fields:

Field	Type	Description
gameId	number
status	`“LanguageOrLocaleSupportedForGame"	"LanguageOrLocaleNotSupportedForGame"
categories	object[]	See below

categories[] item fields:

Field	Type	Description
category	'InGameContent'
translationCounts	object[]	See below
totalTranslatableItemCount	number

translationCounts[] item fields:

Field	Type	Description
count	number
translationStatus	'Approved'
translatorType	`“Automation"	"User”`

Errors

Status	Description
400	66: Games can’t be null or empty 67: Maximum games exceeded. Please keep the number of games per request below the maximum. 68: LanguageOrLocaleCode is null or whitespace
401	0: Authorization has been denied for this request.

---

patchGamePassesGamepassidDescriptionLanguageCodesLanguagecode

PATCH /v1/game-passes/:gamePassId/description/language-codes/:languageCode

Update localized description of a game pass

Usage

import { fetchApi } from 'rozod';
import { patchGamePassesGamepassidDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchGamePassesGamepassidDescriptionLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of description to update

Request Body

Field	Type	Description
description	string

Response

Field	Type	Description
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

getGamePassesGamepassidIcons

GET /v1/game-passes/:gamePassId/icons

Get all icons for a game pass

Usage

import { fetchApi } from 'rozod';
import { getGamePassesGamepassidIcons } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGamePassesGamepassidIcons, {
  gamePassId: /* integer */,
  width: /* integer? = 150 */,
  height: /* integer? = 150 */
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
width	integer? = 150	No	The width of the icon to request
height	integer? = 150	No	The height of the icon to request

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
imageId	string
imageUrl	string
state	`“Approved"	"PendingReview"
languageCode	string

Errors

Status	Description
400	52: Image dimensions are invalid 61: Invalid game pass id
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

postGamePassesGamepassidIconsLanguageCodesLanguagecode

POST /v1/game-passes/:gamePassId/icons/language-codes/:languageCode

Update a game pass’s icon

Usage

import { fetchApi } from 'rozod';
import { postGamePassesGamepassidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postGamePassesGamepassidIconsLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of this icon to update

Request Body

Field	Type	Description
Files	File

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 26: You can’t update translations for source language 45: File uploaded does not match known image format 46: File not present in request 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

deleteGamePassesGamepassidIconsLanguageCodesLanguagecode

DELETE /v1/game-passes/:gamePassId/icons/language-codes/:languageCode

Delete a localized icon from a game pass

Usage

import { fetchApi } from 'rozod';
import { deleteGamePassesGamepassidIconsLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteGamePassesGamepassidIconsLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of the localized icon to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getGamePassesGamepassidNameDescription

GET /v1/game-passes/:gamePassId/name-description

Get all names and descriptions of a game pass

Usage

import { fetchApi } from 'rozod';
import { getGamePassesGamepassidNameDescription } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGamePassesGamepassidNameDescription, {
  gamePassId: /* integer */
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass Id

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

Errors

Status	Description
400	61: Invalid game pass id
401	0: Authorization has been denied for this request.
503	17: Feature is disabled

---

deleteGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode

DELETE /v1/game-passes/:gamePassId/name-description/language-codes/:languageCode

Delete localized name and description of a game pass

Usage

import { fetchApi } from 'rozod';
import { deleteGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of the name and description to delete

Response

Type: unknown

Errors

Status	Description
400	22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

patchGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode

PATCH /v1/game-passes/:gamePassId/name-description/language-codes/:languageCode

Update localized name and description of a game pass

Usage

import { fetchApi } from 'rozod';
import { patchGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchGamePassesGamepassidNameDescriptionLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of the name/description to update

Request Body

Field	Type	Description
name	string
description	string

Response

Field	Type	Description
name	string
description	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

patchGamePassesGamepassidNameLanguageCodesLanguagecode

PATCH /v1/game-passes/:gamePassId/name/language-codes/:languageCode

Update localized name of a game pass

Usage

import { fetchApi } from 'rozod';
import { patchGamePassesGamepassidNameLanguageCodesLanguagecode } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchGamePassesGamepassidNameLanguageCodesLanguagecode, {
  gamePassId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gamePassId	integer	Yes	The game pass id
languageCode	string	Yes	The language code of the name to update

Request Body

Field	Type	Description
name	string

Response

Field	Type	Description
name	string

Errors

Status	Description
400	13: Request body can’t be null 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game. 61: Invalid game pass id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

getGameThumbnailsGamesGameidImages

GET /v1/game-thumbnails/games/:gameId/images

Get the localized image ids in all languages for a game.

Usage

import { fetchApi } from 'rozod';
import { getGameThumbnailsGamesGameidImages } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getGameThumbnailsGamesGameidImages, {
  gameId: /* integer */,
  width: /* integer? = 768 */,
  height: /* integer? = 432 */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game identifier.
width	integer? = 768	No	The width.
height	integer? = 432	No	The height.

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
languageCode	string
mediaAssets	object[]	See below

mediaAssets[] item fields:

Field	Type	Description
mediaAssetId	string
mediaAssetAltText	string
state	`“Approved"	"PendingReview"
mediaAssetUrl	string

Errors

Status	Description
400	14: Invalid game id 52: Image dimensions are invalid
500	0: An unknown error occurred.
503	17: Feature is disabled

---

postGameThumbnailsGamesGameidLanguageCodesLanguagecodeAltText

POST /v1/game-thumbnails/games/:gameId/language-codes/:languageCode/alt-text

Updates the game thumbnail alt text.

Usage

import { fetchApi } from 'rozod';
import { postGameThumbnailsGamesGameidLanguageCodesLanguagecodeAltText } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postGameThumbnailsGamesGameidLanguageCodesLanguagecodeAltText, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game identifier.
languageCode	string	Yes	The language code.

Request Body

Field	Type	Description
thumbnailId	number
altText	string

Response

Type: string

Errors

Status	Description
400	14: Invalid game id 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 26: You can’t update translations for source language 45: File uploaded does not match known image format 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred. 88: Failed to filter text
503	17: Feature is disabled

---

postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImage

POST /v1/game-thumbnails/games/:gameId/language-codes/:languageCode/image

Uploads the game thumbnail.

Usage

import { fetchApi } from 'rozod';
import { postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImage } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImage, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game identifier.
languageCode	string	Yes	The language code.

Request Body

Field	Type	Description
Files	File

Response

Field	Type	Description
mediaAssetId	string

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
429	24: Too many attempts.Please try again later.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

deleteGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesImageid

DELETE /v1/game-thumbnails/games/:gameId/language-codes/:languageCode/images/:imageId

Deletes the game thumbnail.

Usage

import { fetchApi } from 'rozod';
import { deleteGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesImageid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(deleteGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesImageid, {
  gameId: /* integer */,
  languageCode: /* string */,
  imageId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game identifier.
languageCode	string	Yes	The language code.
imageId	integer	Yes	The image identifier.

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 23: You can’t delete translations for source language 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesOrder

POST /v1/game-thumbnails/games/:gameId/language-codes/:languageCode/images/order

Orders the specified image Ids for the game thumbnails.

Usage

import { fetchApi } from 'rozod';
import { postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesOrder } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postGameThumbnailsGamesGameidLanguageCodesLanguagecodeImagesOrder, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game identifier.
languageCode	string	Yes	The language code.

Request Body

Field	Type	Description
mediaAssetIds	number[]

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 26: You can’t update translations for source language 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

patchLocalizationtableGametablesGameid

PATCH /v1/localizationtable/gametables/:gameId

Usage

import { fetchApi } from 'rozod';
import { patchLocalizationtableGametablesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchLocalizationtableGametablesGameid, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes

Request Body

Field	Type	Description
tables	object[]	See below

tables[] item fields:

Field	Type	Description
id	string
dissociate	boolean

Response

Field	Type	Description
success	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

---

getNameDescriptionGamesGameid

GET /v1/name-description/games/:gameId

Gets a game’s name and description in all supported languages

Usage

import { fetchApi } from 'rozod';
import { getNameDescriptionGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getNameDescriptionGamesGameid, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

Errors

Status	Description
400	14: Invalid game id
503	17: Feature is disabled

---

patchNameDescriptionGamesGameid

PATCH /v1/name-description/games/:gameId

Updates a game’s name and/or description in multiple languages.

Usage

import { fetchApi } from 'rozod';
import { patchNameDescriptionGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchNameDescriptionGamesGameid, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Request Body

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

Response

Field	Type	Description
successOperations	object[]	See below
failedOperations	object[]	See below

successOperations[] item fields:

Field	Type	Description
name	string
description	string
updateType	`“Invalid"	"Name"
languageCode	string

failedOperations[] item fields:

Field	Type	Description
languageCode	string
errorCode	number

Errors

Status	Description
400	14: Invalid game id 19: New name is null or whitespaces or new name/description is too long 20: New name or description is moderated 22: Invalid language code 23: You can’t delete translations for source language 26: You can’t update translations for source language 53: Language is not supported for the game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

postNameDescriptionGamesTranslationHistory

POST /v1/name-description/games/translation-history

Gets the history for name or description in a provided language.

Usage

import { fetchApi } from 'rozod';
import { postNameDescriptionGamesTranslationHistory } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postNameDescriptionGamesTranslationHistory, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
contentId	number
contentType	`“UniverseDisplayNames"	"UniverseDisplayDescriptions"
languageCode	string
cursor	string
count	number
sortOrder	`“Asc"	"Desc”`

Response

Field	Type	Description
history	object[]	See below
lastEvaluatedId	string

history[] item fields:

Field	Type	Description
translationText	string
translator	object	See below
created	string

translator fields:

Field	Type	Description
id	number
agentType	`“User"	"Automation”`

Errors

Status	Description
400	13: Request body can’t be null 14: Invalid game id 18: You do not have permission to manage this game 22: Invalid language code 39: Count should be at least 1 and less than 50. 53: Language is not supported for the game. 54: No history available for source data 55: Invalid exclusive start Id
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getNameDescriptionMetadata

GET /v1/name-description/metadata

Rollout settings for name/description migration to new page

Usage

import { fetchApi } from 'rozod';
import { getNameDescriptionMetadata } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getNameDescriptionMetadata, undefined);

Response

Field	Type	Description
isNameDescriptionMigrationEnabled	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.

---

getSourceLanguageGamesGameid

GET /v1/source-language/games/:gameId

Gets the source language of a game

Usage

import { fetchApi } from 'rozod';
import { getSourceLanguageGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSourceLanguageGamesGameid, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes

Response

Field	Type	Description
name	string
nativeName	string
languageCode	string

Errors

Status	Description
400	14: Invalid game id
503	17: Feature is disabled

---

patchSourceLanguageGamesGameid

PATCH /v1/source-language/games/:gameId

Sets the source language of a game

Usage

import { fetchApi } from 'rozod';
import { patchSourceLanguageGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchSourceLanguageGamesGameid, {
  gameId: /* integer */,
  languageCode: /* string */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes
languageCode	string	Yes

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	85: Failed to disable automatic translation status for languages
503	17: Feature is disabled

---

getSourceLanguageGamesGameidLanguageWithLocales

GET /v1/source-language/games/:gameId/language-with-locales

Gets the source language of a game

Usage

import { fetchApi } from 'rozod';
import { getSourceLanguageGamesGameidLanguageWithLocales } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSourceLanguageGamesGameidLanguageWithLocales, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes

Response

Field	Type	Description
languageFamily	object	See below
defaultLocale	object	See below
childLocales	object[]	See below

languageFamily fields:

Field	Type	Description
name	string
nativeName	string
languageCode	string

defaultLocale fields:

Field	Type	Description
id	number
locale	`“en_us"	"es_es"
localeCode	string
name	string
nativeName	string
language	object	See below

language fields:

Field	Type	Description
id	number
name	string
nativeName	string
languageCode	string
isRightToLeft	boolean

childLocales[] item fields:

Field	Type	Description
id	number
locale	`“en_us"	"es_es"
localeCode	string
name	string
nativeName	string
language	object	See below

language fields:

Field	Type	Description
id	number
name	string
nativeName	string
languageCode	string
isRightToLeft	boolean

Errors

Status	Description
400	14: Invalid game id
503	17: Feature is disabled

---

getSupportedLanguagesGamesGameid

GET /v1/supported-languages/games/:gameId

Get the supported languages for a game.

Usage

import { fetchApi } from 'rozod';
import { getSupportedLanguagesGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSupportedLanguagesGamesGameid, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
languageCodeType	`“Language"	"Locale”`
languageCode	string

Errors

Status	Description
400	14: Invalid game id
503	17: Feature is disabled

---

patchSupportedLanguagesGamesGameid

PATCH /v1/supported-languages/games/:gameId

Add or remove supported languages for a game.

Usage

import { fetchApi } from 'rozod';
import { patchSupportedLanguagesGamesGameid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchSupportedLanguagesGamesGameid, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Request Body

Array of objects:

Field	Type	Description
languageCodeType	`“Language"	"Locale”`
languageCode	string
delete	boolean

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 49: Duplicate language codes are not allowed.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

getSupportedLanguagesGamesGameidAutomaticTranslationStatus

GET /v1/supported-languages/games/:gameId/automatic-translation-status

Get the automatic translation status of supported languages for a game.

Usage

import { fetchApi } from 'rozod';
import { getSupportedLanguagesGamesGameidAutomaticTranslationStatus } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSupportedLanguagesGamesGameidAutomaticTranslationStatus, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
languageCodeType	`“Language"	"Locale”`
languageCode	string
isAutomaticTranslationEnabled	boolean

Errors

Status	Description
400	14: Invalid game id
401	0: Authorization has been denied for this request.
403	18: You do not have permission to manage this game
503	17: Feature is disabled

---

getSupportedLanguagesGamesGameidInExperienceLanguageSelection

GET /v1/supported-languages/games/:gameId/in-experience-language-selection

Get the user’s in-experience language selector languages for a game.

Usage

import { fetchApi } from 'rozod';
import { getSupportedLanguagesGamesGameidInExperienceLanguageSelection } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSupportedLanguagesGamesGameidInExperienceLanguageSelection, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
name	string
languageCodeType	`“Language"	"Locale”`
languageCode	string

Errors

Status	Description
400	14: Invalid game id
503	17: Feature is disabled

---

patchSupportedLanguagesGamesGameidLanguagesLanguagecodeAutomaticTranslationStatus

PATCH /v1/supported-languages/games/:gameId/languages/:languageCode/automatic-translation-status

Enable or disable automatic translation for a game and language.

Usage

import { fetchApi } from 'rozod';
import { patchSupportedLanguagesGamesGameidLanguagesLanguagecodeAutomaticTranslationStatus } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchSupportedLanguagesGamesGameidLanguagesLanguagecodeAutomaticTranslationStatus, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The id of the game.
languageCode	string	Yes	The language to enable or disable for automatic translation.

Request Body

Type: boolean

Response

Field	Type	Description
gameId	number
languageCode	string
isAutomaticTranslationEnabled	boolean

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code 53: Language is not supported for the game. 72: Automatic translation cannot be enabled for game. 75: Automatic translation cannot be enabled for language.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

---

patchSupportedLanguagesGamesGameidLanguagesLanguagecodeUniverseDisplayInfoAutomaticTranslationSettings

PATCH /v1/supported-languages/games/:gameId/languages/:languageCode/universe-display-info-automatic-translation-settings

Update the switch which controls if the UniverseDisplayInformation should be automatically translated.

Usage

import { fetchApi } from 'rozod';
import { patchSupportedLanguagesGamesGameidLanguagesLanguagecodeUniverseDisplayInfoAutomaticTranslationSettings } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(patchSupportedLanguagesGamesGameidLanguagesLanguagecodeUniverseDisplayInfoAutomaticTranslationSettings, {
  gameId: /* integer */,
  languageCode: /* string */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game id.
languageCode	string	Yes	The language code.

Request Body

Type: boolean

Response

Field	Type	Description
gameId	number
languageCode	string
isUniverseDisplayInfoAutomaticTranslationEnabled	boolean

Errors

Status	Description
400	14: Invalid game id 72: Automatic translation cannot be enabled for game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	77: Content localization set settings return error code invalid 79: Invalid content instance settings 80: Invalid quota settings 81: Invalid change agent 82: Failed to update UniverseDisplayInformation content instance auto translation settings

---

getSupportedLanguagesGamesGameidUniverseDisplayInfoAutomaticTranslationSettings

GET /v1/supported-languages/games/:gameId/universe-display-info-automatic-translation-settings

Get UniverseDisplayInfo automatic translation settings.

Usage

import { fetchApi } from 'rozod';
import { getSupportedLanguagesGamesGameidUniverseDisplayInfoAutomaticTranslationSettings } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSupportedLanguagesGamesGameidUniverseDisplayInfoAutomaticTranslationSettings, {
  gameId: /* integer */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game id.

Response

Field	Type	Description
data	object[]	See below

data[] item fields:

Field	Type	Description
languageCode	string
isUniverseDisplayInfoAutomaticTranslationEnabled	boolean

Errors

Status	Description
400	14: Invalid game id
401	0: Authorization has been denied for this request.
403	18: You do not have permission to manage this game
500	0: An unknown error occurred. 22: Invalid language code 83: Failed to get UniverseDisplayInformation content instance auto translation settings 84: Count of language code is larger than max batch get size

---

getSupportedLanguagesMetadata

GET /v1/supported-languages/metadata

Rollout settings for supported languages of a game

Usage

import { fetchApi } from 'rozod';
import { getSupportedLanguagesMetadata } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getSupportedLanguagesMetadata, undefined);

Response

Field	Type	Description
isFeatureEnabled	boolean
areAllLanguagesEnabled	boolean
minimumUniverseIdForFeature	number
isHumanTranslationProgressUIEnabled	boolean
isAutomaticTranslationProgressUIEnabled	boolean
isSupportedLanguagesChildLocalesUIEnabled	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.

---

getTranslationAnalyticsGamesGameidDownloadTranslationAnalyticsReport

GET /v1/translation-analytics/games/:gameId/download-translation-analytics-report

Download translation analytics report after the report is ready

Usage

import { fetchApi } from 'rozod';
import { getTranslationAnalyticsGamesGameidDownloadTranslationAnalyticsReport } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getTranslationAnalyticsGamesGameidDownloadTranslationAnalyticsReport, {
  gameId: /* integer */,
  startDateTime: /* string */
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game’s id
startDateTime	string	Yes	The inclusive start dateTime of report in UTC

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 56: You need to provide a valid translator group id to get report. 58: Start datetime or end datetime is invlaid. 59: Report type is invalid
401	0: Authorization has been denied for this request.
403	57: You do not have permission to request translation analytics report.

---

postTranslationAnalyticsGamesGameidRequestTranslationAnalyticsReport

POST /v1/translation-analytics/games/:gameId/request-translation-analytics-report

Request translation analytics report to be generated

Usage

import { fetchApi } from 'rozod';
import { postTranslationAnalyticsGamesGameidRequestTranslationAnalyticsReport } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postTranslationAnalyticsGamesGameidRequestTranslationAnalyticsReport, {
  gameId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
gameId	integer	Yes	The game’s id

Request Body

Field	Type	Description
startDateTime	string
endDateTime	string
reportType	`“GameTranslationStatus"	"GameTranslationStatusForTranslator"
reportSubjectTargetId	number

Response

Field	Type	Description
reportGenerationStatus	`“inProgress"	"ready"

Errors

Status	Description
400	14: Invalid game id 56: You need to provide a valid translator group id to get report. 58: Start datetime or end datetime is invlaid. 59: Report type is invalid
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 57: You do not have permission to request translation analytics report.

---

getTranslationAnalyticsMetadata

GET /v1/translation-analytics/metadata

Get metadata related to UI and rollout settings

Usage

import { fetchApi } from 'rozod';
import { getTranslationAnalyticsMetadata } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getTranslationAnalyticsMetadata, undefined);

Response

Field	Type	Description
isFeatureEnabledOnUI	boolean
reportRequestPollingIntervalSeconds	number
minimumDateTimeForAnalyticsReport	string

Errors

Status	Description
401	0: Authorization has been denied for this request.

---

getUiConfigurations

GET /v1/ui-configurations

Get ui configurations for frontend to use.

Usage

import { fetchApi } from 'rozod';
import { getUiConfigurations } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getUiConfigurations, undefined);

Response

Field	Type	Description
isGameProductsEnabled	boolean
isBadgeIconEnabled	boolean
isGamePassEnabled	boolean
isDeveloperProductEnabled	boolean

Errors

Status	Description
401	0: Authorization has been denied for this request.

---

getUserLocalizationSettingsPlayerChoiceUniverseid

GET /v1/user-localization-settings/player-choice/:universeId

Get user player choice settings for universe.

Usage

import { fetchApi } from 'rozod';
import { getUserLocalizationSettingsPlayerChoiceUniverseid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getUserLocalizationSettingsPlayerChoiceUniverseid, {
  universeId: /* integer */
});

Parameters

Name	Type	Required	Description
universeId	integer	Yes	The universe’s ID.

Response

Field	Type	Description
IsPlayerChoiceEnabled	boolean

Errors

Status	Description
400	14: Invalid game id
401	0: Authorization has been denied for this request.
500	0: An unknown error occurred.
503	17: Feature is disabled

---

getUserLocalizationSettingsUniverseUniverseid

GET /v1/user-localization-settings/universe/:universeId

Get user localization settings for universe.

Usage

import { fetchApi } from 'rozod';
import { getUserLocalizationSettingsUniverseUniverseid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(getUserLocalizationSettingsUniverseUniverseid, {
  universeId: /* integer */
});

Parameters

Name	Type	Required	Description
universeId	integer	Yes	The universe’s ID.

Response

Field	Type	Description
userUniverseLocalizationSettingValue	object	See below

userUniverseLocalizationSettingValue fields:

Field	Type	Description
settingType	`“LanguageFamily"	"SupportedLocale"
settingTargetId	number

Errors

Status	Description
400	14: Invalid game id 21: The language is not supported 22: Invalid language code
401	0: Authorization has been denied for this request.
503	17: Feature is disabled

---

postUserLocalizationSettingsUniverseUniverseid

POST /v1/user-localization-settings/universe/:universeId

Set user localization settings for universe.

Usage

import { fetchApi } from 'rozod';
import { postUserLocalizationSettingsUniverseUniverseid } from 'rozod/lib/endpoints/gameinternationalizationv1';

const data = await fetchApi(postUserLocalizationSettingsUniverseUniverseid, {
  universeId: /* integer */,
  body: { /* ... */ }
});

Parameters

Name	Type	Required	Description
universeId	integer	Yes	The universe’s ID.

Request Body

Field	Type	Description
settingValue	object	See below

settingValue fields:

Field	Type	Description
settingType	`“LanguageFamily"	"SupportedLocale"
settingTargetId	number

Response

Type: unknown

Errors

Status	Description
400	14: Invalid game id 22: Invalid language code
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
503	17: Feature is disabled

---