@maxim_mazurok/gapi.client.cloudsearch-v1 0.0.20240626 → 0.0.20240722

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +1 -1057
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://cloudsearch.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20240626
12
+ // Revision: 20240722
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -46,11 +46,6 @@ declare namespace gapi.client {
46
46
  /** [Required] The text to display. */
47
47
  text?: string;
48
48
  }
49
- interface BandWidthRangeKbps {
50
- percentile10?: number;
51
- percentile50?: number;
52
- percentile90?: number;
53
- }
54
49
  interface BooleanOperatorOptions {
55
50
  /** Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:<value>* show results only where the value of the property named *isClosed* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator returns all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */
56
51
  operatorName?: string;
@@ -63,276 +58,6 @@ declare namespace gapi.client {
63
58
  /** Returns true if principal has access. Returns false otherwise. */
64
59
  hasAccess?: boolean;
65
60
  }
66
- interface ClientOptInContext {
67
- /** Enrollment status for Ambient Mode feature go/assistant-ambient-mode */
68
- ambientEnrollmentStatus?: string;
69
- /** Enrollment status for PhotoFrame feature in Ambient Mode. This is different from PhotoFrame enrollment in other features such as Dreamliner. go/assistant-ambient-mode */
70
- ambientPhotoEnrollmentStatus?: string;
71
- /** Whether the user has opted into enabling Assistant on Lockscreen. go/iris-newperm-prd */
72
- assistantOnLockscreenStatus?: string;
73
- /** Audio History. Used to improve speech recognition and hotword triggering. https://sites.google.com/a/google.com/android-speech/projects/audio-history */
74
- audioHistoryStatus?: OptInStatus;
75
- /** Whether the user has opted into bluetooth audio recording setting. */
76
- bluetoothAudioRecordingStatus?: string;
77
- /** Set to true iff the user is signed into Chrome with the same account as GSA and has Chrome sync enabled (as reported by Chrome to GSA). This can be used to serve personalized suggestions based on the user's browsing history. */
78
- chromeSyncStatus?: OptInStatus;
79
- /** Allows Google to upload device app information. */
80
- deviceAppsStatus?: OptInStatus;
81
- /** Allows Google to upload contact information from device. */
82
- deviceContactsStatus?: OptInStatus;
83
- /** User allows Google to upload state (aka settings) and content (documents and media) from their device. See https://goto.google.com/device-consents */
84
- deviceStateAndContentStatus?: OptInStatus;
85
- /** List of Android package names the user disabled from appearing in the autocomplete suggestions on their device. */
86
- disabledIcingSourceApps?: string[];
87
- /** List of Android packages and corpora that the user disabled. This replaces disabled_icing_source_apps and allows disabling a single corpus for a particular package. */
88
- disabledIcingSources?: DisabledIcingPackageCorpus[];
89
- /** Whether the user has opted into headphone personal results setting. go/enable-pr-with-headset */
90
- headphonePersonalResultsStatus?: string;
91
- /** Enrollment status for Hotword any-screen/always-on. This information is sent to the server-side to know that the user can run Hotword. For example, in go/gsa-voice-feature-tips using this information, the user will be shown Voice Tips that will take the user directly to the enrollment and guide them to move to the next level of Voice Features experience. */
92
- hotwordEnrollmentStatus?: OptInStatus;
93
- /** User allows Google to upload location history from their device. See https://goto.google.com/gcore-ulr */
94
- locationHistoryStatus?: OptInStatus;
95
- /** Whether the user has opted into showing personal response on Lockscreen. */
96
- lockscreenPersonalResponseStatus?: string;
97
- /** Whether the user has opted into lockscreen queries via bluetooth headsets setting. */
98
- lockscreenSearchBluetoothStatus?: string;
99
- /** Whether the user has opted into lockscreen queries via wired headsets setting. */
100
- lockscreenSearchWiredHeadsetStatus?: string;
101
- /** Google Now push notifications. */
102
- nowNotificationStatus?: OptInStatus;
103
- /** Google Now activation. */
104
- nowStatus?: OptInStatus;
105
- /** Google Now marks each release with a TOS version, so it can ask users to opt in again if the terms change from release to release. */
106
- nowTosVersion?: number;
107
- /** User's eligibility to use the Assistant. */
108
- opaEligibility?: string;
109
- /** Has the user opted-in to receiving emails for OPA? This is set when the user opts-in during the OPA upgrade flow. It has an UNKNOWN value otherwise. Note that this bit isn't updated if the user changes their email opt-in status through settings or unsubscribing in the email. */
110
- opaEmailOptInStatus?: string;
111
- /** The Opa experience type. As of Feb 2019, it is only used to check whether the user is in the Try Before You Buy experience. */
112
- opaExperienceType?: string;
113
- /** The reason why user enters the OPA "signed-out mode" partial experience (go/opa-signed-out-everywhere). Note that the value only means how the user entered the partial experience. For example, if a user enters TBYB and becomes a full-experience user, this value will remain as TBYB. To check the current experience type, you should read opa_experience_type instead. */
114
- opaPartialExperienceReason?: string;
115
- /** Has the user opted in to OPA's UDC requirements? "OPA UDC consent" is a one-time opt-in to the set of required UDC opt-in bits. If the user has already granted all required UDC opt-ins, then we automatically mark them as consented. We require that users grant OPA UDC consent before using OPA for the first time. Note: The user does not revoke OPA UDC consent if they turn off one of the UDC opt-in bits from Settings; for such users, the server either offers a degraded experience, or prompts the user to re-grant missing opt-ins.) */
116
- opaUdcConsentStatus?: string;
117
- /** A user-configurable global on/off switch for the Assistant; the user can completely disable the assistant (go/opa-enabled-ss). Defaults to enabled. This setting is completely independent from the user's opa_eligibility; they can be eligible, but OPA disabled. There users are by definition not making Assistant queries, so this value is a signal of the population size. */
118
- opaUserEnabledStatus?: string;
119
- /** Whether the user has opted into showing proactive personal suggestions on lock screen before asking. This is the proactive sub-bit for lockscreen_personal_response_status. */
120
- proactivePersonalResponseStatus?: string;
121
- /** Has the user granted permission for Google to read the contents of their screen. Note that in OPA, training hotword automatically opts the user into screen context. */
122
- screenContextOptInStatus?: string;
123
- /** Whether the user has opted into skipping voice recognition. go/iris-newperm-prd */
124
- skipVoiceRecognitionStatus?: string;
125
- /** Whether the user has enrolled the Speaker ID model. */
126
- speakerModelStatus?: string;
127
- /** Whether the user has acknowledged the third party disclosure. */
128
- thirdPartyDisclosureStatus?: string;
129
- /** Whether the user has opted into alarms/timers context for Quick phrases. */
130
- warmActionsAlarmsTimersEnrollmentStatus?: string;
131
- /** Whether the user has opted into calls context for Quick phrases. */
132
- warmActionsCallsEnrollmentStatus?: string;
133
- /** Whether the user has opted into at least one Mobile Warm Words/Quick Phrases context. go/mww-prd */
134
- warmActionsEnrollmentStatus?: string;
135
- /** User allows Google to upload usage history from their device. This field can be set to true iff web_history_status is set to true. Historically, this used to be called "Supplemental Search History". See https://goto.google.com/device-consents */
136
- webAndAppHistoryStatus?: OptInStatus;
137
- /** User allows Google to log interactions with Search from their device. Historically, this used to be called "Search History". See https://goto.google.com/device-consents */
138
- webHistoryStatus?: OptInStatus;
139
- }
140
- interface CloudsearchEmailAddress {
141
- /** The email address. */
142
- emailAddress?: string;
143
- /** Indicates if this is the user's primary email. Only one entry can be marked as primary. */
144
- primary?: boolean;
145
- }
146
- interface CloudsearchFilter {
147
- /** Sub filters. If present, the operator must be set. */
148
- filters?: CloudsearchFilter[];
149
- /** The operator_name that we apply to the query, e.g. price_greater_than. It can be either case, 1. operator_name in schema. We will filter the results with the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in schema. We will filter the results that property is greater than or less than the given value. */
150
- name?: string;
151
- /** The operator of the filter. */
152
- operator?: string;
153
- /** The value to check. If present, the name must be set. */
154
- value?: CloudsearchValue;
155
- }
156
- interface CloudsearchFilterSuggestion {
157
- /** The filter suggestion. It can be 1. A value filter, e.g. type:documents 2. A composite filter before:today and after:yesterday */
158
- filter?: CloudsearchFilter;
159
- /** This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: "google search", and the keyword "goog" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]. */
160
- suggestionMatchInfo?: CloudsearchSnippet;
161
- type?: string;
162
- }
163
- interface CloudsearchGroup {
164
- /** The group's email addresses */
165
- emailAddresses?: CloudsearchEmailAddress[];
166
- /** Group's names */
167
- groupNames?: CloudsearchName[];
168
- /** The resource name of the group to provide information about. See People.get from Google People API. */
169
- name?: string;
170
- /** Obfuscated GAIA ID of a google group. Used by first party Cloud Search clients. */
171
- obfuscatedId?: string;
172
- }
173
- interface CloudsearchImage {
174
- /** Specifies the source from where the photo is fetched. */
175
- source?: string;
176
- /** The URL of the photo. */
177
- url?: string;
178
- }
179
- interface CloudsearchMatchRange {
180
- /** 1 + index of the ending position of the match in the snippet. */
181
- end?: number;
182
- /** Index of the starting position of the match in the snippet. */
183
- start?: number;
184
- }
185
- interface CloudsearchName {
186
- /** The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header. */
187
- displayName?: string;
188
- /** Specifies the source from where the name is fetched. */
189
- source?: string;
190
- }
191
- interface CloudsearchPeopleSuggestion {
192
- /** This field contains the suggestion information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside email_name_match_info is: "John Doe - johndoe@google.com", and the keyword "doe" should be matched, the match_ranges is: [[5, 8), [15, 18)]. */
193
- emailNameMatchInfo?: CloudsearchSnippet;
194
- googleGroup?: CloudsearchGroup;
195
- person?: CloudsearchPerson;
196
- }
197
- interface CloudsearchPerson {
198
- /** The person's email addresses */
199
- emailAddresses?: CloudsearchEmailAddress[];
200
- /** The resource name of the person to provide information about. See People.get from Google People API. */
201
- name?: string;
202
- /** Obfuscated GAIA ID of a person. Used by first party Cloud Search client, to build a hangout link. */
203
- obfuscatedId?: string;
204
- /** The person's names */
205
- personNames?: CloudsearchName[];
206
- /** A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results. */
207
- photos?: CloudsearchImage[];
208
- }
209
- interface CloudsearchQuerySuggestion {
210
- /** This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: "google search", and the keyword "goog" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]. */
211
- suggestionMatchInfo?: CloudsearchSnippet;
212
- }
213
- interface CloudsearchSnippet {
214
- /** The matched ranges in the snippet. */
215
- matchRanges?: CloudsearchMatchRange[];
216
- /** The snippet of the document. */
217
- snippet?: string;
218
- }
219
- interface CloudsearchSource {
220
- /** If set to true, all 3p sources will be considered */
221
- anyThirdPartySource?: boolean;
222
- /** Source name of contents that indexed by Index API */
223
- name?: string;
224
- /** Predefined source for Google Apps. */
225
- predefinedSource?: string;
226
- }
227
- interface CloudsearchSuggestionScores {
228
- completeserverInternalScores?: CloudsearchSuggestionScoresInternalScores;
229
- completeServerInternalScores?: CloudsearchSuggestionScoresCompleteServerInternalScores;
230
- /** How frequent is the suggestion within this user. */
231
- personalizedBoost?: number;
232
- /** How popular is the suggestion among all users. */
233
- popularity?: number;
234
- /** Amount by which a section is boosted based on heuristics. */
235
- sectionBoost?: number;
236
- /** Scale factor of the datasource its coming from. */
237
- sourceScaleFactor?: number;
238
- starlightInternalScores?: CloudsearchSuggestionScoresInternalScores;
239
- }
240
- interface CloudsearchSuggestionScoresCompleteServerInternalScores {
241
- /** Contacts group score (i.e. if the string is a name of a group). */
242
- contactsGroup?: number;
243
- /** Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE. */
244
- emailAutocompleteScore?: number;
245
- /** Outbound email count as read from FBS. */
246
- focusOutboundEmailCount?: number;
247
- /** Frequency based score of a query from the user's gmail search history */
248
- gmailHistory?: number;
249
- gmailHistoryMediumTermQueryTime?: number;
250
- /** Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term. */
251
- gmailHistoryShortTermQueryTime?: number;
252
- /** Gmail label score, as received from Gmail through PbUI. */
253
- gmailLabel?: number;
254
- /** Score for gmail operators. */
255
- gmailOperator?: number;
256
- /** Score for text entities extracted from gmail subjects. */
257
- gmailText?: number;
258
- /** The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score. */
259
- matchScore?: number;
260
- /** Final score from CompleteServer. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent. */
261
- score?: number;
262
- }
263
- interface CloudsearchSuggestionScoresInternalScores {
264
- /** Contacts group score (i.e. if the string is a name of a group). */
265
- contactsGroup?: number;
266
- /** Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE. */
267
- emailAutocompleteScore?: number;
268
- /** Outbound email count as read from FBS. */
269
- focusOutboundEmailCount?: number;
270
- /** Frequency based score of a query from the user's gmail search history */
271
- gmailHistory?: number;
272
- gmailHistoryMediumTermQueryTime?: number;
273
- /** Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term. */
274
- gmailHistoryShortTermQueryTime?: number;
275
- /** Gmail label score, as received from Gmail through PbUI. */
276
- gmailLabel?: number;
277
- /** Score for gmail operators. */
278
- gmailOperator?: number;
279
- /** Score for text entities extracted from gmail subjects. */
280
- gmailText?: number;
281
- /** The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score. */
282
- matchScore?: number;
283
- /** Final score from CompleteServe / Starlight. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent. */
284
- score?: number;
285
- }
286
- interface CloudsearchSuggestResponseDebugInfo {
287
- completeServerInfo?: CloudsearchSuggestResponseDebugInfoCompleteServerInfo;
288
- starlightInfo?: CloudsearchSuggestResponseDebugInfoStarlightInfo;
289
- }
290
- interface CloudsearchSuggestResponseDebugInfoCompleteServerInfo {
291
- completeserverHostname?: string;
292
- psuggestDoNotCache?: boolean;
293
- request?: SuggestSuggestRequest;
294
- results?: CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult[];
295
- starlightHostname?: string;
296
- }
297
- interface CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult {
298
- suggestedQuery?: string;
299
- suggestionType?: string;
300
- }
301
- interface CloudsearchSuggestResponseDebugInfoStarlightInfo {
302
- /** Position-weighted measurement of the difference between the two result sets. See go/search-experiments-glossary - CR Score. */
303
- compareRankingsScore?: number;
304
- starlightHostname?: string;
305
- /** List of suggestion results returned from Starlight for dark launch. */
306
- suggestResults?: CloudsearchSuggestResult[];
307
- }
308
- interface CloudsearchSuggestResult {
309
- encryptedResultDebugId?: string;
310
- extension?: any;
311
- filterSuggestion?: CloudsearchFilterSuggestion;
312
- /** Indicates the matches between the suggestion and the user's query. For example, if the user types "isac xx" and the returned suggestion is "Isaac Elias" then the match is on the token "isaac" after spell correction. Note that "isac" in user's query matched with "isaac" in the suggestion because of spell correction. Also note that spell correction may or may not happen. In this example, matched_text_in_query_info.size() is 1, matched_text_in_query_info(0).snippet() is "isaac", matched_text_in_query_info(0).match_ranges().start() is 0 and matched_text_in_query_info(0).match_ranges().end() is 5. */
313
- matchedTextInQueryInfo?: CloudsearchSnippet[];
314
- /** The name of the suggestion. This is unique identifier of the suggestion. */
315
- name?: string;
316
- peopleSuggestion?: CloudsearchPeopleSuggestion;
317
- querySuggestion?: CloudsearchQuerySuggestion;
318
- /** Final score returned by superroot for this suggestion. */
319
- score?: number;
320
- source?: CloudsearchSource;
321
- subScores?: CloudsearchSuggestionScores;
322
- subType?: string;
323
- /** The suggested query that will be used for search, when the user clicks on the suggestion */
324
- suggestedQuery?: string;
325
- suggestionOrigin?: string;
326
- type?: string;
327
- }
328
- interface CloudsearchValue {
329
- booleanValue?: boolean;
330
- dateValue?: Date;
331
- doubleValue?: number;
332
- integerValue?: string;
333
- stringValue?: string;
334
- timestampValue?: string;
335
- }
336
61
  interface CompositeFilter {
337
62
  /** The logic operator of the sub filter. */
338
63
  logicOperator?: string;
@@ -485,11 +210,6 @@ declare namespace gapi.client {
485
210
  /** Search response. */
486
211
  searchResponse?: SearchResponse;
487
212
  }
488
- interface DefaultBlockingDataProto {
489
- types?: string[];
490
- /** Version ID of the current list of blocked countries and sanctions areas, based on which the types field was computed. */
491
- version?: number;
492
- }
493
213
  interface DeleteQueueItemsRequest {
494
214
  /** The name of connector making this call. Format: datasources/{source_id}/connectors/{ID} */
495
215
  connectorName?: string;
@@ -498,12 +218,6 @@ declare namespace gapi.client {
498
218
  /** The name of a queue to delete items from. */
499
219
  queue?: string;
500
220
  }
501
- interface DisabledIcingPackageCorpus {
502
- /** The name of an individual corpus within the given app. When unset, this means that all corpora for the given package are disabled. */
503
- corpusName?: string;
504
- /** The package name of an app that the user disabled. This is required. */
505
- packageName?: string;
506
- }
507
221
  interface DisplayedProperty {
508
222
  /** The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema. */
509
223
  propertyName?: string;
@@ -1128,61 +842,6 @@ declare namespace gapi.client {
1128
842
  /** This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time. */
1129
843
  freshnessProperty?: string;
1130
844
  }
1131
- interface GeostoreFeatureIdProto {
1132
- /** The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way. */
1133
- cellId?: string;
1134
- /** A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient. */
1135
- fprint?: string;
1136
- /** A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts. */
1137
- temporaryData?: any;
1138
- }
1139
- interface GeostoreFieldMetadataProto {
1140
- internal?: GeostoreInternalFieldMetadataProto;
1141
- }
1142
- interface GeostoreInternalFieldMetadataProto {
1143
- /** Whether or not the piece of data has been generated automatically (i.e., by a bot/automated process based on heuristics/algorithms rather than coming as a fact set by some human user or data provider based on their knowledge). Note that this does NOT imply that the value was set as a result of a bot operation on the repository, since it is conceivable to use a bot/automated process simply as a way of convenience to ingest large amount of canonical/ground truth data. */
1144
- isAuto?: boolean;
1145
- /** Information about the source providing the piece of data this metadata is attached to. */
1146
- sourceSummary?: GeostoreInternalSourceSummaryProto;
1147
- }
1148
- interface GeostoreInternalSourceSummaryProto {
1149
- /** Within the above provider, the dataset from which this piece of data was generated. For fields that are auto-generated the "dataset" is likely to be some algorithm's or program's name. Similar to SourceInfoProto.dataset but with the difference that it is required to always be set. Providers that don't have a concept of dataset may use "default". */
1150
- dataset?: string;
1151
- /** The data provider from which this piece of data was generated. Equivalent to SourceInfoProto.provider in the public schema. */
1152
- provider?: string;
1153
- }
1154
- interface GeostoreKnowledgeGraphReferenceProto {
1155
- /** KG Identifier (MID). For details, see http://go/ke-bg-knowledge-graph#mids. */
1156
- id?: string;
1157
- }
1158
- interface GeostoreNameProto {
1159
- /** clang-format on The set of flags that apply to this name. */
1160
- flag?: string[];
1161
- /** The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. This field may be missing if the name does not have a concept of language but should be set if the language is unknown. */
1162
- language?: string;
1163
- /** Field-level metadata for this name. NOTE: there are multiple NameProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.name[]. */
1164
- metadata?: GeostoreFieldMetadataProto;
1165
- /** ** DEPRECATED ** The name text provided in the original source data (UTF-8 encoding). This is the text provided in the source data unmodified with the exception of being converted to UTF-8 and stripping extra leading, trailing and duplicate whitespaces (if necessary). */
1166
- rawText?: string;
1167
- /** The short name text (UTF-8 encoding). Acronyms/abbreviations should be consistently used, for example "NE 57th St" rather than "Northeast 57th Street", "N.E 57th St." or some other variant. This field should be populated with the chosen canonical version of the shortened name, based on per-term transformations. For feature specific abbreviations (such as 'CA' for 'California'), one should define a separate name with FLAG_ABBREVIATED set. For other variants of the shortened name that are not the canonical one, devise client based logic (ex: query rewriting rules). */
1168
- shortText?: string;
1169
- /** A place for clients to attach arbitrary data to a name. Never set in MapFacts. */
1170
- temporaryData?: any;
1171
- /** The name text (UTF-8 encoding). Acronyms/abbreviations should be fully expanded, for example "Northeast 57th Street" rather than "NE 57th St". They can be shortened at display or geocode time. This decision prevents ambiguity over such issues as whether "St" represents "Street" or "Saint". However, it pushes language-specific knowledge into code. We will have libraries and data files to contract acronyms/abbreviations at run-time. */
1172
- text?: string;
1173
- }
1174
- interface GeostorePointProto {
1175
- latE7?: number;
1176
- lngE7?: number;
1177
- /** NOTE: If removing metadata, remove 'option objc_class_prefix = "GS";' together. See cl/189921100. Field-level metadata for this point. NOTE: there are multiple PointProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.point[] and FeatureProto.center. */
1178
- metadata?: GeostoreFieldMetadataProto;
1179
- /** A place for clients to attach arbitrary data to a point. Never set in MapFacts. */
1180
- temporaryData?: any;
1181
- }
1182
- interface GeostoreRectProto {
1183
- hi?: GeostorePointProto;
1184
- lo?: GeostorePointProto;
1185
- }
1186
845
  interface GetCustomerIndexStatsResponse {
1187
846
  /** Average item count for the given date range for which billing is done. */
1188
847
  averageIndexedItemCount?: string;
@@ -1296,45 +955,6 @@ declare namespace gapi.client {
1296
955
  principal?: Principal;
1297
956
  type?: string;
1298
957
  }
1299
- interface IPBlockInfoProto {
1300
- /** ASN of the block. Only present when return_organisational is set in the request options. */
1301
- asn?: string;
1302
- carrierName?: string;
1303
- cookiePopulation?: number;
1304
- /** DNS and organisational info, only present when return_organisational is set in the request options. Currently (November 2010) this data comes from the raw Quova import. */
1305
- dnsDomain?: string;
1306
- /** True, if it is a home IP. Data is from Neustar. */
1307
- homeIndicator?: boolean;
1308
- /** Day averages for this block of number of .. Currently (May 2011) not filled in. .. active IPs */
1309
- ipsEstimate?: number;
1310
- /** ISIC code, data from Neustar. */
1311
- isicCode?: string;
1312
- /** Seconds since epoch any data constituting this block last changed. Currently (May 2011) not filled in. */
1313
- lastChangedS?: number;
1314
- /** NAICS code, data from Neustar. */
1315
- naicsCode?: string;
1316
- /** Data from the NetDB project, see net/ipmap/..., only present when return_netstats is set in the request options. */
1317
- netstats?: NetStatsProto;
1318
- organisationName?: string;
1319
- /** Neustar's organization_type data. */
1320
- organizationType?: string;
1321
- /** Proxy classification of the block. Only present when return_proxy_classification is set in the request options. */
1322
- proxyClassification?: ProxyClassificationProto;
1323
- /** For historical reasons, the 'ranges' field is repeated, but actually it occurs at most once. If present, the range is a set of consecutive IP addresses to which the IPGeo result (including the information in the IPBlockInfoProto as well as other info in the IPGeoResponseProto / LocationResult) applies. This means that when the netstats are present, this will be the intersection of the range from the ipgeo index with the range from the netstats index; when the proxy classification is present, this will be intersected with the IP range to which the proxy classification applies. Caveat: intersection with HHI (household income) IP range is currently not implemented. */
1324
- ranges?: IPRangeProto[];
1325
- /** Estimate of the fraction of IPs that get reallocated per day. Currently (May 2011) not filled in. */
1326
- reallocFracEstimate?: number;
1327
- /** Routing type, only present if return_organisational is set in the request options. Currently (June 2012) this data is not filled in. */
1328
- routingtype?: string;
1329
- /** .. queries */
1330
- trafficEstimate?: number;
1331
- }
1332
- interface IPRangeProto {
1333
- /** A contiguous range [begin, end] of IPv4 or IPv6 addresses in packed binary form. 4 or 16 bytes, big endian */
1334
- packedIpBegin?: string;
1335
- /** inclusive */
1336
- packedIpEnd?: string;
1337
- }
1338
958
  interface Item {
1339
959
  /** Access control list for this item. */
1340
960
  acl?: ItemAcl;
@@ -1463,422 +1083,6 @@ declare namespace gapi.client {
1463
1083
  nextPageToken?: string;
1464
1084
  unmappedIdentities?: UnmappedIdentity[];
1465
1085
  }
1466
- interface LocationExtractorFeatureletAnnotationSet {
1467
- /** The featurelet annotations for the alternate policy. */
1468
- annotations?: string[];
1469
- /** The name of the alternate policy. */
1470
- name?: string;
1471
- }
1472
- interface LocationExtractorInterpretation {
1473
- /** Location on Earth, containing featurelets ordered from most to least specific. These are referred to in the featurelet_index field below. In case of directions queries, this field contains departure location. */
1474
- location?: LocationExtractorLocation;
1475
- /** serialized s-expr annotated with :loc */
1476
- query?: string;
1477
- term?: LocationExtractorInterpretationTerm[];
1478
- }
1479
- interface LocationExtractorInterpretationTerm {
1480
- /** index into location().featurelet() array (above). */
1481
- featureletIndex?: number;
1482
- /** 1+last token covered by this term. */
1483
- tokenEnd?: number;
1484
- /** These token indexes refer to the non-negated tokens of the query returned by the Interpretation. Note: That means you have to parse the query field with the SqueryParser, use QueryTreeUtils::FindOriginalNonNegatedWordNodes to get the original tokens, and use these 1-based indexes to retrieve the appropriate tokens from the result. You can NOT just split the original raw query on whitespace and use this as an offset. first token covered by this term. */
1485
- tokenStart?: number;
1486
- /** Whether this term matched in a language that is "unexpected". For this purpose, expected languages are: request language, languages spoken in request country, English, unknown languages, and languages of the feature's country. */
1487
- unexpectedLanguageMatch?: boolean;
1488
- }
1489
- interface LocationExtractorLocation {
1490
- /** Copy of FeatureProto->RankDetailsProto->address_rank */
1491
- addressRank?: number;
1492
- /** Copy of FeatureProto->RankDetailsProto->area_rank */
1493
- areaRank?: number;
1494
- boundingbox?: LocationExtractorLocationBoundingBox;
1495
- center?: LocationExtractorLocationCenter;
1496
- /** Represents the Location Extraction Server's confidence that this Location is correct. */
1497
- confidence?: number;
1498
- featurelet?: LocationExtractorLocationFeaturelet[];
1499
- /** Information about an ip block, like range, speed etc. */
1500
- ipblockinfo?: IPBlockInfoProto;
1501
- /** Copy of FeatureProto->RankDetailsProto->population_rank */
1502
- populationRank?: number;
1503
- }
1504
- interface LocationExtractorLocationBoundingBox {
1505
- highLatitudeE7?: number;
1506
- highLongitudeE7?: number;
1507
- lowLatitudeE7?: number;
1508
- lowLongitudeE7?: number;
1509
- }
1510
- interface LocationExtractorLocationCenter {
1511
- latitudeE7?: number;
1512
- longitudeE7?: number;
1513
- }
1514
- interface LocationExtractorLocationExtractionResponse {
1515
- /** The request.max_interpretation() most likely interpretations of the input sexpr or raw_query. The ordering of interpretations is determined by request.scorer(). */
1516
- interpretation?: LocationExtractorInterpretation[];
1517
- /** True if the results are unreliable, for example due to a deadline being broken. */
1518
- tainted?: boolean;
1519
- /** Represents the location of the end user, either from the ip or the user_address field in the request. For historical reasons, this is up to 3 separate locations that form a political hierarchy. See location/extractor/client/public/location.h:MergeLocations for a function to merge them into one. NOTE: the user_location does NOT influence the interpretations below. see the remarks about the ip field above. Conversely, this field is the ONLY field that changes depending on ip or user_address input. */
1520
- userLocation?: LocationExtractorLocation[];
1521
- }
1522
- interface LocationExtractorLocationFeaturelet {
1523
- /** A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness. */
1524
- additionalData?: any;
1525
- /** Alternate annotations on this featurelet. */
1526
- alternateAnnotations?: LocationExtractorFeatureletAnnotationSet[];
1527
- /** Annotations applied to this featurelet. This field is modified by the policy store. */
1528
- annotations?: string[];
1529
- /** Copy of FeatureProto->RankDetailsProto->area_rank */
1530
- areaRank?: number;
1531
- boundingbox?: LocationExtractorLocationFeatureletBoundingBox;
1532
- center?: LocationExtractorLocationFeatureletCenter;
1533
- /** Represents the Location Extraction Server's confidence that this featurelet is correct. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This confidence will be populated by Oolong by looking into confidences from each of the locations. */
1534
- confidence?: number;
1535
- /** This field contains original feature's establishment type if it had one. */
1536
- establishmentType?: string;
1537
- /** The GeoStore Feature ID for this feature. This field will be present when the featurelet was derived from or maps to an oyster feature. */
1538
- featureId?: GeostoreFeatureIdProto;
1539
- /** The reference to an entity in the KnowledgeGraph. */
1540
- kgReference?: GeostoreKnowledgeGraphReferenceProto;
1541
- /** Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature. */
1542
- name?: GeostoreNameProto[];
1543
- /** Copy of FeatureProto->RankDetailsProto->population_rank */
1544
- populationRank?: number;
1545
- /** The GeoStore Feature type. */
1546
- type?: string;
1547
- }
1548
- interface LocationExtractorLocationFeatureletBoundingBox {
1549
- highLatitudeE7?: number;
1550
- highLongitudeE7?: number;
1551
- lowLatitudeE7?: number;
1552
- lowLongitudeE7?: number;
1553
- }
1554
- interface LocationExtractorLocationFeatureletCenter {
1555
- latitudeE7?: number;
1556
- longitudeE7?: number;
1557
- }
1558
- interface LocationUnifiedActivityRecord {
1559
- /** The confidence of the detection. Range is [0, 100]. */
1560
- confidence?: number;
1561
- /** The type of activity. */
1562
- type?: string;
1563
- }
1564
- interface LocationUnifiedAnnotationSet {
1565
- /** The annotations that have been applied by some policy. */
1566
- annotations?: LocationUnifiedLocationAnnotation[];
1567
- /** If set then this set of annotations are originating from this client id for production use. */
1568
- clientId?: string;
1569
- /** The name of this set. */
1570
- name?: string;
1571
- /** The policy result that corresponds to the alternate policy. */
1572
- policyResult?: LocationUnifiedPolicyResult;
1573
- /** The source description for this result in the alternate policy. */
1574
- sourceDescription?: string;
1575
- }
1576
- interface LocationUnifiedExtractorFlags {
1577
- gwsJurisdictionCountryExtractorEnabled?: boolean;
1578
- hostDomainExtractorEnabled?: boolean;
1579
- ipAlternateExtractorEnabled?: boolean;
1580
- ipExtractorEnabled?: boolean;
1581
- /** If true, any query found in the request will be included in geocoding and the location context. */
1582
- queryExtractorEnabled?: boolean;
1583
- uuleCookieExtractorEnabled?: boolean;
1584
- xgeoHeaderExtractorEnabled?: boolean;
1585
- }
1586
- interface LocationUnifiedFeatureIdProto {
1587
- /** The S2CellId corresponding to the approximate centroid of this feature. */
1588
- cellId?: string;
1589
- /** A 64-bit fingerprint used to distinguish between multiple features at the same location. */
1590
- fprint?: string;
1591
- }
1592
- interface LocationUnifiedFeatureReference {
1593
- /** Alternate annotations applied to this featurelet. */
1594
- alternateAnnotations?: LocationExtractorFeatureletAnnotationSet[];
1595
- /** Annotations applied to this featurelet by the policy store. */
1596
- annotations?: string[];
1597
- /** The confidence that this featurelet is correct. */
1598
- confidence?: number;
1599
- /** The feature ID, which is used as key for looking up the featurelet from the LocationContext's feature pool. */
1600
- featureId?: GeostoreFeatureIdProto;
1601
- }
1602
- interface LocationUnifiedFieldOfView {
1603
- /** Horizontal degrees of view, i.e. the angle between the left and right clipping planes. */
1604
- fieldOfViewXDegrees?: number;
1605
- /** Vertical degrees of view, i.e. the angle between the top and bottom clipping planes. */
1606
- fieldOfViewYDegrees?: number;
1607
- /** Pixel dimensions of a device screen. This is currently only used by Tactile and should not be used elsewhere without good reason, at which point we would probably rename the field. Pixels are assumed to be square. */
1608
- screenWidthPixels?: number;
1609
- }
1610
- interface LocationUnifiedInterpretationData {
1611
- /** Serialized s-expr annotated with :loc. */
1612
- query?: string;
1613
- /** This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of "Pizza near Mt View CA" would (in one of the geocodes) contain two terms: "Mt View" and "CA". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for "CA". */
1614
- term?: LocationExtractorInterpretationTerm[];
1615
- }
1616
- interface LocationUnifiedLatLng {
1617
- latitudeE7?: number;
1618
- longitudeE7?: number;
1619
- }
1620
- interface LocationUnifiedLatLngRect {
1621
- hi?: LocationUnifiedLatLng;
1622
- lo?: LocationUnifiedLatLng;
1623
- }
1624
- interface LocationUnifiedLocationAnnotation {
1625
- /** Optional debug information associated with this annotation. For human consumption only. */
1626
- details?: string;
1627
- /** Indicates the purpose of this annotation. */
1628
- type?: string;
1629
- }
1630
- interface LocationUnifiedLocationAttributesProto {
1631
- /** The user detected activity. */
1632
- activityRecord?: LocationUnifiedActivityRecord[];
1633
- /** Confidence for use in ads. Might be different from the confidence in the descriptor. Currently only used for locations with producer TRAVEL_STATE_INTENT. */
1634
- adsConfidence?: number;
1635
- /** Altitude in meters, from ground level. */
1636
- altitudeMetersFromGround?: number;
1637
- /** The accuracy of bearing in degrees, based on GMS Core calculations on two latest location points. The actual bearing should be within bearing_degrees ± bearing_accuracy_degrees. */
1638
- bearingAccuracyDegrees?: number;
1639
- /** The direction in degrees in which the client device was moving. Must be in the range 0 to 359. 0 represents north and 90 is east. */
1640
- bearingDegrees?: number;
1641
- /** An opaque token to represent a transit vehicle that a user is riding. This field is always server generated and encoding scheme is determined by the server. Currently, Tactile's local encoding (web-safe base64 prefixed by "B") is used. */
1642
- boardedTransitVehicleToken?: string;
1643
- carrierIpType?: string;
1644
- /** FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Ratio of device location versus other signals that we have for this user. Note that this is a per-user attribute, not a per-location attribute. */
1645
- deviceLocationRatio?: number;
1646
- /** The field of view of a camera. */
1647
- fieldOfView?: LocationUnifiedFieldOfView;
1648
- /** The direction in degrees in which the client device was pointed. Must be in the range 0 to 359. 0 represents north and 90 is east. */
1649
- headingDegrees?: number;
1650
- inference?: string;
1651
- ipRangeConfidence?: number;
1652
- manualEntry?: string;
1653
- /** FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Additional Oolong-specific attributes of the location. */
1654
- personalizedLocationAttributes?: LocationUnifiedPersonalizedLocationAttributes;
1655
- /** FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Total number of locations (across all events) used in PLM inference. */
1656
- plmSourceLocationCount?: number;
1657
- plmType?: string;
1658
- /** Clockwise rotation around the line of sight (i.e. vector (0, 0, -1) in Eye Coords). Zero means that y points up in Screen Coords; 180 gives an upside down view, where y points down in Screen Coords. Allowed range is [0, 360). For out-of-range values, the behavior is undefined. */
1659
- rollDegrees?: number;
1660
- /** The accuracy of the speed in kilometers per hour, meaning that the actual speed should be within speed_kph ± speed_accuracy_kph. */
1661
- speedAccuracyKph?: number;
1662
- /** The speed in kilometers per hour at which the client device was moving. */
1663
- speedKph?: number;
1664
- /** Rotation where zero points down, 180 points up and 90 points to horizon. Allowed range is [0, 180]. For out-of-range values, the behavior is undefined. */
1665
- tiltDegrees?: number;
1666
- viewportSearchOptions?: string;
1667
- weekSecondConfidence?: number;
1668
- }
1669
- interface LocationUnifiedLocationContext {
1670
- /** The client ID that was used for annotating this location context (if any). This field is set accordingly by the policy annotation. */
1671
- clientId?: string;
1672
- /** Flags to customize the extractors used to build this location context. */
1673
- extractorFlags?: LocationUnifiedExtractorFlags;
1674
- /** The feature pool used in the location results. This is a map from feature ID to feature data, but since the feature ID is part of the Featurelet data, just a repeated field enumerating them is enough. */
1675
- featurePool?: LocationUnifiedOolongFeature[];
1676
- /** True if the location context originates from the Hulk Realtime plugin in GWS: go/hulk-realtime-in-search-ads. */
1677
- fromHulkRealtime?: boolean;
1678
- /** If true, only a selected list of descriptors will be added to this context by the standard library functions. This is so that debug parameters can be used to override the context reliably. The descriptors that can be added is determined by the lock_strategy enum. Note that policies may override and ignore this flag altogether. */
1679
- lockedForDebug?: boolean;
1680
- /** If true, the location context should be kept as is, no policy should modify it, except for: setting the client id and adding qref location. */
1681
- lockedForPolicy?: boolean;
1682
- /** Defines which roles/producers can be added/edit for the context. This field is used only when locked_for_debug flag is set. */
1683
- lockStrategy?: string;
1684
- nonstandardData?: any;
1685
- /** Information about the origin of the location context. This is used to validate that the location context was created through a valid means, which is Oolong. DO NOT SET THIS FIELD YOURSELF. In fact, do not construct location contexts yourself. */
1686
- origin?: LocationUnifiedLocationContextOrigin;
1687
- results?: LocationUnifiedLocationResult[];
1688
- }
1689
- interface LocationUnifiedLocationContextOrigin {
1690
- /** Sequence of Dejitter modifications applied to the associated LocationContext. For monitoring and debugging use only; it should be safe to remove or change the contents of this field at any time. */
1691
- dejitterModifications?: string[];
1692
- /** The origin of the LocationContext. May be updated by restricted Oolong libraries that modify the LocationContext after it was returned. Some Apps Framework services use this in their location propagation logic to decide whether a LocationContext is suitable for propagating to backends. */
1693
- type?: string;
1694
- }
1695
- interface LocationUnifiedLocationDescriptor {
1696
- /** A 128-bit feature consisting of an S2Cell and a unique feature identifier. Should be unused outside of the internal applications by the Oolong team. */
1697
- additionalFeatureId?: LocationUnifiedFeatureIdProto;
1698
- /** Supplemental attributes for a location that are not related to geocoding, but still may affect search results. */
1699
- attributes?: LocationUnifiedLocationAttributesProto;
1700
- /** A confidence measure. Percentage: must be 0 to 100. */
1701
- confidence?: number;
1702
- /** WARNING: Do not use this field without talking to the oolong-team@ first. It should never contain any Personal Identification Information (PII). You can use this field to provide diagnostic information about the location extraction code. Some examples could include the latency of getting the location, the fact that it was retrieved from the cache or not, the reason for not providing the location, software version (if that cannot be used to identify the user). Make sure to prepare a PDD that describes what is stored in this field for your project before using the field. */
1703
- diagnosticInfo?: string;
1704
- /** A 128-bit feature consisting of an S2Cell and a unique feature identifier. */
1705
- featureId?: LocationUnifiedFeatureIdProto;
1706
- /** This field is intended for recording the producer of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the producer of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend. */
1707
- historicalProducer?: string;
1708
- /** This field is intended for recording frequency of historical location usage. Do not use it unless you know the historical producer intention for this field. DEPRECATED: This is no longer used or populated. */
1709
- historicalProminence?: number;
1710
- /** This field is intended for recording the role of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the role of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend. */
1711
- historicalRole?: string;
1712
- /** The language used previously for query geocoding, set to the frontend language of the user during extraction. DO NOT USE THIS TO GET A USER'S LANGUAGE. INSTEAD, GET THE LANGUAGE FROM THE FrontendRequest OR THROUGH ANOTHER API! THIS FIELD WILL GO AWAY. */
1713
- language?: string;
1714
- /** A latitude and longitude used to describe this location as a point. */
1715
- latlng?: LocationUnifiedLatLng;
1716
- /** The span of a bounding box whose center is latlng. Specifies the lengths of the sides of the box and is valid only if latlng is present. DEPRECATED(6/6/2012): b/5979511. Use 'rect' instead. */
1717
- latlngSpan?: LocationUnifiedLatLng;
1718
- /** A 128-bit feature ID for the (indoor) level/floor of this location. If present, the floor supplements other location attributes in this descriptor. For example, in shopping malls it is quite common that one store occupies rooms on multiple levels, connected with escalators. The user can be at the exact same lat/lng and at the same GAP store, but on different levels. */
1719
- levelFeatureId?: LocationUnifiedFeatureIdProto;
1720
- /** The number of this location's level relative to the ground floor. 0 means ground floor; -2 is two levels below ground; +0.5 is a mezzanine. */
1721
- levelNumber?: number;
1722
- /** A string containing the location payload. The format of this string may depend on the producer but it should be otherwise be treated like a freeform, human-readable string (a query, a street address, city name, postal code, district name, country, etc.). Other, producer-specific formats include IP address, host domain, and squery. time zone. Note that for some producers there is no guarantee that the string contains a valid location (e.g., a query for [pizza]). */
1723
- loc?: string;
1724
- /** A 64-bit machine identifier of a geo feature in Freebase. */
1725
- mid?: string;
1726
- /** The granularity of the location permissions that was present to get the device location that this location descriptor represents. Only relevant for device locations. */
1727
- permissionGranularity?: string;
1728
- /** The presence intervals associated with the location. Required for FUTURE_LOCATION signals. This field should not be logged anywhere. */
1729
- presenceInterval?: LocationUnifiedPresenceInterval[];
1730
- /** The producer of this location. */
1731
- producer?: string;
1732
- /** Extra information about how this descriptor was obtained. Provenance is intended for logging non-semantic details about a descriptor (e.g., whether it was passed using a particular parameter or stored in a particular backend). It should *never* be used as a criterion for selection by a policy or backend (use role/producer instead). This is for bookkeeping only. You don't want this field. Really. */
1733
- provenance?: string;
1734
- /** The radius within which one standard deviation (or 68%) of possible locations lie, assuming a normal distribution around latlng. This radius is normally seen in the UI of mobile maps as the blue 'accuracy circle', although the interpretation (e.g. 1sd or 2sd) may vary by platform. Units must be in mm. */
1735
- radius?: number;
1736
- /** A viewport or bounds depending on role/producer. For example, when role is VIEWPORT this field represents a viewport. 'latlng' and 'rect' are mutually exclusive. */
1737
- rect?: LocationUnifiedLatLngRect;
1738
- /** The role of this location. */
1739
- role?: string;
1740
- /** Some producers may additionally specify semantics explaining the meaning of a location, in particular to differentiate several locations with the same producer. */
1741
- semantic?: string[];
1742
- /** If there are multiple semantic places, then the first place is the finest, then come the parent hierarchy. This field should not be logged anywhere. */
1743
- semanticPlace?: LocationUnifiedSemanticPlace[];
1744
- /** A timestamp associated with this location expressed as the number of microseconds since 00:00:00 Jan-1-1970 UTC. If not set, assumed to be "now" or irrelevant. Use this field to indicate when this location has been acquired (e.g. by requesting location from the device). */
1745
- timestamp?: string;
1746
- /** A list of visible networks that describe the location and can geocoded by GLS. This field should not be logged anywhere. */
1747
- visibleNetwork?: LocationUnifiedVisibleNetwork[];
1748
- }
1749
- interface LocationUnifiedLocationResult {
1750
- /** Additional sets of annotations from other oolong policies. */
1751
- alternateAnnotations?: LocationUnifiedAnnotationSet[];
1752
- /** The annotations that have been applied to this result for use in production. */
1753
- annotations?: LocationUnifiedLocationAnnotation[];
1754
- /** Information about whether the feature hierarchy contains default-blocked features. */
1755
- defaultBlockingData?: DefaultBlockingDataProto;
1756
- /** The descriptor for this result. Once added, descriptors should be considered immutable. Any additional information should be included elsewhere in the result. */
1757
- desc?: LocationUnifiedLocationDescriptor;
1758
- /** Flag to indicate this result has human-readable names for display. */
1759
- displayable?: boolean;
1760
- extraData?: LocationUnifiedLocationResultExtraData;
1761
- /** The feature hierarchy for this location result, if using the new feature-pool format instead of les_response. */
1762
- featureRefs?: LocationUnifiedFeatureReference[];
1763
- /** True indicates that this result has geographical information like a lat/long, bounding box, etc.). The minimum is a lat/long. False only indicates that no such data is present and does NOT explain the reason (e.g., geocoding hasn't been attempted, geocoding timed out, the descriptor does not refer to a location, etc.). */
1764
- geocoded?: boolean;
1765
- /** Explains the specific reason for the value of the geocoded field, if any. This can be used to determine whether a descriptor needs to be geocoded. Used for making runtime decisions about whether to attempt geocoding. */
1766
- geocodingReason?: string;
1767
- /** WARNING: Do not reference this field directly check go/oolong-usage on how to access the values present in this proto or contact oolong-team@google.com if you don't see what you need. */
1768
- lesResponse?: LocationExtractorLocationExtractionResponse;
1769
- /** Allow pipelines to associate arbitrary data (e.g., specialized geo identifiers) with a result. Chiefly intended to pass custom data around backends after standard geocoding and policy execution. Oolong libraries will generally ignore such data but may strip it to guard against cache fragmentation. Using this to pass data from frontends to backends before geocoding is not recommended and at your own risk. This field will carry AnonymizedBounds data which will be used for logging purposes. */
1770
- nonstandardData?: any;
1771
- /** Result data computed by the policy annotation. */
1772
- policyResult?: LocationUnifiedPolicyResult;
1773
- /** Enum describing what this result was based on (e.g. location reported by the end user's phone). Present only if the LocationContext was produced by OolongService and this result has the USFUL annotation. */
1774
- sourceDescription?: string;
1775
- }
1776
- interface LocationUnifiedLocationResultExtraData {
1777
- /** Result caused a feature diff */
1778
- featureDiff?: boolean;
1779
- /** For query results. */
1780
- interpretationData?: LocationUnifiedInterpretationData;
1781
- /** Information about an ip block, like range, speed etc. This could be the only thing present in an empty result. */
1782
- ipblockinfo?: IPBlockInfoProto;
1783
- }
1784
- interface LocationUnifiedOolongFeature {
1785
- /** A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness. */
1786
- additionalData?: any;
1787
- /** Copy of FeatureProto->RankDetailsProto->area_rank */
1788
- areaRank?: number;
1789
- /** Latitude and longitude of the feature center. */
1790
- center?: GeostorePointProto;
1791
- /** This field contains original feature's establishment type if it had one. */
1792
- establishmentType?: string;
1793
- /** The GeoStore Feature ID for this feature. This value is also used as key into the feature pool from FeatureReference's. */
1794
- featureId?: GeostoreFeatureIdProto;
1795
- /** The reference to an entity in the KnowledgeGraph. */
1796
- kgReference?: GeostoreKnowledgeGraphReferenceProto;
1797
- /** Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature. */
1798
- name?: GeostoreNameProto[];
1799
- /** Copy of FeatureProto->RankDetailsProto->population_rank */
1800
- populationRank?: number;
1801
- /** The bounding box of this feature. */
1802
- rect?: GeostoreRectProto;
1803
- /** The GeoStore Feature type. */
1804
- type?: string;
1805
- }
1806
- interface LocationUnifiedPersonalizedLocationAttributes {
1807
- /** Number of days the location was supported by any 'physical presence'-like or 'explicit-interest'-like location. */
1808
- anySupportingDays?: number;
1809
- /** Binary mask representing "explicit-interest" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS. */
1810
- eiDailyVisits?: number;
1811
- /** Binary mask representing "physical-presence" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS. */
1812
- ppDailyVisits?: number;
1813
- /** Number of days the location was supported by any 'physical presence'-like location. */
1814
- ppSupportingDays?: number;
1815
- /** Number of weeks the location was supported by any 'physical presence'-like location. */
1816
- ppSupportingWeeks?: number;
1817
- /** IP ranges that the location was supported by. */
1818
- supportingPackedIpRanges?: string[];
1819
- }
1820
- interface LocationUnifiedPolicyResult {
1821
- confidenceRects?: LocationUnifiedPolicyResultConfidenceRect[];
1822
- }
1823
- interface LocationUnifiedPolicyResultConfidenceRect {
1824
- /** Confidence in the range [0, 100]. */
1825
- confidence?: number;
1826
- /** The bounding box that we believe is certain with probability given by confidence. */
1827
- rect?: LocationUnifiedLatLngRect;
1828
- }
1829
- interface LocationUnifiedPresenceInterval {
1830
- /** Probability of presence as a percentage in [0, 100]. */
1831
- confidence?: number;
1832
- /** Interval duration in seconds. */
1833
- durationSec?: string;
1834
- /** Start of the interval as the number of seconds from the time of the location. */
1835
- startOffsetSec?: string;
1836
- }
1837
- interface LocationUnifiedSemanticPlace {
1838
- confidence?: string;
1839
- /** The feature id of the semantic location POI */
1840
- featureId?: LocationUnifiedFeatureIdProto;
1841
- /** Geo Ontology GConcept Instances of the semantic location */
1842
- gconceptInstance?: LocationUnifiedSemanticPlaceGConceptInstanceProto[];
1843
- /** The probability the user is at this place in [0 100]. */
1844
- score?: number;
1845
- source?: string;
1846
- }
1847
- interface LocationUnifiedSemanticPlaceGConceptInstanceProto {
1848
- gconceptId?: string;
1849
- prominence?: string;
1850
- }
1851
- interface LocationUnifiedVisibleNetwork {
1852
- cell?: LocationUnifiedVisibleNetworkCell;
1853
- /** True if the user's device is currently connected to the network. */
1854
- connected?: boolean;
1855
- /** The timestamp of this network. That is when this network was detected, expressed as the number of milliseconds since unix epoch. If not set, assumed to be "now" or irrelevant. */
1856
- timestampMs?: string;
1857
- wifi?: LocationUnifiedVisibleNetworkWiFi;
1858
- }
1859
- interface LocationUnifiedVisibleNetworkCell {
1860
- /** For GSM, LTE and WCDMA networks, this field holds the cell ID of the network. For CDMA networks, this field holds the base station ID of the network. */
1861
- cellId?: number;
1862
- /** For GSM and WCDMA networks, this field holds the location area code of the network. For LTE networks, this field used to hold the tracking area code of the network, but this usage has been deprecated, and that value should now be provided through tracking_area_code. For CDMA networks, this field holds the network ID of the network. */
1863
- locationAreaCode?: number;
1864
- /** The mobile country code of the network. */
1865
- mobileCountryCode?: number;
1866
- /** The mobile network code of the network. */
1867
- mobileNetworkCode?: number;
1868
- /** Only set for LTE networks for which this field holds the physical cell ID. */
1869
- physicalCellId?: number;
1870
- /** Only set for WCDMA networks for which this field holds the primary scrambling code of the network. */
1871
- primaryScramblingCode?: number;
1872
- /** Only set for LTE networks for which this field holds the tracking area code. */
1873
- trackingAreaCode?: number;
1874
- type?: string;
1875
- }
1876
- interface LocationUnifiedVisibleNetworkWiFi {
1877
- /** The BSSID of the network (i.e. MAC address of the access point). */
1878
- bssid?: string;
1879
- /** The signal level of the network in dBm (RSSI). */
1880
- levelDbm?: number;
1881
- }
1882
1086
  interface MapInfo {
1883
1087
  /** Latitude in degrees */
1884
1088
  lat?: number;
@@ -1909,7 +1113,6 @@ declare namespace gapi.client {
1909
1113
  /** Name of the media resource. */
1910
1114
  resourceName?: string;
1911
1115
  }
1912
- interface MessageSet {}
1913
1116
  interface Metadata {
1914
1117
  /** The creation time for this document or object in the search result. */
1915
1118
  createTime?: string;
@@ -1951,12 +1154,6 @@ declare namespace gapi.client {
1951
1154
  textValues?: TextValues;
1952
1155
  timestampValues?: TimestampValues;
1953
1156
  }
1954
- interface NetStatsProto {
1955
- bandaidBandwidthKbps?: BandWidthRangeKbps;
1956
- bandwidthKbps?: number;
1957
- gfeBandwidthKbps?: BandWidthRangeKbps;
1958
- videostatsBandwidthKbps?: BandWidthRangeKbps;
1959
- }
1960
1157
  interface ObjectDefinition {
1961
1158
  /** The name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */
1962
1159
  name?: string;
@@ -1998,12 +1195,6 @@ declare namespace gapi.client {
1998
1195
  /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
1999
1196
  response?: {[P in string]: any};
2000
1197
  }
2001
- interface OptInStatus {
2002
- /** If the user is ineligible, they should not be opted in! */
2003
- eligibility?: string;
2004
- /** If the user is ineligible, they should not be opted in! */
2005
- optedIn?: boolean;
2006
- }
2007
1198
  interface PeoplePromotionCard {
2008
1199
  people?: PersonCore[];
2009
1200
  }
@@ -2135,9 +1326,6 @@ declare namespace gapi.client {
2135
1326
  /** In case the item fields are invalid, this field contains the details about the validation errors. */
2136
1327
  fieldViolations?: FieldViolation[];
2137
1328
  }
2138
- interface ProminentEntity {
2139
- mid?: string;
2140
- }
2141
1329
  interface PropertyDefinition {
2142
1330
  booleanPropertyOptions?: BooleanPropertyOptions;
2143
1331
  datePropertyOptions?: DatePropertyOptions;
@@ -2169,17 +1357,6 @@ declare namespace gapi.client {
2169
1357
  /** The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters. */
2170
1358
  displayLabel?: string;
2171
1359
  }
2172
- interface ProxyClassificationProto {
2173
- /** WARNING: these fields are coming from a third party. Please consider using only privacy_proxy_operator. Before adding any new usage of this data, please talk to zszami@ and ipgeo-team@. */
2174
- anonymizerStatus?: string;
2175
- hostingFacility?: boolean;
2176
- /** Operator of a privacy proxy, e.g. Google One (PPN) or Apple Private Relay. Mapping maintained by Google, does not include data from Neustar. If in doubt, use privacy_proxy_operator == NONE and != NONE to check for privacy proxies. */
2177
- privacyProxyOperator?: string;
2178
- /** In seconds since the Epoch. */
2179
- proxyLastDetectedS?: string;
2180
- proxyLevel?: string;
2181
- proxyType?: string;
2182
- }
2183
1360
  interface PushItem {
2184
1361
  /** Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */
2185
1362
  contentHash?: string;
@@ -2208,11 +1385,6 @@ declare namespace gapi.client {
2208
1385
  /** User input query to be logged/removed. */
2209
1386
  query?: string;
2210
1387
  }
2211
- interface QueryBiasingContext {
2212
- /** Specifies the mode to bias the queries from the client into. The mode value should be coming from the Mode enum. */
2213
- mode?: number;
2214
- prominentEntity?: ProminentEntity[];
2215
- }
2216
1388
  interface QueryCountByStatus {
2217
1389
  count?: string;
2218
1390
  /** This represents the http status code. */
@@ -2554,12 +1726,6 @@ declare namespace gapi.client {
2554
1726
  /** Suggestion triggered for the current query. */
2555
1727
  suggestionType?: string;
2556
1728
  }
2557
- interface StarlightConsistency {
2558
- /** Optional, data-source specific, data to help achieve consistency. */
2559
- consistency?: any;
2560
- /** Timestamp of last write operation. By setting this value, a client requests to trigger a new fresh data acquisition if the fresh model is older than this timestamp. */
2561
- timestampSec?: number;
2562
- }
2563
1729
  interface StartUploadItemRequest {
2564
1730
  /** The name of connector making this call. Format: datasources/{source_id}/connectors/{ID} */
2565
1731
  connectorName?: string;
@@ -2582,12 +1748,6 @@ declare namespace gapi.client {
2582
1748
  /** Representation of a person */
2583
1749
  person?: Person;
2584
1750
  }
2585
- interface SuggestPersonalRerankDebugInfo {
2586
- /** Can be used to store additional user history. */
2587
- additionalInfo?: any;
2588
- /** The first query is considered to be the most recent query. */
2589
- userHistory?: string[];
2590
- }
2591
1751
  interface SuggestRequest {
2592
1752
  /** The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE */
2593
1753
  dataSourceRestrictions?: DataSourceRestriction[];
@@ -2596,35 +1756,10 @@ declare namespace gapi.client {
2596
1756
  /** Request options, such as the search application and user timezone. */
2597
1757
  requestOptions?: RequestOptions;
2598
1758
  }
2599
- interface SuggestRequestDebugOptions {
2600
- /** Whether to add the subtype to the suggestion so it can be displayed in a side-by-side */
2601
- annotateWithSubtype?: boolean;
2602
- /** Whether to enable debug info in SuggestResults. */
2603
- debug?: boolean;
2604
- disableBadwordFiltering?: boolean;
2605
- /** Whether to disable the hybrid cache. */
2606
- disableHybridCache?: boolean;
2607
- disableKesemFiltering?: boolean;
2608
- /** Whether to pull personal data from Starlight like Anima profile data for personal SxS eval. */
2609
- enableGetDataFromStarlightForPersonalSxs?: boolean;
2610
- /** Whether to add the user gaia_id to the request, so it can return personal suggestions. */
2611
- enablePersonal?: boolean;
2612
- freshMode?: string;
2613
- /** Number of results to return. If 0, this options is ignored. Is NOT subject to the upper bound limit controlled by num_results_limit_max_override flag */
2614
- numResults?: number;
2615
- sxs?: boolean;
2616
- trace?: string;
2617
- }
2618
1759
  interface SuggestResponse {
2619
1760
  /** List of suggestions. */
2620
1761
  suggestResults?: SuggestResult[];
2621
1762
  }
2622
- interface SuggestRestrict {
2623
- /** Name of the restrict, e.g. lang. */
2624
- name?: string;
2625
- /** Restrict value. */
2626
- value?: string;
2627
- }
2628
1763
  interface SuggestResult {
2629
1764
  /** This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc. */
2630
1765
  peopleSuggestion?: PeopleSuggestion;
@@ -2635,197 +1770,6 @@ declare namespace gapi.client {
2635
1770
  /** The suggested query that will be used for search, when the user clicks on the suggestion */
2636
1771
  suggestedQuery?: string;
2637
1772
  }
2638
- interface SuggestSuggestRequest {
2639
- requestdata?: SuggestSuggestRequestRequestData[];
2640
- }
2641
- interface SuggestSuggestRequestRequestData {
2642
- /** Number of sequentially added characters after a sequential deletion. */
2643
- addedCharacterCount?: number;
2644
- /** Enable calculator. Turning this field on will cause Complete Server to fill the SuggestResults.CalculatorSuggestion string field and it instead disables all the oneboxes (in SuggestResults.CompleteSuggestion.info), including the calculator onebox. Clients that are capable of rendering oneboxes should use the onebox calculator (and should leave this field turned off). When not specified, the default value of this field depends on the client. See suggestflow_state.cc: CommonInit(). */
2645
- calc?: boolean;
2646
- /** City location ID. */
2647
- cityId?: number;
2648
- /** The name of the requesting client (firefox, chrome, etc.). */
2649
- client?: string;
2650
- /** The client instance ID provided by AGSA. See http://go/client-instance-id */
2651
- clientInstanceId?: string;
2652
- clientThumbnailDimensions?: SuggestSuggestRequestRequestDataClientThumbnailDimensions;
2653
- /** Enable completion. */
2654
- complete?: boolean;
2655
- /** Allow sending read-after-write consistency data to Starlight. */
2656
- consistency?: StarlightConsistency;
2657
- /** Repeated list of URLs that we use to trigger context based suggestions (currently zero-prefix). */
2658
- contextUrls?: string[];
2659
- /** cookie_init_time is typically set by GoogleCookie::initial_time() */
2660
- cookieInitTime?: number;
2661
- /** Requested country (us, uk, jp, cn, etc.). */
2662
- country?: string;
2663
- /** Country as determined by GeoIP. */
2664
- countryByIp?: string;
2665
- /** Cursor position (for result-page requests). */
2666
- cp?: number;
2667
- /** The dasher domain of the searcher. */
2668
- dasherDomain?: string;
2669
- /** Enable debug output. */
2670
- debug?: boolean;
2671
- debugOptions?: SuggestRequestDebugOptions;
2672
- /** Any sequentially deleted characters after the cursor position. */
2673
- deletedCharacters?: string;
2674
- /** Whether to run in Infinite Suggest mode. */
2675
- DEPRECATEDInfiniteSuggest?: boolean;
2676
- deviceOsVersion?: string;
2677
- /** Requested dataset (i, m, yt, etc.). */
2678
- ds?: string;
2679
- /** Whether to enable Visual Suggest. (Currently used for YouTube Suggest) Clients can opt to disable Visual Suggest based on current device specs and network conditions. */
2680
- enableVisualSuggest?: boolean;
2681
- /** Experiment ID. */
2682
- expid?: string;
2683
- /** Define the way to read data from the location context. */
2684
- forceUserLocation?: boolean;
2685
- /** Parameter frozen_clock in microseconds passed by SXS eval. This will be used as random number generator bit for consistent randomization for SXS tests. */
2686
- frozenClock?: string;
2687
- /** Gaia ID for personal suggestions. Format is that of http://displayserver.corp.google.com/ Use ParseLeadingHex64Value in numbers.h to convert to an uint64 */
2688
- gaiaId?: string;
2689
- /** Hour of the week (UTC). */
2690
- hourOfTheWeek?: number;
2691
- /** For each completion, annotate with: https://cs.corp.google.com/#piper///depot/google3/suggest/base/ answer.proto&l=15&rcl=53295698&pv=1 which is the probability that issuing the completion as a query will result in an answer being displayed to the user (live-result,one-box, etc.) If there is no answer type for which the probability is above zero, the completion will not be annotated. */
2692
- includeAnswerData?: boolean;
2693
- includeLocalSignals?: boolean;
2694
- /** Annotate the suggestions with webref data. */
2695
- includeWebrefAnnotations?: boolean;
2696
- /** The user's ip address. Should NOT be used to override domain. */
2697
- ipAddress?: string;
2698
- /** True only when using the CS debug console. */
2699
- isConsole?: boolean;
2700
- /** Set once by the server. Can be used for dog-fooding or tests. */
2701
- isDebugIp?: boolean;
2702
- /** The following two fields, is_mobile_device and is_mobile_ux are used to denote whether the request comes from a mobile device or a device with mobile user experience. It's possible for a device type to be different than UX type since tablet devices could receive either mobile or desktop UX, as explained in go/ux-tier-logging. */
2703
- isMobileDevice?: boolean;
2704
- isMobileUx?: boolean;
2705
- /** For users who are using Google Apps for work (dasher) but are not internal users, we would like to turn off instant apps. */
2706
- isNonCorpDasherAccount?: boolean;
2707
- /** Indicates whether the request comes from china. */
2708
- isRequestFromChina?: boolean;
2709
- /** Whether the user's account is a Unicorn child account. */
2710
- isUnicornAccount?: boolean;
2711
- /** This field should be set to false for requests that are generated due to something other than user interaction. For example: 0-prefix requests could be sent in the background (e.g. periodically) for updating a client side cache. On Android GSA, see http://go/android-0q-cache. Backends, such as Starlight, can then use this signal, e.g. for matters like load-shedding. */
2712
- isUserInitiatedRequest?: boolean;
2713
- /** Whether the query was from voice search (set by Youtube LR) */
2714
- isVoiceQuery?: boolean;
2715
- /** Requested language (en, ru, iw, etc.). */
2716
- lang?: string;
2717
- /** GPS coordinates of the mobile client in degrees, if known. */
2718
- latitude?: number;
2719
- /** Oolong LocationContext (see http://goto/oolong). */
2720
- locationContext?: LocationUnifiedLocationContext;
2721
- /** Region location ID. */
2722
- locationId?: number;
2723
- /** If true, will log if there was any flaky backend in SuggestResponse. */
2724
- logFlakyBackends?: boolean;
2725
- longitude?: number;
2726
- /** If true, only fetch lookahead buffer and ignore suggest_results. */
2727
- lookaheadAdditionalResultsOnly?: boolean;
2728
- /** If set, sends enough suggest results to cover the specified ratio of probable next characters the user will type. */
2729
- lookaheadCoverage?: number;
2730
- /** State that overrides whether or not the maps fallback flow should run. */
2731
- mapsMissPrefix?: string;
2732
- /** Enable navsuggest. */
2733
- nav?: boolean;
2734
- /** Enable news. */
2735
- news?: boolean;
2736
- /** Upper limit of the number of navsuggest results to return. */
2737
- numNavResults?: number;
2738
- /** Number of suggestions to return. * In non Generic-Suggest clients, when set, this overrides the client configuration. Subject to upper bound limit controlled by num_results_limit_max_override flag. * In Generic-Suggest clients, when set, this caps the number of suggestions in addition to the client configuration. Ignores num_results_limit_max_override flag. */
2739
- numResultsLimit?: number;
2740
- /** Chrome Omnibox focus type. This param is passed in "oft" CGI param. */
2741
- omniboxFocusType?: string;
2742
- /** Chrome Omnibox input type. This param is passed in "oit" CGI param. */
2743
- omniboxInputType?: string;
2744
- /** Chrome Omnibox page classification. This param is passed in "pgcl" CGI param. */
2745
- omniboxPageClassification?: string;
2746
- /** The OPA opaque token provided by OPA. NOTE: Deprecated. Please use consistency.FootprintsVersionInfo.version_info. */
2747
- opaOpaqueToken?: string;
2748
- /** The opt-in context passed by GSA for App History suggestions. The opt-in context has a list of apps that should be excluded from the personalized App History suggestions. More details at: go/apphistory-suggestions. */
2749
- optInContext?: ClientOptInContext;
2750
- /** Any additional SuggestRequest::RequestData params, like: RequestAndReferenceOverride (see experiments/suggest_experiment.proto): overrides the default client options; useful for enabling a feature on top of existing features defined for a given client. Person: extra params required by the people flow. MapsHeadRequestParams: extra params used by the maps head flow. OnFocusRequestParams: extra params used by on-focus request. SrDataForSuggestContextualizationRequestParams: extra params used by the SR for suggest context flow. MultimodalSuggestImageSignals: extra params used by Multimodal suggest flow. */
2751
- params?: any;
2752
- /** The user debug info used in testing, offline analysis. */
2753
- personalRerankDebugInfo?: SuggestPersonalRerankDebugInfo;
2754
- /** Deprecated. */
2755
- prefId?: string;
2756
- /** For result-page requests. */
2757
- previousQuery?: string;
2758
- /** Seconds since the previous_query was issued. Default value -1 means this field is not set in request. */
2759
- previousQuerySeconds?: number;
2760
- /** Video id for the most recently watched Youtube Video on Android App. See go/pvideo-suggest for more details. Don't use this directly, instead use request_context->video_or_pvideo_id(). */
2761
- previousVideoId?: string;
2762
- /** Time in seconds since end of watch on the most recently watched Youtube Video on Android App. */
2763
- previousVideoSeconds?: string;
2764
- /** Ask Google Suggest server for completions for this query. */
2765
- query?: string;
2766
- queryBiasingContext?: QueryBiasingContext;
2767
- /** The HTTP request's referrer, it will be set for requests coming from web (desktop or mobile). */
2768
- referrer?: string;
2769
- /** Thirdparty restricted search. */
2770
- restrict?: SuggestRestrict[];
2771
- runtimeData?: SuggestSuggestRequestRequestDataRuntimeData;
2772
- /** End position of the user's selection (if any). */
2773
- selectionEnd?: number;
2774
- /** Specifies whether we should personalize Suggest results. Based on whether this field is set or not, we have the following interpretations: (1) this field is not set - we request a Kansas check to be done in PSuggest server (fall back to the user personalization settings) Note: this is the default behavior (2) this field is set to true - this forces personalization regardless Kansas settings (3) this field is set to false - this disables personalization (PSuggest flows are not invoked) Note: Originally, we planned to have Kansas check in GWS, however it turns out that Kansas is not on Suggest path and we were forced to implement this check in PSuggest server. See http://b/5265965 for more details. */
2775
- shouldPersonalize?: boolean;
2776
- /** Requests suggestions for query restricted to specified site. Should be a sitename (ex: 'youtube.com') */
2777
- siteRestrict?: string;
2778
- /** The source language for dictionary/translate (en, ru, iw, etc.). */
2779
- sourceLang?: string;
2780
- /** Enable spell correction. */
2781
- spell?: boolean;
2782
- /** Deprecated: GWS Experiment Ids that are tagged for Spelling. */
2783
- spellingExperimentIds?: number[];
2784
- /** If non-negative, determines the start index (starting at 0) for results: a value of '0' is a no-opt; and e.g. a value of '20' would skip the first 20 suggestions, returning results 21 - ?? (e.g. ?? = 30 if num_results_limit = 10). Currently, this is only used by PSuggest, and will be ignored by all other suggest backends. */
2785
- startIndex?: number;
2786
- /** Request options, filled in a runtime. */
2787
- suggestRequestId?: number;
2788
- /** Suppress fragment generation and bolding. */
2789
- suppressBolding?: boolean;
2790
- /** Disables pluspage suggestions. This overrides client config. Intended for temporary UI state change as it happens when toolbar is activated. */
2791
- suppressPluspages?: boolean;
2792
- /** The target language for dictionary/translate (en, ru, iw, etc.). */
2793
- targetLang?: string;
2794
- /** For querynation, this is the psychic completed part of the query. For example if the user has entered [cancun hote] in the searchbox and this completes to [cancun hotels], then text_ahead="ls". */
2795
- textAhead?: string;
2796
- /** Original query before it was refined or corrected (set by Youtube LR) */
2797
- uncorrectedOriginalQuery?: string;
2798
- /** The user agent string, to be used temporarily within CompleteServer to accurately compute data volume estimate for additional events added to Sessions for Proxima (namely, go/search-metrics-and-triggering-proxima). */
2799
- userAgent?: string;
2800
- /** FeatureId associated with user location (from Oolong) as a string */
2801
- userLocationFeatureId?: string;
2802
- /** Index of the result in location_context.results field that best describes the user location. */
2803
- userLocationResult?: number;
2804
- userPrefs?: SuggestSuggestRequestRequestDataUserPreferences;
2805
- /** Override the user location. Used for debugging. */
2806
- uuld?: string;
2807
- /** Video id for the currently watching Youtube Video. Don't use this directly, instead use request_context->video_or_pvideo_id(). */
2808
- videoId?: string;
2809
- /** Encrypted YouTube Visitor Data (see go/visitor-id-suggest). For privacy reasons, visitor_data can only be set in absence of gaia_id. */
2810
- visitorData?: string;
2811
- /** External YouTube Channel ID for channel scoped suggestions. This ID is is passed through for creator features and is used to fetch channel personalized suggestions. */
2812
- youtubeExternalChannelId?: string;
2813
- /** zwieback_id is set by GoogleCookie::uid() For SxS we override zwieback_id, please access through SuggestFlowUtils::GetZwiebackId(...). */
2814
- zwiebackId?: string;
2815
- }
2816
- interface SuggestSuggestRequestRequestDataClientThumbnailDimensions {
2817
- devicePixelRatio?: number;
2818
- iconSizeInDp?: number;
2819
- targetThumbnailHeight?: number;
2820
- /** Currently only used for YouTube Visual Suggest (go/ytandroid-visual-suggest). */
2821
- targetThumbnailWidth?: number;
2822
- }
2823
- interface SuggestSuggestRequestRequestDataRuntimeData {
2824
- sanitizedRequestLanguage?: string;
2825
- }
2826
- interface SuggestSuggestRequestRequestDataUserPreferences {
2827
- isTrendsDisabled?: boolean;
2828
- }
2829
1773
  interface TextOperatorOptions {
2830
1774
  /** If true, the text value is tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" doesn't match the item; "genre:science-fiction" does. Text value matching is case-sensitive and does not remove special characters. If false, the text is tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" matches the item. */
2831
1775
  exactMatchWithOperator?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudsearch-v1",
3
- "version": "0.0.20240626",
3
+ "version": "0.0.20240722",
4
4
  "description": "TypeScript typings for Cloud Search API v1",
5
5
  "repository": {
6
6
  "type": "git",