docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/playablelocations_v3.v3.html b/docs/dyn/playablelocations_v3.v3.html
index a3c7be6..e63933d 100644
--- a/docs/dyn/playablelocations_v3.v3.html
+++ b/docs/dyn/playablelocations_v3.v3.html
@@ -101,24 +101,24 @@
The object takes the form of:
{ # A request for logging impressions.
+ "impressions": [ # Required. Impression event details. The maximum number of impression reports that you can log at once is 50.
+ { # Encapsulates impression event details.
+ "locationName": "A String", # Required. The name of the playable location.
+ "gameObjectType": 42, # An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location.
+ "impressionType": "A String", # Required. The type of impression event.
+ },
+ ],
"clientInfo": { # Client information. # Required. Information about the client device. For example, device model and operating system.
- "applicationId": "A String", # Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
"operatingSystem": "A String", # Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.
+ "applicationId": "A String", # Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
"languageCode": "A String", # Language code (in BCP-47 format) indicating the UI language of the client. Examples are "en", "en-US" or "ja-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "apiClient": "A String", # API client name and version. For example, the SDK calling the API. The exact format is up to the client.
"applicationVersion": "A String", # Application version number, such as "1.2.3". The exact format is application-dependent.
"deviceModel": "A String", # Device model as reported by the device. The exact format is platform-dependent.
"platform": "A String", # Platform where the application is running.
"operatingSystemBuild": "A String", # Build number/version of the operating system. e.g., the contents of android.os.Build.ID in Android, or the contents of sysctl "kern.osversion" in iOS.
- "apiClient": "A String", # API client name and version. For example, the SDK calling the API. The exact format is up to the client.
},
"requestId": "A String", # Required. A string that uniquely identifies the log impressions request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in case of failure. In this case, the request must be identical to the one that failed.
- "impressions": [ # Required. Impression event details. The maximum number of impression reports that you can log at once is 50.
- { # Encapsulates impression event details.
- "impressionType": "A String", # Required. The type of impression event.
- "gameObjectType": 42, # An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location.
- "locationName": "A String", # Required. The name of the playable location.
- },
- ],
}
x__xgafv: string, V1 error format.
@@ -142,27 +142,27 @@
The object takes the form of:
{ # A request for logging your player's bad location reports.
- "playerReports": [ # Required. Player reports. The maximum number of player reports that you can log at once is 50.
- { # A report submitted by a player about a playable location that is considered inappropriate for use in the game.
- "locationName": "A String", # Required. The name of the playable location.
- "languageCode": "A String", # Language code (in BCP-47 format) indicating the language of the freeform description provided in `reason_details`. Examples are "en", "en-US" or "ja-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "reasonDetails": "A String", # Required. A free-form description detailing why the playable location is considered bad.
- "reasons": [ # Required. One or more reasons why this playable location is considered bad.
- "A String",
- ],
- },
- ],
"clientInfo": { # Client information. # Required. Information about the client device (for example, device model and operating system).
- "applicationId": "A String", # Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
"operatingSystem": "A String", # Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.
+ "applicationId": "A String", # Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
"languageCode": "A String", # Language code (in BCP-47 format) indicating the UI language of the client. Examples are "en", "en-US" or "ja-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "apiClient": "A String", # API client name and version. For example, the SDK calling the API. The exact format is up to the client.
"applicationVersion": "A String", # Application version number, such as "1.2.3". The exact format is application-dependent.
"deviceModel": "A String", # Device model as reported by the device. The exact format is platform-dependent.
"platform": "A String", # Platform where the application is running.
"operatingSystemBuild": "A String", # Build number/version of the operating system. e.g., the contents of android.os.Build.ID in Android, or the contents of sysctl "kern.osversion" in iOS.
- "apiClient": "A String", # API client name and version. For example, the SDK calling the API. The exact format is up to the client.
},
"requestId": "A String", # Required. A string that uniquely identifies the log player reports request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in the case of a failure. In that case, the request must be identical to the one that failed.
+ "playerReports": [ # Required. Player reports. The maximum number of player reports that you can log at once is 50.
+ { # A report submitted by a player about a playable location that is considered inappropriate for use in the game.
+ "reasons": [ # Required. One or more reasons why this playable location is considered bad.
+ "A String",
+ ],
+ "reasonDetails": "A String", # Required. A free-form description detailing why the playable location is considered bad.
+ "locationName": "A String", # Required. The name of the playable location.
+ "languageCode": "A String", # Language code (in BCP-47 format) indicating the language of the freeform description provided in `reason_details`. Examples are "en", "en-US" or "ja-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ },
+ ],
}
x__xgafv: string, V1 error format.
@@ -186,25 +186,25 @@
The object takes the form of:
{ # Life of a query: - When a game starts in a new location, your game server issues a SamplePlayableLocations request. The request specifies the S2 cell, and contains one or more "criteria" for filtering: - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for random objects. - etc (up to 5 criterion may be specified). `PlayableLocationList` will then contain mutually exclusive lists of `PlayableLocation` objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state. Note: These points are impermanent in nature. E.g, parks can close, and places can be removed. The response specifies how long you can expect the playable locations to last. Once they expire, you should query the `samplePlayableLocations` API again to get a fresh view of the real world.
- "areaFilter": { # Specifies the area to search for playable locations. # Required. Specifies the area to search within for playable locations.
- "s2CellId": "A String", # Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python)
- },
"criteria": [ # Required. Specifies one or more (up to 5) criteria for filtering the returned playable locations.
{ # Encapsulates a filter criterion for searching for a set of playable locations.
+ "fieldsToReturn": "A String", # Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be.
"gameObjectType": 42, # Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique `game_object_type` ID across all `request_criteria` to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map.
"filter": { # Specifies the filters to use when searching for playable locations. # Specifies filtering options, and specifies what will be included in the result set.
+ "maxLocationCount": 42, # Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned.
+ "spacing": { # A set of options that specifies the separation between playable locations. # A set of options that control the spacing between playable locations. By default the minimum distance between locations is 200m.
+ "minSpacingMeters": 3.14, # Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m.
+ "pointType": "A String", # Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game.
+ },
"includedTypes": [ # Restricts the set of playable locations to just the [types](/maps/documentation/gaming/tt/types) that you want.
"A String",
],
- "spacing": { # A set of options that specifies the separation between playable locations. # A set of options that control the spacing between playable locations. By default the minimum distance between locations is 200m.
- "pointType": "A String", # Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game.
- "minSpacingMeters": 3.14, # Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m.
- },
- "maxLocationCount": 42, # Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned.
},
- "fieldsToReturn": "A String", # Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be.
},
],
+ "areaFilter": { # Specifies the area to search for playable locations. # Required. Specifies the area to search within for playable locations.
+ "s2CellId": "A String", # Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python)
+ },
}
x__xgafv: string, V1 error format.
@@ -222,6 +222,7 @@
"locations": [ # A list of playable locations for this game object type.
{ # A geographical point suitable for placing game objects in location-based games.
"placeId": "A String", # A [place ID] (https://developers.google.com/places/place-id)
+ "plusCode": "A String", # A [plus code] (http://openlocationcode.com)
"centerPoint": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
@@ -229,12 +230,11 @@
"types": [ # A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) for this playable location. The first type in the collection is the primary type. Type information might not be available for all playable locations.
"A String",
],
- "name": "A String", # Required. The name of this playable location.
"snappedPoint": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # The playable location's coordinates, snapped to the sidewalk of the nearest road, if a nearby road exists.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
- "plusCode": "A String", # A [plus code] (http://openlocationcode.com)
+ "name": "A String", # Required. The name of this playable location.
},
],
},