aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/UpkProperty.md
blob: 8ab4b6ee77c3067272c969e49cef181939ffb8fb (plain)
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
# UpkProperty

This used to be called \"QuestionInfo\", which is a bad name,     as this describes a UPK Property, like \"educational_attainment\",     not the question that asks for your education.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**property_id** | **string** |  | [default to undefined]
**property_label** | **string** |  | [default to undefined]
**prop_type** | [**PropertyType**](PropertyType.md) |  Allowed values:   - __i__ *(UPK_ITEM)*: UserProfileKnowledge Item  - __n__ *(UPK_NUMERICAL)*: UserProfileKnowledge Numerical  - __x__ *(UPK_TEXT)*: UserProfileKnowledge Text | [optional] [default to undefined]
**cardinality** | [**Cardinality**](Cardinality.md) |  Allowed values:   - __*__ *(ZERO_OR_MORE)*: Zero or More  - __?__ *(ZERO_OR_ONE)*: Zero or One | [optional] [default to undefined]
**country_iso** | **string** |  | [default to undefined]
**gold_standard** | **boolean** | A Gold-Standard question has been enumerated for all possible values (per country) as best as possible by GRL,allowing it to be mapped across inventory sources. A property not marked as Gold-Standard may have: 1) marketplace qid associations & 2) category associations, but doesn\'t have a defined \'range\' (list of allowed itemsin a multiple choice question). This is used for exposing a user\'s profiling data & forthe Nudge API. | [optional] [default to false]
**allowed_items** | [**Array<UpkItem>**](UpkItem.md) |  | [optional] [default to undefined]
**categories** | [**Array<Category>**](Category.md) |  | [optional] [default to undefined]

## Example

```typescript
import { UpkProperty } from './api';

const instance: UpkProperty = {
    property_id,
    property_label,
    prop_type,
    cardinality,
    country_iso,
    gold_standard,
    allowed_items,
    categories,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)