Google Business Performance
API has a NEW
API method that allows fetching multiple `DailyMetrics` in a single API request. Review the deprecation schedule
and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: locations.getLodging
Stay organized with collections
Save and categorize content based on your preferences.
Returns the Lodging of a specific location.
HTTP request
GET https://mybusinesslodging.googleapis.com/v1/{name=locations/*/lodging}
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
name
|
string
Required. Google identifier for this location in the form: locations/{locationId}/lodging
|
Query parameters
| Parameters |
readMask
|
string ( FieldMask
format)
Required. The specific fields to return. Use "*" to include all fields. Repeated field items cannot be individually specified.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Lodging
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThis endpoint retrieves lodging information for a specific location using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ename\u003c/code\u003e path parameter to identify the location and an optional \u003ccode\u003ereadMask\u003c/code\u003e query parameter to specify the fields to return.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eA successful response provides a \u003ccode\u003eLodging\u003c/code\u003e object containing details about the lodging.\u003c/p\u003e\n"]]],["This documentation outlines how to retrieve lodging information for a specific location. A `GET` request is sent to the provided URL, including the location's identifier in the `name` path parameter (e.g., `locations/{locationId}/lodging`). The `readMask` query parameter is required to specify which fields to return, or \"*\" for all fields. The request body must be empty. A successful response returns a `Lodging` instance, and `https://www.googleapis.com/auth/business.manage` OAuth scope is required.\n"],null,["# Method: locations.getLodging\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nReturns the Lodging of a specific location.\n\n### HTTP request\n\n`GET https://mybusinesslodging.googleapis.com/v1/{name=locations/*/lodging}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Google identifier for this location in the form: `locations/{locationId}/lodging` |\n\n### Query parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `readMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. The specific fields to return. Use \"\\*\" to include all fields. Repeated field items cannot be individually specified. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Lodging](/my-business/reference/lodging/rest/v1/Lodging).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
