2026-02-18
▼ ▲ datamanager.accountTypes.accounts.insights.retrieve
Scopes : https://www.googleapis.com/auth/datamanager
Path : v1/{+parent}/insights:retrieve
Description : Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/insights:retrieve
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Required : Yes
Location : path
Type : string
Description : Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}`
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
▼ ▲ datamanager.accountTypes.accounts.partnerLinks.create
Parameter Order : parent
Description : Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Path : v1/{+parent}/partnerLinks
HTTP Method : POST
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
parent
Description : Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}
Location : path
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Type : string
Required : Yes
▼ ▲ datamanager.accountTypes.accounts.partnerLinks.search
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks:search
Parameter Order : parent
Parameters :
parent
Type : string
Required : Yes
Location : path
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Description : Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}`
pageSize
Format : int32
Description : The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type : integer
Location : query
filter
Type : string
Location : query
Description : Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321`
pageToken
Type : string
Description : A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token.
Location : query
Description : Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Scopes : https://www.googleapis.com/auth/datamanager
HTTP Method : GET
Path : v1/{+parent}/partnerLinks:search
▼ ▲ datamanager.accountTypes.accounts.partnerLinks.delete
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
name
Description : Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
Type : string
Location : path
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/partnerLinks/[^/]+$
Required : Yes
Description : Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks/{partnerLinksId}
▼ ▲ datamanager.accountTypes.accounts.userLists.list
HTTP Method : GET
Description : Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Path : v1/{+parent}/userLists
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token.
filter
Type : string
Location : query
Description : Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`
parent
Required : Yes
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Description : Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}
Type : string
Location : path
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists
Parameter Order : parent
▼ ▲ datamanager.accountTypes.accounts.userLists.patch
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}
Parameter Order : name
HTTP Method : PATCH
Description : Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
validateOnly
Location : query
Type : boolean
Description : Optional. If true, the request is validated but not executed.
name
Required : Yes
Description : Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$
Location : path
updateMask
Description : Optional. The list of fields to update.
Type : string
Location : query
Format : google-fieldmask
Path : v1/{+name}
▼ ▲ datamanager.accountTypes.accounts.userLists.delete
Path : v1/{+name}
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
name
Location : path
Type : string
Description : Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
Required : Yes
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$
validateOnly
Description : Optional. If true, the request is validated but not executed.
Type : boolean
Location : query
Parameter Order : name
Description : Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
▼ ▲ datamanager.accountTypes.accounts.userLists.create
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists
Parameters :
validateOnly
Type : boolean
Description : Optional. If true, the request is validated but not executed.
Location : query
parent
Required : Yes
Type : string
Description : Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Location : path
Description : Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Scopes : https://www.googleapis.com/auth/datamanager
Parameter Order : parent
Path : v1/{+parent}/userLists
HTTP Method : POST
▼ ▲ datamanager.accountTypes.accounts.userLists.get
Description : Gets a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/datamanager
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$
Required : Yes
Description : Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
Type : string
HTTP Method : GET
▼ ▲ datamanager.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list
Description : Lists all customer info for a user list global license. This feature is only available to data partners.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/datamanager
Parameter Order : parent
Path : v1/{+parent}/userListGlobalLicenseCustomerInfos
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}/userListGlobalLicenseCustomerInfos
Parameters :
pageSize
Location : query
Description : Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type : integer
Format : int32
pageToken
Location : query
Description : Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
Type : string
parent
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$
Location : path
Description : Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`)
Required : Yes
filter
Type : string
Description : Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
Location : query
▼ ▲ datamanager.accountTypes.accounts.userListGlobalLicenses.create
Parameters :
parent
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Required : Yes
Description : Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
Location : path
Description : Creates a user list global license. This feature is only available to data partners.
Parameter Order : parent
Path : v1/{+parent}/userListGlobalLicenses
Scopes : https://www.googleapis.com/auth/datamanager
HTTP Method : POST
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses
▼ ▲ datamanager.accountTypes.accounts.userListGlobalLicenses.patch
HTTP Method : PATCH
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/datamanager
Parameters :
name
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$
Type : string
Required : Yes
Description : Identifier. The resource name of the user list global license.
Location : path
updateMask
Location : query
Type : string
Description : Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
Format : google-fieldmask
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}
Parameter Order : name
Description : Updates a user list global license. This feature is only available to data partners.
▼ ▲ datamanager.accountTypes.accounts.userListGlobalLicenses.list
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses
Parameter Order : parent
Description : Lists all user list global licenses owned by the parent account. This feature is only available to data partners.
Scopes : https://www.googleapis.com/auth/datamanager
Path : v1/{+parent}/userListGlobalLicenses
HTTP Method : GET
Parameters :
parent
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Description : Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
Required : Yes
Location : path
pageToken
Location : query
Description : Optional. A page token, received from a previous `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
Type : string
filter
Description : Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
Location : query
Type : string
pageSize
Description : Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Type : integer
Location : query
▼ ▲ datamanager.accountTypes.accounts.userListGlobalLicenses.get
Parameter Order : name
Path : v1/{+name}
Description : Retrieves a user list global license. This feature is only available to data partners.
Scopes : https://www.googleapis.com/auth/datamanager
HTTP Method : GET
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}
Parameters :
name
Required : Yes
Description : Required. The resource name of the user list global license.
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$
Location : path
▼ ▲ datamanager.accountTypes.accounts.userListDirectLicenses.create
Scopes : https://www.googleapis.com/auth/datamanager
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Location : path
Required : Yes
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Description : Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
Path : v1/{+parent}/userListDirectLicenses
Description : Creates a user list direct license. This feature is only available to data partners.
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses
▼ ▲ datamanager.accountTypes.accounts.userListDirectLicenses.get
Parameter Order : name
Path : v1/{+name}
HTTP Method : GET
Description : Retrieves a user list direct license. This feature is only available to data partners.
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}
Parameters :
name
Type : string
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$
Description : Required. The resource name of the user list direct license.
Location : path
Required : Yes
▼ ▲ datamanager.accountTypes.accounts.userListDirectLicenses.list
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses
Path : v1/{+parent}/userListDirectLicenses
HTTP Method : GET
Parameter Order : parent
Parameters :
filter
Location : query
Type : string
Description : Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
Location : query
parent
Location : path
Pattern : ^accountTypes/[^/]+/accounts/[^/]+$
Type : string
Required : Yes
Description : Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Scopes : https://www.googleapis.com/auth/datamanager
Description : Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.
▼ ▲ datamanager.accountTypes.accounts.userListDirectLicenses.patch
Parameters :
updateMask
Location : query
Description : Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
Type : string
Format : google-fieldmask
name
Required : Yes
Pattern : ^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$
Description : Identifier. The resource name of the user list direct license.
Location : path
Type : string
Flat Path : v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}
Description : Updates a user list direct license. This feature is only available to data partners.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/datamanager
Path : v1/{+name}
Parameter Order : name