Logo
Section 1 / 2

额外输入参数

查找有关多个端点输入参数的更多详细信息。

导入

额外输入参数

查找有关多个端点输入参数的更多详细信息。

参数类型分类描述
idstring可选如果提供,搜索结果将按事件 ID 进行过滤。
keywordstring可选用于搜索的关键字。
attractionIdstring可选如果提供,搜索结果将按景点 ID 进行过滤。
venueIdstring可选如果提供,搜索结果将按场馆 ID 进行过滤。
postalCodestring可选如果提供,搜索结果将按邮政编码或邮编进行过滤。
latlongstring可选如果提供,搜索结果将按纬度和经度进行过滤。此筛选器已弃用,未来版本中可能会被移除,建议改用 geoPoint。
radiusstring可选搜索事件的区域半径。
unit枚举['miles', 'km']可选半径的单位。默认值为 miles。
source枚举['ticketmaster', 'universe', 'frontgate', 'tmr']可选如果提供,搜索结果将按其主来源名称或发布来源名称进行过滤。
localestring可选以 ISO 代码格式表示的语言环境。可提供多个逗号分隔的值。当省略代码中的国家部分(例如仅 en 或 fr)时,使用第一个匹配的语言环境。使用 * 表示匹配所有语言环境。默认值为 en。
marketIdstring可选如果提供,搜索结果将按市场 ID 进行过滤。
startDateTimestring可选如果提供,搜索结果将过滤为开始日期在此日期之后的事件。
endDateTimestring可选如果提供,搜索结果将过滤为开始日期在此日期之前的事件。
includeTBA枚举['yes', 'no', 'only']可选如果为 yes,包含尚未公布日期(TBA)的事件。如果为 only,仅返回 TBA 日期的事件。
includeTBD枚举['yes', 'no', 'only']可选如果为 yes,包含尚未确定日期(TBD)的事件。如果为 only,仅返回 TBD 日期的事件。
includeTest枚举['yes', 'no', 'only']可选如果为 yes,包含标记为测试的事件。如果为 only,仅返回测试实体。
sizenumber可选每页返回的结果数量。默认值为 20。
pagenumber可选返回的页码。默认值为 0。
sortstring可选搜索结果的排序顺序。允许的值包括:name,asc、name,desc、date,asc、date,desc、relevance,asc、relevance,desc、distance,asc、name,date,asc、name,date,desc、date,name,asc、date,name,desc、distance,date,asc、onSaleStartDate,asc、id,asc、venueName,asc、venueName,desc、random。默认值为 relevance,desc。
onsaleStartDateTimestring可选如果提供,搜索结果将过滤为销售开始日期在此日期之后的事件。
onsaleEndDateTimestring可选如果提供,搜索结果将过滤为销售开始日期在此日期之前的事件。
citystring可选如果提供,搜索结果将按城市进行过滤。
countryCodestring可选如果提供,搜索结果将按国家进行过滤。
stateCodestring可选如果提供,搜索结果将按州代码进行过滤。
classificationNamearray[string]可选如果提供,搜索结果将按分类名称进行过滤,即任何细分、流派、子流派、类型、子类型的名称。支持负向过滤,格式为 '-'(负向过滤可能导致性能下降)。
classificationIdarray[string]可选如果提供,搜索结果将按分类 ID 进行过滤,即任何细分、流派、子流派、类型、子类型的 ID。支持负向过滤,格式为 '-'(负向过滤可能导致性能下降)。
dmaIdstring可选如果提供,搜索结果将按 DMA ID 进行过滤。
localStartDateTimearray[string]可选如果提供,搜索结果将过滤为本地开始日期在此范围内的事件。
localStartEndDateTimearray[string]可选如果提供,搜索结果将过滤为本地开始和结束日期均在此范围内的事件。
startEndDateTimearray[string]可选如果提供,搜索结果将过滤为开始和结束日期均在此范围内的事件。
publicVisibilityStartDateTimearray[string]可选如果提供,搜索结果将过滤为公开可见性从该日期开始的事件。
preSaleDateTimearray[string]可选如果提供,搜索结果将过滤为预售开始日期在此日期范围内的事件。
onsaleOnStartDatestring可选如果提供,搜索结果将过滤为销售开始日期在此日期的事件。
onsaleOnAfterStartDatestring可选如果提供,搜索结果将过滤为销售时间范围包含此日期的事件。
collectionIdarray[string]可选如果提供,搜索结果将按收藏 ID 进行过滤。
segmentIdarray[string]可选如果提供,搜索结果将按细分 ID 进行过滤。
segmentNamearray[string]可选如果提供,搜索结果将按细分名称进行过滤。
includeFamily枚举['yes', 'no', 'only']可选如果为 yes,包含适合家庭的事件。如果为 only,仅返回适合家庭的事件。
promoterIdstring可选如果提供,搜索结果将按推广者 ID 进行过滤。
genreIdarray[string]可选如果提供,搜索结果将按流派 ID 进行过滤。
subGenreIdarray[string]可选如果提供,搜索结果将按子流派 ID 进行过滤。
typeIdarray[string]可选如果提供,搜索结果将按类型 ID 进行过滤。
subTypeIdarray[string]可选如果提供,搜索结果将按子类型 ID 进行过滤。
geoPointstring可选如果提供,搜索结果将按地理哈希进行过滤。
preferredCountry枚举['us', 'ca']可选希望查找活动的首选国家。默认值为 us。
includeSpellcheck枚举['yes', 'no']可选如果为 yes,响应中包含拼写检查建议。
domainarray[string]可选如果提供,搜索结果将按其可用的域名进行过滤。

