collection.md

Collection

Fields

Field	Type	Required	Description	Example
name	str	✔️	The unique name of the Collection.
description	str	✔️	A brief summary of the Collection's contents.
added_roles	List[models.UserRoleSpecification]	➖	A list of added user roles for the Collection.
removed_roles	List[models.UserRoleSpecification]	➖	A list of removed user roles for the Collection.
audience_filters	List[models.FacetFilter]	➖	Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
icon	Optional[str]	➖	The emoji icon of this Collection.
admin_locked	Optional[bool]	➖	Indicates whether edits are allowed for everyone or only admins.
parent_id	Optional[int]	➖	The parent of this Collection, or 0 if it's a top-level Collection.
thumbnail	Optional[models.Thumbnail]	➖	N/A
allowed_datasource	Optional[str]	➖	The datasource type this Collection can hold.
permissions	Optional[models.ObjectPermissions]	➖	N/A
tracking_token	Optional[str]	➖	An opaque token that represents this particular UGC. To be used for /feedback reporting.
id	int	✔️	The unique ID of the Collection.
create_time	date	➖	N/A
update_time	date	➖	N/A
creator	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
updated_by	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
item_count	Optional[int]	➖	The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
child_count	Optional[int]	➖	The number of children Collections. Separated from the actual children so we can grab the count without children.
items	List[models.CollectionItem]	➖	The items in this Collection.
pin_metadata	Optional[models.CollectionPinnedMetadata]	➖	N/A
shortcuts	List[str]	➖	The names of the shortcuts (Go Links) that point to this Collection.
children	List[models.Collection]	➖	The children Collections of this Collection.
roles	List[models.UserRoleSpecification]	➖	A list of user roles for the Collection.
favorite_info	Optional[models.FavoriteInfo]	➖	N/A