tags
Protocol buffer definition for tags
sift/tags/v2/tags.proto
CreateTagRequest
The request for a call to TagService.CreateTag.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The name for the new tag. If the tag already exists, an error is returned. |
CreateTagResponse
The result of a call to TagService.CreateTag.
| Field | Type | Label | Description |
|---|---|---|---|
| tag | Tag |
ListTagsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 50 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListTags call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTags must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string Available fields to filter by are 'name' and 'tag_id'. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved campaigns. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and name. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,name" |
ListTagsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| tags | Tag | repeated | |
| next_page_token | string | A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages. |
Tag
| Field | Type | Label | Description |
|---|---|---|---|
| tag_id | string | ||
| name | string | ||
| created_by_user_id | string | ||
| created_date | google.protobuf.Timestamp |
TagService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreateTag | CreateTagRequest | CreateTagResponse | Create a tag. |
| ListTags | ListTagsRequest | ListTagsResponse | Retrieves tags using an optional filter. |