Method: accounts.query_participation_report

Searches for feed opportunity that matches given search criteria.

HTTP request

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}:query_participation_report

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The resource name of the account being queried. The format is accounts/{account_id}.

Query parameters

Parameters
filter

string

Search filter.

aggregateBy

string

Specifies how to segment the metrics returned by the query. For example, if userRegionCode is specified as the aggregateBy value, the participationResult will provide metrics aggregated by user region.

The string value is a comma-separated list of fields. Valid fields are: date, userRegionCode, deviceType, partnerHotelId, and hotelRegionCode. Fields that are not specified are not included in the participationResult.

pageSize

integer

The maximum number of participation results to return. The service may return fewer than this value. If unspecified, at most 100,000 results will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000.

pageToken

string

A page token, received from a previous accounts.query_participation_report request. Provide this to receive the subsequent page.

When paginating, all other parameters provided to accounts.query_participation_report must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for ParticipationReportService.QueryParticipationReport.

JSON representation
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
Fields
results[]

object (ParticipationResult)

The list of results that matches the query.

nextPageToken

string

Pagination token used to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/travelpartner

For more information, see the OAuth 2.0 Overview.

ParticipationResult

Represents a result from querying for participation stats for an account.

JSON representation
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "noAvailabilityMissedParticipationCount": string,
  "suspendedHotelMissedParticipationCount": string,
  "noTaxesBreakdownMissedParticipationCount": string,
  "noPriceMissedParticipationCount": string,
  "livePricingTechnicalIssueMissedParticipationCount": string,
  "livePricingNotTriggeredMissedParticipationCount": string,
  "livePricingConfigurationIssueMissedParticipationCount": string,
  "livePricingUnavailableMissedParticipationCount": string,
  "noLandingPageMissedParticipationCount": string,
  "otherMissedParticipationReasonCount": string,
  "partnerHotelDisplayName": string
}
Fields
key

object (Key)

Key of the result.

opportunityCount

string (int64 format)

The number of opportunities that were available.

participationCount

string (int64 format)

The number participations.

participationPercent

number

The ratio between the number of successfully participated opportunities and the total number of opportunities. This value will be between 0 and 100 inclusively.

missedParticipationCount

string (int64 format)

The number of missed participations.

noAvailabilityMissedParticipationCount

string (int64 format)

The number of missed participations because the hotel/itinerary combination was not available, or the traveler was ineligible for the rates.

suspendedHotelMissedParticipationCount

string (int64 format)

The number of missed participations because one or more of your hotels were suspended due to price accuracy violations.

noTaxesBreakdownMissedParticipationCount

string (int64 format)

The number of missed participations because one or more of your hotels did not specify taxes and fees separately.

noPriceMissedParticipationCount

string (int64 format)

The number of missed participations due to no price.

livePricingTechnicalIssueMissedParticipationCount

string (int64 format)

The number of missed participations because of technical issues with live pricing.

livePricingNotTriggeredMissedParticipationCount

string (int64 format)

The number of missed participations because live pricing was not triggered for any of the following reasons:

  • You did not set a bid.
  • You did not have a valid landing page.
  • There were enough prices in the cache.

  • livePricingConfigurationIssueMissedParticipationCount

    string (int64 format)

    The number of missed participations because live pricing was not triggered for any of the following reasons:

  • You did not have live pricing configured for these searches.
  • You restricted Google from accessing the hotel itinerary in question.
  • Your configured bandwidth had been exceeded.

  • livePricingUnavailableMissedParticipationCount

    string (int64 format)

    The number of missed participations because live pricing was unavailable.

    noLandingPageMissedParticipationCount

    string (int64 format)

    The number of missed participations because you did not have a landing page that matched the end-user.

    otherMissedParticipationReasonCount

    string (int64 format)

    The number of missed participation due to other reasons.

    partnerHotelDisplayName

    string

    Partner's hotel display name. This field is only populated when the result is aggregated with partnerHotelId.

    Key

    Key of a result.

    JSON representation
    {
      "date": {
        object (Date)
      },
      "userRegionCode": string,
      "deviceType": enum (Device),
      "partnerHotelId": string,
      "hotelRegionCode": string
    }
    Fields
    date

    object (Date)

    The date for which you are requesting metrics.

    If date is not a value of the aggregateBy parameter in the request call, then the date field is not returned in the participationResult.

    userRegionCode

    string

    ISO 3116 region code of the country/region of the user.

    deviceType

    enum (Device)

    The user’s device type.

    If deviceType is not a value of the aggregateBy parameter in the request call, then the deviceType field is not returned in the participationResult.

    partnerHotelId

    string

    Partner's hotel ID.

    If partnerHotelId is not a value of the aggregateBy parameter in the request call, then the partnerHotelId field is not returned in the participationResult.

    hotelRegionCode

    string

    CLDR region code of the country/region of the hotel.

    If hotelRegionCode is not a value of the aggregateBy parameter in the request call, then the hotelRegionCode field is not returned in the participationResult.

    Device

    Enumerates supported devices.

    Enums
    DEVICE_UNSPECIFIED Not specified.
    DEVICE_UNKNOWN The value is unknown in this version.
    DESKTOP Computers.
    MOBILE Mobile devices with full browsers.
    TABLET Tablets with full browsers.