参数类型分类描述
idstring可选如果提供,搜索结果将按景点 ID 进行过滤。
keywordstring可选用于搜索的关键字。
source枚举['ticketmaster', 'universe', 'frontgate', 'tmr']可选如果提供,搜索结果将按其主来源名称或发布来源名称进行过滤。
localestring可选以 ISO 代码格式表示的语言环境。可提供多个逗号分隔的值。当省略代码中的国家部分(例如仅 en 或 fr)时,使用第一个匹配的语言环境。使用 * 表示匹配所有语言环境。默认值为 en。
includeTest枚举['yes', 'no', 'only']可选如果为 yes,包含标记为测试的景点。如果为 only,仅返回测试实体。
sizenumber可选每页返回的结果数量。默认值为 20。
pagenumber可选返回的页码。默认值为 0。
sortstring可选搜索结果的排序顺序。允许的值包括:name,asc、name,desc、date,asc、date,desc、relevance,asc、relevance,desc、distance,asc、name,date,asc、name,date,desc、date,name,asc、date,name,desc、distance,date,asc、onSaleStartDate,asc、id,asc、venueName,asc、venueName,desc、random。默认值为 relevance,desc。
classificationNamearray[string]可选如果提供,搜索结果将按分类名称进行过滤,即任何细分、流派、子流派、类型、子类型的名称。支持负向过滤,格式为 '-'(负向过滤可能导致性能下降)。
classificationIdarray[string]可选如果提供,搜索结果将按分类 ID 进行过滤,即任何细分、流派、子流派、类型、子类型的 ID。支持负向过滤,格式为 '-'(负向过滤可能导致性能下降)。
segmentIdarray[string]可选如果提供,搜索结果将按细分 ID 进行过滤。
includeFamily枚举['yes', 'no', 'only']可选如果为 yes,包含适合家庭的景点。如果为 only,仅返回适合家庭的景点。
genreIdarray[string]可选如果提供,搜索结果将按流派 ID 进行过滤。
subGenreIdarray[string]可选如果提供,搜索结果将按子流派 ID 进行过滤。
typeIdarray[string]可选如果提供,搜索结果将按类型 ID 进行过滤。
subTypeIdarray[string]可选如果提供,搜索结果将按子类型 ID 进行过滤。
preferredCountry枚举['us', 'ca']可选希望查找景点的首选国家。默认值为 us。
includeSpellcheck枚举['yes', 'no']可选如果为 yes,响应中包含拼写检查建议。
domainarray[string]可选如果提供,搜索结果将按其可用的域名进行过滤。

参数类型分类描述
idstring可选如果提供,搜索结果将按场馆 ID 进行过滤。
keywordstring可选用于搜索的关键字。
latlongstring可选如果提供,搜索结果将按纬度和经度进行过滤。此筛选器已弃用,未来版本中可能会被移除,建议改用 geoPoint。
radiusstring可选搜索场馆的区域半径。
unit枚举['miles', 'km']可选半径的单位。默认值为 miles。
source枚举['ticketmaster', 'universe', 'frontgate', 'tmr']可选如果提供,搜索结果将按其主来源名称或发布来源名称进行过滤。
localestring可选以 ISO 代码格式表示的语言环境。可提供多个逗号分隔的值。当省略代码中的国家部分(例如仅 en 或 fr)时,使用第一个匹配的语言环境。使用 * 表示匹配所有语言环境。默认值为 en。
includeTest枚举['yes', 'no', 'only']可选如果为 yes,包含标记为测试的场馆。如果为 only,仅返回测试实体。
sizenumber可选每页返回的结果数量。默认值为 20。
pagenumber可选返回的页码。默认值为 0。
sortstring可选搜索结果的排序顺序。允许的值包括:name,asc、name,desc、date,asc、date,desc、relevance,asc、relevance,desc、distance,asc、name,date,asc、name,date,desc、date,name,asc、date,name,desc、distance,date,asc、onSaleStartDate,asc、id,asc、venueName,asc、venueName,desc、random。默认值为 relevance,desc。
countryCodestring可选如果提供,搜索结果将按国家进行过滤。
stateCodestring可选如果提供,搜索结果将按州代码进行过滤。
geoPointstring可选如果提供,搜索结果将按地理哈希进行过滤。
preferredCountry枚举['us', 'ca']可选希望查找场馆的首选国家。默认值为 us。
includeSpellcheck枚举['yes', 'no']可选如果为 yes,响应中包含拼写检查建议。
domainarray[string]可选如果提供,搜索结果将按其可用的域名进行过滤。

