Repository navigation
Expand file tree
/
Copy pathUserInfo.php
More file actions
285 lines (267 loc) · 12.4 KB
/
Copy pathUserInfo.php
File metadata and controls
285 lines (267 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/retail/v2/common.proto
namespace Google\Cloud\Retail\V2;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* Information of an end user.
*
* Generated from protobuf message <code>google.cloud.retail.v2.UserInfo</code>
*/
class UserInfo extends \Google\Protobuf\Internal\Message
{
/**
* Highly recommended for logged-in users. Unique identifier for logged-in
* user, such as a user name.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>string user_id = 1;</code>
*/
private $user_id = '';
/**
* The end user's IP address. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* This field is used to extract location information for personalization.
* This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
* address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
* INVALID_ARGUMENT error is returned.
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string ip_address = 2;</code>
*/
private $ip_address = '';
/**
* User agent as included in the HTTP header. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* The field must be a UTF-8 encoded string with a length limit of 1,000
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* This should not be set when using the client side event reporting with
* GTM or JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string user_agent = 3;</code>
*/
private $user_agent = '';
/**
* True if the request is made directly from the end user, in which case the
* [ip_address][google.cloud.retail.v2.UserInfo.ip_address] and
* [user_agent][google.cloud.retail.v2.UserInfo.user_agent] can be populated
* from the HTTP request. This flag should be set only if the API request is
* made directly from the end user such as a mobile app (and not if a gateway
* or a server is processing and pushing the user events).
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent].
*
* Generated from protobuf field <code>bool direct_user_request = 4;</code>
*/
private $direct_user_request = false;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $user_id
* Highly recommended for logged-in users. Unique identifier for logged-in
* user, such as a user name.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* @type string $ip_address
* The end user's IP address. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* This field is used to extract location information for personalization.
* This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
* address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
* INVALID_ARGUMENT error is returned.
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
* @type string $user_agent
* User agent as included in the HTTP header. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* The field must be a UTF-8 encoded string with a length limit of 1,000
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* This should not be set when using the client side event reporting with
* GTM or JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
* @type bool $direct_user_request
* True if the request is made directly from the end user, in which case the
* [ip_address][google.cloud.retail.v2.UserInfo.ip_address] and
* [user_agent][google.cloud.retail.v2.UserInfo.user_agent] can be populated
* from the HTTP request. This flag should be set only if the API request is
* made directly from the end user such as a mobile app (and not if a gateway
* or a server is processing and pushing the user events).
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent].
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Retail\V2\Common::initOnce();
parent::__construct($data);
}
/**
* Highly recommended for logged-in users. Unique identifier for logged-in
* user, such as a user name.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>string user_id = 1;</code>
* @return string
*/
public function getUserId()
{
return $this->user_id;
}
/**
* Highly recommended for logged-in users. Unique identifier for logged-in
* user, such as a user name.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>string user_id = 1;</code>
* @param string $var
* @return $this
*/
public function setUserId($var)
{
GPBUtil::checkString($var, True);
$this->user_id = $var;
return $this;
}
/**
* The end user's IP address. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* This field is used to extract location information for personalization.
* This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
* address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
* INVALID_ARGUMENT error is returned.
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string ip_address = 2;</code>
* @return string
*/
public function getIpAddress()
{
return $this->ip_address;
}
/**
* The end user's IP address. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* This field is used to extract location information for personalization.
* This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
* address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
* INVALID_ARGUMENT error is returned.
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string ip_address = 2;</code>
* @param string $var
* @return $this
*/
public function setIpAddress($var)
{
GPBUtil::checkString($var, True);
$this->ip_address = $var;
return $this;
}
/**
* User agent as included in the HTTP header. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* The field must be a UTF-8 encoded string with a length limit of 1,000
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* This should not be set when using the client side event reporting with
* GTM or JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string user_agent = 3;</code>
* @return string
*/
public function getUserAgent()
{
return $this->user_agent;
}
/**
* User agent as included in the HTTP header. Required for getting
* [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
* The field must be a UTF-8 encoded string with a length limit of 1,000
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* This should not be set when using the client side event reporting with
* GTM or JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent]
* or if
* [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request]
* is set.
*
* Generated from protobuf field <code>string user_agent = 3;</code>
* @param string $var
* @return $this
*/
public function setUserAgent($var)
{
GPBUtil::checkString($var, True);
$this->user_agent = $var;
return $this;
}
/**
* True if the request is made directly from the end user, in which case the
* [ip_address][google.cloud.retail.v2.UserInfo.ip_address] and
* [user_agent][google.cloud.retail.v2.UserInfo.user_agent] can be populated
* from the HTTP request. This flag should be set only if the API request is
* made directly from the end user such as a mobile app (and not if a gateway
* or a server is processing and pushing the user events).
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent].
*
* Generated from protobuf field <code>bool direct_user_request = 4;</code>
* @return bool
*/
public function getDirectUserRequest()
{
return $this->direct_user_request;
}
/**
* True if the request is made directly from the end user, in which case the
* [ip_address][google.cloud.retail.v2.UserInfo.ip_address] and
* [user_agent][google.cloud.retail.v2.UserInfo.user_agent] can be populated
* from the HTTP request. This flag should be set only if the API request is
* made directly from the end user such as a mobile app (and not if a gateway
* or a server is processing and pushing the user events).
* This should not be set when using the JavaScript tag in
* [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent].
*
* Generated from protobuf field <code>bool direct_user_request = 4;</code>
* @param bool $var
* @return $this
*/
public function setDirectUserRequest($var)
{
GPBUtil::checkBool($var);
$this->direct_user_request = $var;
return $this;
}
}