blob: 094f09f1316abefdbb5f62b98773422539ccf798 [file] [log] [blame] [edit]
{
"title": "Google Play Game Services Publishing API",
"name": "gamesConfiguration",
"revision": "20200811",
"kind": "discovery#restDescription",
"documentationLink": "https://developers.google.com/games/",
"rootUrl": "https://gamesconfiguration.googleapis.com/",
"resources": {
"achievementConfigurations": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"parameterOrder": [
"applicationId"
],
"parameters": {
"maxResults": {
"description": "The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified `maxResults`.",
"location": "query",
"format": "int32",
"type": "integer"
},
"applicationId": {
"description": "The application ID from the Google Play developer console.",
"required": true,
"type": "string",
"location": "path"
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
}
},
"path": "games/v1configuration/applications/{applicationId}/achievements",
"description": "Returns a list of the achievement configurations in this application.",
"flatPath": "games/v1configuration/applications/{applicationId}/achievements",
"response": {
"$ref": "AchievementConfigurationListResponse"
},
"httpMethod": "GET",
"id": "gamesConfiguration.achievementConfigurations.list"
},
"update": {
"id": "gamesConfiguration.achievementConfigurations.update",
"description": "Update the metadata of the achievement configuration with the given ID.",
"request": {
"$ref": "AchievementConfiguration"
},
"path": "games/v1configuration/achievements/{achievementId}",
"flatPath": "games/v1configuration/achievements/{achievementId}",
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"parameterOrder": [
"achievementId"
],
"response": {
"$ref": "AchievementConfiguration"
},
"parameters": {
"achievementId": {
"description": "The ID of the achievement used by this method.",
"location": "path",
"required": true,
"type": "string"
}
}
},
"get": {
"path": "games/v1configuration/achievements/{achievementId}",
"description": "Retrieves the metadata of the achievement configuration with the given ID.",
"id": "gamesConfiguration.achievementConfigurations.get",
"parameters": {
"achievementId": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the achievement used by this method."
}
},
"flatPath": "games/v1configuration/achievements/{achievementId}",
"httpMethod": "GET",
"parameterOrder": [
"achievementId"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"response": {
"$ref": "AchievementConfiguration"
}
},
"insert": {
"parameters": {
"applicationId": {
"description": "The application ID from the Google Play developer console.",
"type": "string",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"applicationId"
],
"flatPath": "games/v1configuration/applications/{applicationId}/achievements",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"id": "gamesConfiguration.achievementConfigurations.insert",
"httpMethod": "POST",
"request": {
"$ref": "AchievementConfiguration"
},
"response": {
"$ref": "AchievementConfiguration"
},
"path": "games/v1configuration/applications/{applicationId}/achievements",
"description": "Insert a new achievement configuration in this application."
},
"delete": {
"path": "games/v1configuration/achievements/{achievementId}",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"parameterOrder": [
"achievementId"
],
"parameters": {
"achievementId": {
"description": "The ID of the achievement used by this method.",
"required": true,
"location": "path",
"type": "string"
}
},
"flatPath": "games/v1configuration/achievements/{achievementId}",
"description": "Delete the achievement configuration with the given ID.",
"id": "gamesConfiguration.achievementConfigurations.delete"
}
}
},
"imageConfigurations": {
"methods": {
"upload": {
"description": "Uploads an image for a resource with the given ID and image type.",
"httpMethod": "POST",
"mediaUpload": {
"accept": [
"image/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/games/v1configuration/images/{resourceId}/imageType/{imageType}"
}
},
"maxSize": "15728640"
},
"parameters": {
"imageType": {
"description": "Selects which image in a resource for this method.",
"enum": [
"IMAGE_TYPE_UNSPECIFIED",
"ACHIEVEMENT_ICON",
"LEADERBOARD_ICON"
],
"type": "string",
"location": "path",
"enumDescriptions": [
"Default value. This value is unused.",
"The icon image for an achievement resource.",
"The icon image for a leaderboard resource."
],
"required": true
},
"resourceId": {
"type": "string",
"description": "The ID of the resource used by this method.",
"location": "path",
"required": true
}
},
"path": "games/v1configuration/images/{resourceId}/imageType/{imageType}",
"response": {
"$ref": "ImageConfiguration"
},
"supportsMediaUpload": true,
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"flatPath": "games/v1configuration/images/{resourceId}/imageType/{imageType}",
"parameterOrder": [
"resourceId",
"imageType"
],
"id": "gamesConfiguration.imageConfigurations.upload"
}
}
},
"leaderboardConfigurations": {
"methods": {
"list": {
"description": "Returns a list of the leaderboard configurations in this application.",
"parameters": {
"applicationId": {
"location": "path",
"required": true,
"description": "The application ID from the Google Play developer console.",
"type": "string"
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"maxResults": {
"format": "int32",
"description": "The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified `maxResults`.",
"location": "query",
"type": "integer"
}
},
"path": "games/v1configuration/applications/{applicationId}/leaderboards",
"parameterOrder": [
"applicationId"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"id": "gamesConfiguration.leaderboardConfigurations.list",
"httpMethod": "GET",
"response": {
"$ref": "LeaderboardConfigurationListResponse"
},
"flatPath": "games/v1configuration/applications/{applicationId}/leaderboards"
},
"insert": {
"request": {
"$ref": "LeaderboardConfiguration"
},
"path": "games/v1configuration/applications/{applicationId}/leaderboards",
"response": {
"$ref": "LeaderboardConfiguration"
},
"parameterOrder": [
"applicationId"
],
"parameters": {
"applicationId": {
"type": "string",
"description": "The application ID from the Google Play developer console.",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"id": "gamesConfiguration.leaderboardConfigurations.insert",
"description": "Insert a new leaderboard configuration in this application.",
"httpMethod": "POST",
"flatPath": "games/v1configuration/applications/{applicationId}/leaderboards"
},
"delete": {
"description": "Delete the leaderboard configuration with the given ID.",
"flatPath": "games/v1configuration/leaderboards/{leaderboardId}",
"parameterOrder": [
"leaderboardId"
],
"httpMethod": "DELETE",
"parameters": {
"leaderboardId": {
"description": "The ID of the leaderboard.",
"required": true,
"type": "string",
"location": "path"
}
},
"path": "games/v1configuration/leaderboards/{leaderboardId}",
"id": "gamesConfiguration.leaderboardConfigurations.delete",
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"response": {
"$ref": "LeaderboardConfiguration"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"id": "gamesConfiguration.leaderboardConfigurations.get",
"parameterOrder": [
"leaderboardId"
],
"parameters": {
"leaderboardId": {
"type": "string",
"required": true,
"description": "The ID of the leaderboard.",
"location": "path"
}
},
"description": "Retrieves the metadata of the leaderboard configuration with the given ID.",
"httpMethod": "GET",
"path": "games/v1configuration/leaderboards/{leaderboardId}",
"flatPath": "games/v1configuration/leaderboards/{leaderboardId}"
},
"update": {
"parameterOrder": [
"leaderboardId"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"request": {
"$ref": "LeaderboardConfiguration"
},
"parameters": {
"leaderboardId": {
"required": true,
"location": "path",
"description": "The ID of the leaderboard.",
"type": "string"
}
},
"id": "gamesConfiguration.leaderboardConfigurations.update",
"httpMethod": "PUT",
"description": "Update the metadata of the leaderboard configuration with the given ID.",
"flatPath": "games/v1configuration/leaderboards/{leaderboardId}",
"path": "games/v1configuration/leaderboards/{leaderboardId}",
"response": {
"$ref": "LeaderboardConfiguration"
}
}
}
}
},
"baseUrl": "https://gamesconfiguration.googleapis.com/",
"ownerDomain": "google.com",
"basePath": "",
"id": "gamesConfiguration:v1configuration",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidpublisher": {
"description": "View and manage your Google Play Developer account"
}
}
}
},
"schemas": {
"LeaderboardConfigurationListResponse": {
"id": "LeaderboardConfigurationListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#leaderboardConfigurationListResponse`."
},
"items": {
"items": {
"$ref": "LeaderboardConfiguration"
},
"description": "The leaderboard configurations.",
"type": "array"
},
"nextPageToken": {
"description": "The pagination token for the next page of results.",
"type": "string"
}
},
"description": "A ListConfigurations response.",
"type": "object"
},
"LeaderboardConfiguration": {
"type": "object",
"id": "LeaderboardConfiguration",
"description": "An leaderboard configuration resource.",
"properties": {
"published": {
"$ref": "LeaderboardConfigurationDetail",
"description": "The read-only published data of the leaderboard."
},
"id": {
"description": "The ID of the leaderboard.",
"type": "string"
},
"scoreOrder": {
"enumDescriptions": [
"Default value. This value is unused.",
"Larger scores posted are ranked higher.",
"Smaller scores posted are ranked higher."
],
"type": "string",
"enum": [
"SCORE_ORDER_UNSPECIFIED",
"LARGER_IS_BETTER",
"SMALLER_IS_BETTER"
]
},
"scoreMin": {
"type": "string",
"format": "int64",
"description": "Minimum score that can be posted to this leaderboard."
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#leaderboardConfiguration`."
},
"token": {
"type": "string",
"description": "The token for this resource."
},
"scoreMax": {
"type": "string",
"format": "int64",
"description": "Maximum score that can be posted to this leaderboard."
},
"draft": {
"description": "The draft data of the leaderboard.",
"$ref": "LeaderboardConfigurationDetail"
}
}
},
"AchievementConfigurationListResponse": {
"type": "object",
"description": "A ListConfigurations response.",
"id": "AchievementConfigurationListResponse",
"properties": {
"items": {
"description": "The achievement configurations.",
"items": {
"$ref": "AchievementConfiguration"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token for the next page of results.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#achievementConfigurationListResponse`."
}
}
},
"AchievementConfiguration": {
"properties": {
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#achievementConfiguration`.",
"type": "string"
},
"token": {
"type": "string",
"description": "The token for this resource."
},
"stepsToUnlock": {
"format": "int32",
"type": "integer",
"description": "Steps to unlock. Only applicable to incremental achievements."
},
"id": {
"type": "string",
"description": "The ID of the achievement."
},
"achievementType": {
"enum": [
"ACHIEVEMENT_TYPE_UNSPECIFIED",
"STANDARD",
"INCREMENTAL"
],
"description": "The type of the achievement.",
"enumDescriptions": [
"Default value. This value is unused.",
"Achievement is either locked or unlocked.",
"Achievement is incremental."
],
"type": "string"
},
"draft": {
"description": "The draft data of the achievement.",
"$ref": "AchievementConfigurationDetail"
},
"initialState": {
"description": "The initial state of the achievement.",
"enumDescriptions": [
"Default value. This value is unused.",
"Achievement is hidden.",
"Achievement is revealed."
],
"enum": [
"INITIAL_STATE_UNSPECIFIED",
"HIDDEN",
"REVEALED"
],
"type": "string"
},
"published": {
"description": "The read-only published data of the achievement.",
"$ref": "AchievementConfigurationDetail"
}
},
"type": "object",
"description": "An achievement configuration resource.",
"id": "AchievementConfiguration"
},
"GamesNumberFormatConfiguration": {
"description": "A number format resource.",
"id": "GamesNumberFormatConfiguration",
"properties": {
"currencyCode": {
"description": "The curreny code string. Only used for CURRENCY format type.",
"type": "string"
},
"numberFormatType": {
"description": "The formatting for the number.",
"enumDescriptions": [
"Default value. This value is unused.",
"Numbers are formatted to have no digits or fixed number of digits after the decimal point according to locale. An optional custom unit can be added.",
"Numbers are formatted to hours, minutes and seconds.",
"Numbers are formatted to currency according to locale."
],
"type": "string",
"enum": [
"NUMBER_FORMAT_TYPE_UNSPECIFIED",
"NUMERIC",
"TIME_DURATION",
"CURRENCY"
]
},
"numDecimalPlaces": {
"description": "The number of decimal places for number. Only used for NUMERIC format type.",
"format": "int32",
"type": "integer"
},
"suffix": {
"description": "An optional suffix for the NUMERIC format type. These strings follow the same plural rules as all Android string resources.",
"$ref": "GamesNumberAffixConfiguration"
}
},
"type": "object"
},
"LocalizedStringBundle": {
"type": "object",
"description": "A localized string bundle resource.",
"properties": {
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#localizedStringBundle`.",
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "LocalizedString"
},
"description": "The locale strings."
}
},
"id": "LocalizedStringBundle"
},
"ImageConfiguration": {
"properties": {
"resourceId": {
"type": "string",
"description": "The resource ID of resource which the image belongs to."
},
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#imageConfiguration`.",
"type": "string"
},
"imageType": {
"description": "The image type for the image.",
"enum": [
"IMAGE_TYPE_UNSPECIFIED",
"ACHIEVEMENT_ICON",
"LEADERBOARD_ICON"
],
"type": "string",
"enumDescriptions": [
"Default value. This value is unused.",
"The icon image for an achievement resource.",
"The icon image for a leaderboard resource."
]
},
"url": {
"description": "The url for this image.",
"type": "string"
}
},
"type": "object",
"id": "ImageConfiguration",
"description": "An image configuration resource."
},
"AchievementConfigurationDetail": {
"properties": {
"name": {
"description": "Localized strings for the achievement name.",
"$ref": "LocalizedStringBundle"
},
"sortRank": {
"type": "integer",
"description": "The sort rank of this achievement. Writes to this field are ignored.",
"format": "int32"
},
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#achievementConfigurationDetail`.",
"type": "string"
},
"iconUrl": {
"type": "string",
"description": "The icon url of this achievement. Writes to this field are ignored."
},
"pointValue": {
"format": "int32",
"type": "integer",
"description": "Point value for the achievement."
},
"description": {
"description": "Localized strings for the achievement description.",
"$ref": "LocalizedStringBundle"
}
},
"type": "object",
"description": "An achievement configuration detail.",
"id": "AchievementConfigurationDetail"
},
"GamesNumberAffixConfiguration": {
"properties": {
"two": {
"$ref": "LocalizedStringBundle",
"description": "When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian)."
},
"many": {
"description": "When the language requires special treatment of \"large\" numbers (as with numbers ending 11-99 in Maltese).",
"$ref": "LocalizedStringBundle"
},
"few": {
"$ref": "LocalizedStringBundle",
"description": "When the language requires special treatment of \"small\" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish)."
},
"zero": {
"$ref": "LocalizedStringBundle",
"description": "When the language requires special treatment of the number 0 (as in Arabic)."
},
"other": {
"$ref": "LocalizedStringBundle",
"description": "When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English)."
},
"one": {
"$ref": "LocalizedStringBundle",
"description": "When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class)."
}
},
"description": "A number affix resource.",
"id": "GamesNumberAffixConfiguration",
"type": "object"
},
"LocalizedString": {
"description": "A localized string resource.",
"properties": {
"value": {
"type": "string",
"description": "The string value."
},
"locale": {
"type": "string",
"description": "The locale string."
},
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#localizedString`.",
"type": "string"
}
},
"id": "LocalizedString",
"type": "object"
},
"LeaderboardConfigurationDetail": {
"description": "A leaderboard configuration detail.",
"properties": {
"scoreFormat": {
"$ref": "GamesNumberFormatConfiguration",
"description": "The score formatting for the leaderboard."
},
"kind": {
"description": "Uniquely identifies the type of this resource. Value is always the fixed string `gamesConfiguration#leaderboardConfigurationDetail`.",
"type": "string"
},
"name": {
"description": "Localized strings for the leaderboard name.",
"$ref": "LocalizedStringBundle"
},
"iconUrl": {
"description": "The icon url of this leaderboard. Writes to this field are ignored.",
"type": "string"
},
"sortRank": {
"format": "int32",
"type": "integer",
"description": "The sort rank of this leaderboard. Writes to this field are ignored."
}
},
"id": "LeaderboardConfigurationDetail",
"type": "object"
}
},
"servicePath": "",
"mtlsRootUrl": "https://gamesconfiguration.mtls.googleapis.com/",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"discoveryVersion": "v1",
"version": "v1configuration",
"description": "The Google Play Game Services Publishing API allows developers to configure their games in Game Services.",
"canonicalName": "Games Configuration",
"ownerName": "Google",
"batchPath": "batch",
"parameters": {
"upload_protocol": {
"type": "string",
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query",
"type": "boolean"
},
"alt": {
"location": "query",
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"description": "Data format for response."
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
}
}
}