参数类型分类描述
idstring可选如果提供,搜索结果将按分类 ID 进行过滤。
keywordstring可选用于搜索的关键字。
source枚举['ticketmaster', 'universe', 'frontgate', 'tmr']可选如果提供,搜索结果将按其主来源名称或发布来源名称进行过滤。
localestring可选以 ISO 代码格式表示的语言环境。可提供多个逗号分隔的值。当省略代码中的国家部分(例如仅 en 或 fr)时,使用第一个匹配的语言环境。使用 * 表示匹配所有语言环境。默认值为 en。
includeTest枚举['yes', 'no', 'only']可选如果为 yes,包含标记为测试的分类。如果为 only,仅返回测试实体。
sizeinteger可选每页返回的结果数量。默认值为 20。
pageinteger可选返回的页码。默认值为 0。
sortstring可选搜索结果的排序顺序。默认值为 name,asc。
preferredCountry枚举['us', 'ca']可选希望查找结果的首选国家。默认值为 us。
includeSpellcheck枚举['yes', 'no']可选如果为 yes,响应中包含拼写检查建议。
domainarray[string]可选如果提供,搜索结果将按其可用的域名进行过滤。

参数类型分类描述
keywordstring可选用于搜索的关键字。
latlongstring可选如果提供,结果将按纬度和经度进行过滤。此筛选器已弃用,未来版本中可能会被移除,建议改用 geoPoint。
radiusstring可选搜索事件的区域半径。
unit枚举['miles', 'km']可选半径的单位。默认值为 miles。
source枚举['ticketmaster', 'universe', 'frontgate', 'tmr']可选如果提供,结果将按其主来源名称或发布来源名称进行过滤。
localestring可选以 ISO 代码格式表示的语言环境。可提供多个逗号分隔的值。当省略代码中的国家部分(例如仅 en 或 fr)时,使用第一个匹配的语言环境。使用 * 表示匹配所有语言环境。默认值为 en。
startEndDateTimearray[string]可选如果提供,结果将过滤为开始和结束日期均在此范围内的事件。
localStartEndDateTimearray[string]可选如果提供,结果将过滤为本地开始和结束日期均在此范围内的事件。
includeTBA枚举['yes', 'no', 'only']可选如果为 yes,包含尚未公布日期(TBA)的事件。如果为 only,仅返回 TBA 日期的事件。默认值为:若提供了 localStartEndDateTime 或 startEndDateTime,则为 no;否则为 yes。
includeTBD枚举['yes', 'no', 'only']可选如果为 yes,包含尚未确定日期(TBD)的事件。如果为 only,仅返回 TBD 日期的事件。默认值为:若提供了 localStartEndDateTime 或 startEndDateTime,则为 no;否则为 yes。
includeTest枚举['yes', 'no', 'only']可选如果为 yes,包含标记为测试的实体。如果为 only,仅返回测试实体。
sizenumber可选每个资源返回的结果数量。默认值为 5。
countryCodestring可选如果提供,结果将按国家进行过滤。
segmentIdarray[string]可选如果提供,结果将按细分 ID 进行过滤。
geoPointstring可选如果提供,搜索结果将按地理哈希进行过滤。
resourcearray[string]可选定义响应中包含哪些资源。默认包含所有资源,即 ["attractions", "events", "venues", "products"]。
preferredCountry枚举['us', 'ca']可选希望查找活动的首选国家。默认值为 us。
includeSpellcheck枚举['yes', 'no']可选如果为 yes,响应中包含拼写检查建议。
domainarray[string]可选如果提供,搜索结果将按其可用的域名进行过滤。

结论

额外输出详情