Endpoint Get labels
Name
get_labels
Description
Get labels for a specific user [API reference]
Related Tables
Parameters
| Parameter | Required | Options | ||||||
|---|---|---|---|---|---|---|---|---|
|
Name:
Label: ApiVersion The version of the API to use. |
||||||||
|
Name:
Label: UserId Enter the Gmail user ID. |
|
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Name |
DT_WSTR
|
nvarchar(500)
|
500 | |
| MessageListVisibility |
DT_WSTR
|
nvarchar(50)
|
50 | |
| LabelListVisibility |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Type |
DT_WSTR
|
nvarchar(100)
|
100 | |
| MessagesTotal |
DT_I4
|
int
|
||
| MessagesUnread |
DT_I4
|
int
|
||
| ThreadsTotal |
DT_I4
|
int
|
||
| ThreadsUnread |
DT_I4
|
int
|
||
| TextColor |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| BackgroundColor |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Gmail Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Labels table, therefore it is better to use it, instead of accessing the endpoint directly:
| There are no parameters to configure. |
API Destination
This Endpoint belongs to the Labels table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get labels:
| There are no parameters to configure. |
ODBC application
Use these SQL queries in your ODBC application data source:
Get Labels
SELECT * FROM Labels
get_labels endpoint belongs to
Labels
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get Labels
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Labels';
EXEC (@MyQuery) AT [LS_TO_GMAIL_IN_GATEWAY];
get_labels endpoint belongs to
Labels
table(s), and can therefore be used via those table(s).