Reference documentation and code samples for the Google Cloud Retail V2 Client class UserEvent.
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
Generated from protobuf message google.cloud.retail.v2.UserEvent
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ event_type |
string
Required. User event type. Allowed values are: * |
↳ visitor_id |
string
Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field. |
↳ session_id |
string
A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the sesion_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix. |
↳ event_time |
Google\Protobuf\Timestamp
Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. |
↳ experiment_ids |
array
A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). |
↳ attribution_token |
string
Highly recommended for user events that are the result of PredictionService.Predict. This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events that are the result of SearchService.Search. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field. |
↳ product_details |
array<Google\Cloud\Retail\V2\ProductDetail>
The main product details related to the event. This field is optional except for the following event types: * |
↳ completion_detail |
Google\Cloud\Retail\V2\CompletionDetail
The main auto-completion details related to the event. This field should be set for |
↳ attributes |
array|Google\Protobuf\Internal\MapField
Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. |
↳ cart_id |
string
The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase. This can only be set for |
↳ purchase_transaction |
Google\Cloud\Retail\V2\PurchaseTransaction
A transaction represents the entire purchase transaction. Required for |
↳ search_query |
string
The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for |
↳ filter |
string
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
↳ order_by |
string
The order in which products are returned. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for |
↳ offset |
int
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for |
↳ page_categories |
array
The categories associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"]. Required for |
↳ user_info |
Google\Cloud\Retail\V2\UserInfo
User information. |
↳ uri |
string
Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters. |
↳ referrer_uri |
string
The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. |
↳ page_view_id |
string
A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The |
getEventType
Required. User event type. Allowed values are:
add-to-cart
: Products being added to cart.category-page-view
: Special pages such as sale or promotion pages viewed.detail-page-view
: Products detail page viewed.home-page-view
: Homepage viewed.promotion-offered
: Promotion is offered to a user.promotion-not-offered
: Promotion is not offered to a user.purchase-complete
: User finishing a purchase.search
: Product search.shopping-cart-page-view
: User viewing a shopping cart.
Generated from protobuf field string event_type = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setEventType
Required. User event type. Allowed values are:
add-to-cart
: Products being added to cart.category-page-view
: Special pages such as sale or promotion pages viewed.detail-page-view
: Products detail page viewed.home-page-view
: Homepage viewed.promotion-offered
: Promotion is offered to a user.promotion-not-offered
: Promotion is not offered to a user.purchase-complete
: User finishing a purchase.search
: Product search.shopping-cart-page-view
: User viewing a shopping cart.
Generated from protobuf field string event_type = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getVisitorId
Required. A unique identifier for tracking visitors.
For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.
Generated from protobuf field string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setVisitorId
Required. A unique identifier for tracking visitors.
For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.
Generated from protobuf field string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSessionId
A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.
A general guideline to populate the sesion_id:
- If user has no activity for 30 min, a new session_id should be assigned.
- The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.
Generated from protobuf field string session_id = 21;
Returns | |
---|---|
Type | Description |
string |
setSessionId
A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.
A general guideline to populate the sesion_id:
- If user has no activity for 30 min, a new session_id should be assigned.
- The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.
Generated from protobuf field string session_id = 21;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getEventTime
Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
Generated from protobuf field .google.protobuf.Timestamp event_time = 3;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasEventTime
clearEventTime
setEventTime
Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
Generated from protobuf field .google.protobuf.Timestamp event_time = 3;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getExperimentIds
A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).
Generated from protobuf field repeated string experiment_ids = 4;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setExperimentIds
A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).
Generated from protobuf field repeated string experiment_ids = 4;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getAttributionToken
Highly recommended for user events that are the result of PredictionService.Predict.
This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events that are the result of SearchService.Search. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.
Generated from protobuf field string attribution_token = 5;
Returns | |
---|---|
Type | Description |
string |
setAttributionToken
Highly recommended for user events that are the result of PredictionService.Predict.
This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events that are the result of SearchService.Search. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.
Generated from protobuf field string attribution_token = 5;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getProductDetails
The main product details related to the event.
This field is optional except for the following event types:
add-to-cart
detail-page-view
purchase-complete
In asearch
event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a newsearch
event with different product_details is desired. The end user may have not finished browsing the whole page yet.
Generated from protobuf field repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setProductDetails
The main product details related to the event.
This field is optional except for the following event types:
add-to-cart
detail-page-view
purchase-complete
In asearch
event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a newsearch
event with different product_details is desired. The end user may have not finished browsing the whole page yet.
Generated from protobuf field repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\ProductDetail>
|
Returns | |
---|---|
Type | Description |
$this |
getCompletionDetail
The main auto-completion details related to the event.
This field should be set for search
event when autocomplete function is
enabled and the user clicks a suggestion for search.
Generated from protobuf field .google.cloud.retail.v2.CompletionDetail completion_detail = 22;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\CompletionDetail|null |
hasCompletionDetail
clearCompletionDetail
setCompletionDetail
The main auto-completion details related to the event.
This field should be set for search
event when autocomplete function is
enabled and the user clicks a suggestion for search.
Generated from protobuf field .google.cloud.retail.v2.CompletionDetail completion_detail = 22;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\CompletionDetail
|
Returns | |
---|---|
Type | Description |
$this |
getAttributes
Extra user event features to include in the recommendation model.
If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
- The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
- For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
- For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
Generated from protobuf field map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setAttributes
Extra user event features to include in the recommendation model.
If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
- The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
- For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
- For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
Generated from protobuf field map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getCartId
The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase.
This can only be set for add-to-cart
, purchase-complete
, or
shopping-cart-page-view
events.
Generated from protobuf field string cart_id = 8;
Returns | |
---|---|
Type | Description |
string |
setCartId
The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase.
This can only be set for add-to-cart
, purchase-complete
, or
shopping-cart-page-view
events.
Generated from protobuf field string cart_id = 8;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPurchaseTransaction
A transaction represents the entire purchase transaction.
Required for purchase-complete
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.cloud.retail.v2.PurchaseTransaction purchase_transaction = 9;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\PurchaseTransaction|null |
hasPurchaseTransaction
clearPurchaseTransaction
setPurchaseTransaction
A transaction represents the entire purchase transaction.
Required for purchase-complete
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.cloud.retail.v2.PurchaseTransaction purchase_transaction = 9;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\PurchaseTransaction
|
Returns | |
---|---|
Type | Description |
$this |
getSearchQuery
The user's search query.
See SearchRequest.query for
definition.
The value must be a UTF-8 encoded string with a length limit of 5,000
characters. Otherwise, an INVALID_ARGUMENT error is returned.
At least one of
search_query or
page_categories is
required for search
events. Other event types should not set this field.
Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string search_query = 10;
Returns | |
---|---|
Type | Description |
string |
setSearchQuery
The user's search query.
See SearchRequest.query for
definition.
The value must be a UTF-8 encoded string with a length limit of 5,000
characters. Otherwise, an INVALID_ARGUMENT error is returned.
At least one of
search_query or
page_categories is
required for search
events. Other event types should not set this field.
Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string search_query = 10;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string filter = 16;
Returns | |
---|---|
Type | Description |
string |
setFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string filter = 16;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
The order in which products are returned.
See SearchRequest.order_by
for definition and syntax.
The value must be a UTF-8 encoded string with a length limit of 1,000
characters. Otherwise, an INVALID_ARGUMENT error is returned.
This can only be set for search
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string order_by = 17;
Returns | |
---|---|
Type | Description |
string |
setOrderBy
The order in which products are returned.
See SearchRequest.order_by
for definition and syntax.
The value must be a UTF-8 encoded string with a length limit of 1,000
characters. Otherwise, an INVALID_ARGUMENT error is returned.
This can only be set for search
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string order_by = 17;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOffset
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
See SearchRequest.offset for
definition.
If this field is negative, an INVALID_ARGUMENT is returned.
This can only be set for search
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field int32 offset = 18;
Returns | |
---|---|
Type | Description |
int |
setOffset
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
See SearchRequest.offset for
definition.
If this field is negative, an INVALID_ARGUMENT is returned.
This can only be set for search
events. Other event types should not set
this field. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field int32 offset = 18;
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageCategories
The categories associated with a category page.
To represent full path of category, use '>' sign to separate different
hierarchies. If '>' is part of the category name, please replace it with
other character(s).
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
"pageCategories" : ["Sales > 2017 Black Friday Deals"].
Required for category-page-view
events. At least one of
search_query or
page_categories is
required for search
events. Other event types should not set this field.
Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field repeated string page_categories = 11;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPageCategories
The categories associated with a category page.
To represent full path of category, use '>' sign to separate different
hierarchies. If '>' is part of the category name, please replace it with
other character(s).
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
"pageCategories" : ["Sales > 2017 Black Friday Deals"].
Required for category-page-view
events. At least one of
search_query or
page_categories is
required for search
events. Other event types should not set this field.
Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field repeated string page_categories = 11;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getUserInfo
User information.
Generated from protobuf field .google.cloud.retail.v2.UserInfo user_info = 12;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\UserInfo|null |
hasUserInfo
clearUserInfo
setUserInfo
User information.
Generated from protobuf field .google.cloud.retail.v2.UserInfo user_info = 12;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\UserInfo
|
Returns | |
---|---|
Type | Description |
$this |
getUri
Complete URL (window.location.href) of the user's current page.
When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
Generated from protobuf field string uri = 13;
Returns | |
---|---|
Type | Description |
string |
setUri
Complete URL (window.location.href) of the user's current page.
When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
Generated from protobuf field string uri = 13;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReferrerUri
The referrer URL of the current page.
When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
Generated from protobuf field string referrer_uri = 14;
Returns | |
---|---|
Type | Description |
string |
setReferrerUri
The referrer URL of the current page.
When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
Generated from protobuf field string referrer_uri = 14;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageViewId
A unique ID of a web page view.
This should be kept the same for all user events triggered from the same
pageview. For example, an item detail page view could trigger multiple
events as the user is browsing the page. The pageViewId
property should
be kept the same for all these events so that they can be grouped together
properly.
When using the client side event reporting with JavaScript pixel and Google
Tag Manager, this value is filled in automatically.
Generated from protobuf field string page_view_id = 15;
Returns | |
---|---|
Type | Description |
string |
setPageViewId
A unique ID of a web page view.
This should be kept the same for all user events triggered from the same
pageview. For example, an item detail page view could trigger multiple
events as the user is browsing the page. The pageViewId
property should
be kept the same for all these events so that they can be grouped together
properly.
When using the client side event reporting with JavaScript pixel and Google
Tag Manager, this value is filled in automatically.
Generated from protobuf field string page_view_id = 15;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |