- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- FreeBookingLinksResult
DEPRECATED: Use PropertyPerformanceReportService.QueryPropertyPerformanceReport
, which also has impression reporting, instead. Provides the ability to query (get, filter, and segment) a free booking links report for a specific account.
HTTP request
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews:query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The resource name of the account being queried. Format: accounts/{account_id} |
Query parameters
Parameters | |
---|---|
filter |
The conditions (fields and expressions) used to filter the free booking link metrics for the account being queried. The syntax requires spaces surrounding the The The Values for Examples of valid conditions are as follows:
|
aggregateBy |
Specifies how to segment the metrics returned by the query. For example, if The string value is a comma-separated list of fields. Valid fields are: |
pageSize |
The maximum number of participation results to return. The service may return fewer than this value. If unspecified, at most 10,000 results will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. |
pageToken |
A page token, received from a previous participationReportViews.query request. Provide this to receive the subsequent page. When paginating, all other parameters provided to participationReportViews.query must match the call that provided the page token. |
Request body
The request body must be empty.
Response body
DEPRECATED: Use QueryPropertyPerformanceReportResponse
with PropertyPerformanceReportService
instead. Response message for FreeBookingLinksReportService.QueryFreeBookingLinksReport
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"results": [
{
object ( |
Fields | |
---|---|
results[] |
The list of results that match the query. |
nextPageToken |
Pagination token used to retrieve the next page of results. If this field is omitted, there are no subsequent pages. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/travelpartner
For more information, see the OAuth 2.0 Overview.
FreeBookingLinksResult
DEPRECATED: Use PropertyPerformanceResult
with PropertyPerformanceReportService
instead. Represents a result from querying for free booking link stats for an account.
JSON representation |
---|
{ "date": { object ( |
Fields | |
---|---|
date |
A date within the requested date range. Only present if |
userRegionCode |
ISO 3116 region code of the country/region of the user. Only present if |
deviceType |
The user’s device type. Only present if |
partnerHotelId |
Partner's hotel ID. Only present if |
partnerHotelDisplayName |
Partner's hotel name. Only present if |
clickCount |
The total number of clicks that were recorded for this result. |